تسجيل عميل API العام

نوصي المطورين باختبار Public API في ملف خادم اختبار وضع الحماية قبل استخدام نسخة الإنتاج. فيما يلي خطوات كيفية التسجيل للحصول على بيانات اعتماد API العامة في كل من بيئات Sandbox والإنتاج.

• تسجيل الدخول الى حسابك ORCID سجل:
  خادم الإنتاج: https://orcid.org/signin
  خادم اختبار Sandbox: https://sandbox.orcid.org/signin
• انقر فوق اسمك في الزاوية اليمنى العليا
• انقر ادوات المطورين من خيار القائمة
  ملحوظة: من أجل الوصول إلى أدوات المطور ، يجب عليك التحقق من عنوان بريدك الإلكتروني. إذا لم تكن قد قمت بالفعل بالتحقق من عنوان بريدك الإلكتروني ، فسيُطلب منك القيام بذلك قبل أن تتمكن من التسجيل للحصول على بيانات اعتماد API العامة
• اقرأ ووافق على "ORCID شروط خدمة واجهات برمجة التطبيقات العامة
• انقر فوق "التسجيل في ORCID "الزر "بيانات اعتماد واجهة برمجة التطبيقات العامة".

استكمال نموذج تفاصيل الطلب

• بمجرد التسجيل في بيانات اعتماد API العامة الخاصة بك ، سيتم توجيهك مرة أخرى إلى Developer Tools (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
• تحتاج إلى إكمال نموذج تفاصيل الطلب المقدم لتسجيل طلب جديد.
  • الاسم: اسم التطبيق الخاص بك. سيتم عرض هذا للمستخدمين عند منحهم إذن تطبيقك للحصول على ملفات ORCID معرف ، وسيتم عرضه في ملفات قائمة المنظمات الموثوقة. نوصي باستخدام اسم مؤسستك أو خدمتك (مثل اسم المجلة).
  • عنوان URL للتطبيق: موقع الويب الذي يمكن للمستخدم زيارته لمعرفة المزيد عن تطبيقك. سيتم عرض هذا أيضًا في ملفات قائمة المنظمات الموثوقة.
  • وصف التطبيق: معلومات حول التطبيق الذي تقوم بتطويره وكيف ستستخدم المستخدم ORCID هوية شخصية. سيتم عرض هذا للمستخدمين على شاشة OAuth.

إضافة إعادة توجيه URIs

بمجرد أن يصرح المستخدم للتطبيق الخاص بك ، سيتم إعادته إلى URI الذي تحدده. يجب عليك تقديم URIs مسبقًا وإلا سيواجه مستخدمو الدمج خطأ.

• أدخل عنوان URI لإعادة التوجيه في المربع المتوفر
• إذا كنت بحاجة إلى إدخال أكثر من عنوان URI لإعادة التوجيه ، فانقر فوق "إضافة عنوان URI آخر لإعادة التوجيه"

يرجى الملاحظة:

• فقط عناوين HTTPS URI يتم قبولها في الإنتاج
• المجالات المسجلة يجب تتطابق تمامًا مع المجالات المستخدمة ، بما في ذلك المجالات الفرعية
• قم بتسجيل جميع عناوين URL المعاد توجيهها بالكامل حيثما أمكن ذلك. هذا هو الخيار الأكثر أمانًا وما نوصي به. لمزيد من المعلومات حول إعادة توجيه URIs ، يرجى الاطلاع على إعادة توجيه الأسئلة الشائعة لـ URI

حفظ التطبيق الخاص بك

بمجرد إكمال نموذج الطلب وإضافة URIs الخاصة بإعادة التوجيه ، يمكنك حفظ طلبك.

• انقر فوق "حفظ طلبي وإنشاء معرف العميل والسر الخاص بي"

سيتم توجيهك مرة أخرى إلى صفحة أدوات المطور والتي ستتضمن الآن بيانات اعتماد عميل API العام

تحديث بيانات الاعتماد الخاصة بك

إجراء تغيير على معلومات التطبيق الخاص بك أمر بسيط للغاية.

• قم بتحرير المعلومات ذات الصلة ثم انقر فوق "حفظ التطبيق"

استخدم أوراق اعتمادك

الآن بعد أن حصلت على بيانات الاعتماد الخاصة بك ، حان الوقت لبدء استخدام ملف ORCID API العامة!

يرجى ملاحظة أنه يمكننا نقل بيانات الاعتماد الخاصة بك إلى عضو API إذا أصبحت ORCID عضو فى المستقبل.

ORCID يدعم حصص استخدام واجهة برمجة التطبيقات المختلفة وحدود المعدلات اعتمادًا على واجهة برمجة التطبيقات التي تستخدمها. 

يطلب ثانية هو عدد الطلبات التي يمكن تقديمها في الثانية. 

رشقات نارية هي عدد الطلبات التي سنسمح بوضعها في قائمة الانتظار قبل رفضها. يتم إبطاء الطلبات في قائمة الانتظار إلى معدل الطلبات في الثانية. إذا تجاوزت الحد الأقصى، فستتلقى استجابة 503. 

إذا تجاوزت حصة الاستخدام، فسيتم منعك من تقديم طلبات أخرى ضمن الإطار الزمني المحدد. 

يرجى تذكر أن ORCID واجهة برمجة التطبيقات العامة مجانية للاستخدام غير التجاري من قبل الأفراد كما هو مذكور في شروط خدمة واجهات برمجة التطبيقات العامةبـ "غير تجاري" نعني أنه لا يجوز لك تحصيل أي رسوم إعادة استخدام لواجهة برمجة التطبيقات العامة، ولا يجوز لك استخدام واجهة برمجة التطبيقات العامة فيما يتعلق بأي منتج أو خدمة تدر إيرادات. 

سيسمح استخدام واجهة برمجة التطبيقات العامة مع بيانات اعتماد العميل للتكامل الخاص بك بحصة استخدام أعلى من واجهة برمجة التطبيقات المجهولة. يرجى الاطلاع على دليل التكامل حول كيفية تسجيل عميل API العام. 

إذا كنت تتجاوز بانتظام حصة استخدام واجهة برمجة التطبيقات لواجهة برمجة التطبيقات العامة، فإننا نوصيك بالتفكير في أن تصبح ORCID عضو للوصول إلى موقعنا عضو APIلن يسمح لك فقط بالوصول إلى حد أعلى للسعر وحصة استخدام غير مقيدة، بل ستتمكن أيضًا من الوصول إلى بيانات الطرف الموثوق به في ORCID السجلات والمساهمة بالبيانات ORCID السجلات من أنظمتك المؤسسية بإذن من المستخدمين.