البرنامج التعليمي لواجهة برمجة التطبيقات: احصل على ملف ORCID iD

نوصي المطورين باختبار 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 عضو فى المستقبل.

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

ملاحظات: إذا كنت تستخدم ORCID نظام مزود الخدمة المعتمد الذي يدعم بالفعل ORCID، فأنت لا تحتاج إلى التسجيل للحصول على بيانات اعتماد Sandbox API إلا إذا كنت ترغب في تجربة ORCID وظيفة التكامل داخل بيئة Sandbox. 

يتيح لك وضع الحماية إنشاء حسابات مستخدمين تجريبية وتطوير تكاملك دون الحاجة إلى القلق بشأن التأثير على البيانات في البث المباشر (الإنتاج) ORCID التسجيل. يتصرف الصندوق الرمل بنفس طريقة الإنتاج ORCID التسجيل مع بعض الاستثناءات.

إنشاء حساب اختباري

من أجل اختبار ORCID استدعاءات API و API ، مثل قراءة وإضافة معلومات إلى ملف ORCID سجل ، سوف تحتاج أيضًا إلى إنشاء اختبار ORCID سجل في الصندوق الرمل. يمكن القيام بذلك من خلال واجهة المستخدم ، كما هو الحال في الإنتاج ORCID التسجيل. اذهب إلى https://sandbox.orcid.org/register وقم بالتسجيل للحصول على حساب.

عناوين البريد الإلكتروني Mailinator

يرسل خادم Sandbox رسائل البريد الإلكتروني فقط إلى Mailinator (@ mailinator.com) عناوين البريد الإلكتروني من أجل عدم إرسال بريد عشوائي على خوادم عن غير قصد. لن تتلقى رسالة بريد إلكتروني للتحقق أو إشعار إعادة تعيين كلمة المرور ما لم تستخدم عنوان @ mailinator.com ، والتحقق مطلوب لإجراء أي تعديلات يدوية على سجلات آلية تحديد الوصول. تعرف على المزيد حول استخدام صناديق البريد الوارد العامة مجانًا هنا. إذا كنت لا ترغب في استخدام ملف Mailinator العنوان ، ثم يرجى تدوين اسم المستخدم وكلمة المرور (حيث ستستخدمهما لمنح الإذن لتطبيقك عند الاختبار) ، والاتصال بنا لطلب المساعدة في التحقق.

Mailinator هي خدمة بريد إلكتروني بها خدمة عامة مجانية وخدمة خاصة مدفوعة. للاختبار ، يمكنك استخدام الخدمة العامة المجانية تمامًا. اكتشف المزيد عن طبقاتهم هنا.

Mailinator هي خدمة تابعة لجهة خارجية لا تتم إدارتها أو صيانتها بواسطة ORCID. نوصي بمراجعة كيفية عمل هذه الخدمة وقيودها قبل استخدام هذه العناوين.

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

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

كيف نطابق عناوين URI لإعادة التوجيه؟

• يجب عليك تسجيل النطاقات الفرعية كمعرفات URI منفصلة. https://anythingelse.thirdparty.com لن يعمل.  
• يُنصح بتسجيل جميع URIs لإعادة التوجيه بالكامل ، بما في ذلك المسار، هو ما تفعله معظم الأطراف الثالثة وهو الخيار الأكثر أمانًا.
• إذا تم تسجيل تطبيق العميل باستخدام عنوان Uri لإعادة التوجيه وهو اسم المضيف فقط ، فيمكن عندئذٍ استخدام أي uri لإعادة التوجيه في ذلك المضيف. لذلك ، على سبيل المثال ، إذا تم تسجيل عنوان URL لإعادة التوجيه التالي: https://thirdparty.com ثم ستعمل كل عمليات redirect_uris التالية:
  • https://thirdparty.com/oauth/callback1
  • https://thirdparty.com/callback2
  • https://thirdparty.com/anything-else-as-long-as-the-host-is-the-same

ومع ذلك ، https://anythingelse.thirdparty.com لن يعمل.  يمكنك يجب تسجيل النطاقات الفرعية كمعرفات URI منفصلة.

ماذا يحدث إذا كان عنوان URI لإعادة التوجيه غير صحيح؟

أرسل المستخدمون للمصادقة في ORCID مع عناوين URI لإعادة التوجيه غير الصحيحة ، ستظهر لك رسالة خطأ مشابهة لما يلي:

إدارة إعادة توجيه عناوين URL للأعضاء

إذا كنت تستخدم عضو واجهة برمجة التطبيقات (API) وتحتاج إلى أي تغييرات على عناوين URL لإعادة التوجيه الخاصة بك ، فيرجى الاتصال بفريق المشاركة لدينا

إدارة إعادة توجيه URIs للعملاء العموميين

إذا كنت تستخدم واجهة برمجة التطبيقات العامة ، فستحتاج إلى اتباع الخطوات أدناه لتحديث قائمة عناوين URL لإعادة التوجيه المرتبطة بـ ORCID معرّف عميل API العام. يمكنك القيام بذلك باتباع الخطوات التالية:

• تسجيل الدخول إلى الخاص بك ORCID سجل
• انقر فوق اسمك في الزاوية اليمنى
• حدد أدوات المطور
• انقر فوق قلم التحرير بجوار اسم العميل
• قم بتحرير URI الحالي لإعادة التوجيه أو انقر فوق "Add another redirect URI" لتعديل واحد موجود
• بمجرد الانتهاء من إجراء التغييرات ، تحتاج إلى النقر فوق رمز الحفظ

فقط عناوين HTTPS URI يتم قبولها في الإنتاج. يمكنك الاختبار باستخدام http URIs ولكنك ستحتاج إلى تسجيل HTTPS URIs عند التقدم بطلب للحصول على بيانات اعتماد API لعضو الإنتاج.

ORCID تستخدم عمليات الدمج "بروتوكول OAuth الثلاثي" لمصادقة المستخدمين وطلب إذن للتفاعل مع سجلاتهم. يمكن أن يطلب أي تكامل أذونات القراءة باستخدام واجهة برمجة التطبيقات العامة. ORCID يمكن للأعضاء استخدام Member API لطلب أذونات التحديث. يعمل مثل هذا:

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

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

بناء رابط التفويض والحصول على رمز التفويض

يمكنك إنشاء رابط التفويض الخاص بك عن طريق تحديد معرف العميل الخاص ببيانات اعتماد واجهة برمجة التطبيقات الخاصة بك وصفحة الوصول المرتبطة (URI لإعادة التوجيه). يمكنك اختيار الأذونات التي تريد طلبها عن طريق ضبط معلمة النطاق.

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

https://sandbox.orcid.org/oauth/authorize?client_id=[Your client ID]&response_type=code&scope=/read-limited&redirect_uri=[Your landing page]

قام المستخدم بالنقر فوق الارتباط ، وقم بتسجيل الدخول في ORCID ومنحهم أذونات ، تمت إعادة توجيههم مرة أخرى إلى موقعك ، على النحو التالي:

https://[Your landing page]?code=Q70Y3A

استبدل رمز التفويض بملف ORCID iD ورمز الوصول

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

 URL=https://sandbox.orcid.org/oauth/token
  HEADER: Accept: application/json
  HEADER: Content-Type: application/x-www-form-urlencoded
  METHOD: POST
  DATA: 
    client_id=[Your client ID]
    client_secret=[Your client secret]
    grant_type=authorization_code
    code=Six-digit code
    redirect_uri=[Your landing page]

ORCID سيعيد الباحث بعد ذلك مصدقًا عليه ORCID iD ورمز وصول بتنسيق JSON:

{"access_token":"f5af9f51-07e6-4332-8f1a-c0c11c1e3728","token_type":"bearer",
"refresh_token":"f725f747-3a65-49f6-a231-3e8944ce464d","expires_in":631138518,
"scope":"/read-limited","name":"Sofia Garcia","orcid":"0000-0001-2345-6789"}

تدوم رموز الوصول لفترة طويلة افتراضيًا وتنتهي بعد 20 عامًا من الإصدار. يمكن استخدام الرمز المميز عدة مرات قبل انتهاء صلاحيته.

استخدم رمز الوصول

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

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

• تقوم بإنشاء ارتباط خاص
• عند النقر فوقها ، يتم إرسال المستخدم إلى ORCID
  • ORCID يطلب من المستخدم تسجيل i
  • ORCID يطلب من المستخدم منح الإذن لتطبيقك
  • ORCID يرسل المستخدم مرة أخرى إلى نظامك مع ORCID iD، رمز الوصول ورمز الهوية.
• يقوم نظامك باستخراج وتخزين ملفات ORCID iD من الرد.

لأسباب أمنية ، عند استخدام OAuth الضمني ، ORCID لن تعيد رموز الوصول مع أذونات التحديث.

التدفق الضمني

تم تصميم التدفق الضمني بحيث لا يحتاج العملاء إلى استخدام مفتاحهم السري للبدء ORCID تسجيل الدخول. يتم فرض الأمان من خلال تقييد العملاء على عناوين URL الخاصة بإعادة التوجيه المُسجلة. هذا المستوى المنخفض من الأمن يعني ذلك ORCID يدعم فقط / المصادقة و openid النطاقات عند استخدام التدفق الضمني. تعتبر الرموز أيضًا قصيرة العمر ، حيث يبلغ عمرها 10 دقائق. يوصى بهذا التدفق للتطبيقات من جانب العميل التي لا يمكنها الوصول إلى خادم خلفي ، على سبيل المثال تطبيقات الهاتف أو تطبيقات الويب جافا سكريبت ذات الصفحة الواحدة.

https://localhost/#access_token=24c11342-f5da-4cf9-94a4-f8a72a30da00&token_type=bearer&expires_in=599&tokenVersion=1&persistent=false&id_token=eyJraWQiOiJxYS1vcmNpZC1vcmctcjlhZmw3cWY2aG2c5bmdzenU1bnQ3Z3pmMGVhNmkiLCJhbGciOiJSUzI1NiJ9.eyJhdF9oYXNoIjoiMW52bXZBbVdwaVd0Z3ZKZW1DQmVYUSIsImF1ZCI6IkFQUC02TEtJSjNJNUIxQzRZSVFQIiwic3ViIjoiMDAwMC0wMDAyLTUwNjItMjIwOSIsImF1dGhfdGltZSI6MTUwNTk4Nzg2MiwiaXNzIjoiaHR0cHM6XC9cL29yY2lkLm9yZyIsIm5hbWUiOiJNciBDcmVkaXQgTmFtZSIsImV4cCI6MTUwNTk4ODQ2MywiZ2l2ZW5fbmFtZSI6IlRvbSIsImlhdCI6MTUwNTk4Nzg2Mywibm9uY2UiOiJ3aGF0ZXZlciIsImZhbWlseV9uYW1lIjoiRGVtIiwianRpIjoiY2U0YzlmNWUtNTBkNC00ZjhiLTliYzItMmViMTI0ZDVkNmNhIn0.hhhts2-4-ibjXPW6wEsFRaNqV_A-vTz2JFloYn7mS1jzQt3xuHiSaSIiXg3rpnt1RojF_yhcvE9Xe4SOtYimxxVycpjcm8yT_-7lUSrc46UCt9qW6gV7L7KQyKDjNl23wVwIifpRD2JSnx6WbuC0GhAxB5-2ynj6EbeEEcYjAy2tNwG-wcVlnfJLyddYDe8AI_RFhq7HrY4OByA91hiYvHzZ8VzoRW1s4CTCFurA7DoyQfCbeSxdfBuDQbjAzXuZB5-jD1k3WnjqVHrof1LHEPTFV4GQV-pDRmkUwspsPYxsJyKpKWSG_ONk57E_Ba--RqEcE1ZNNDUYHXAtiRnM3w

ترى لدينا وثيقة تقنية للمزيد من المعلومات.

OpenID Connect 1.0 عبارة عن طبقة هوية بسيطة أعلى بروتوكول OAuth 2.0. وهو يكمل تدفقات مصادقة OAuth الحالية ويوفر معلومات حول المستخدمين للعملاء بطريقة موصوفة جيدًا.

OpenID connect هي طريقة معيارية لتنفيذ OAuth ومشاركة المعلومات حول المستخدمين المصادق عليهم. سيكون من الممكن الآن تكوين الخدمات لاستخدامها ORCID "جاهز للاستخدام" إلى جانب موفري OpenID connect المتوافقين مع المعايير الآخرين. يوفر OpenID connect أيضًا رموز هوية قابلة للمشاركة، وهي عبارة عن كائنات موقعة يمكنها إثبات مصادقة المستخدم باستخدام ORCID في وقت محدد. يمكن استخدام هذه الرموز المميزة بواسطة عناصر واجهة المستخدم للحفاظ على جلسات المستخدم.

ORCID يدعم ملف توافق موفر OpenID الأساسي ، وهو امتداد لتدفق كود مصادقة OAuth. ORCID يدعم أيضًا تدفق الرمز الضمني للنطاقات "/ المصادقة" و "openid".

وهذا يعني أن ORCID:

• يقوم بتضمين رموز الهوية الموقعة داخل استجابات الرمز لرموز الترخيص التي تم إنشاؤها باستخدام نطاق "openid"
• يدعم التدفق الضمني عند استخدام أنواع استجابة "الرمز المميز" أو "الرمز المميز id_token" ونطاق "openid".
• يدعم معلمات "المطالبة" و "nonce" و "max_age" لطلبات التفويض التي تتضمن النطاق "openid".
• يدعم اكتشاف Openid Connect ونقاط نهاية معلومات المستخدم
• يدعم حقل "amr" للمتكاملين الذين يستخدمون واجهة برمجة تطبيقات العضو لطلبات التفويض التي تتضمن نطاق "openid". يمكن استخدام هذا لاكتشاف ما إذا كان المستخدم قد تمت مصادقته باستخدام المصادقة الثنائية.

يعمل بدء مصادقة OpenID Connect بنفس طريقة مصادقة OAuth العادية. كل ما هو مطلوب هو أن يطلب العميل النطاق "openid" إذا كنت تستخدم نطاق / المصادقة ، استبدله بـ openid ، نظرًا لأن المصادقة و openid لهما نفس التفويض يجب استخدام أحدهما فقط أو الآخر. إذا كنت تستخدم أي نطاقات أخرى ، فأضف openid إلى قائمة النطاقات المطلوبة. عند تضمين نطاق openid ، سيعيد السجل id_token داخل استجابة الرمز المميز ويمنح العميل إذنًا للوصول إلى نقطة نهاية معلومات المستخدم لهذا المستخدم.

لاحظ أن النطاق "openid" لا يبدأ بـ "/" مثل الآخر ORCID نطاقات API. هذا لأن النطاق "openid" لم يتم تحديده بواسطة ORCID، ولكن بدلاً من ذلك تم تحديده بواسطة مواصفات OpenID Connect.

ترى لدينا وثيقة تقنية للمزيد من المعلومات.

ORCID يوفر بسيط أداة Java Script التي يمكن استخدامها للحصول على المصادقة ORCID أجهزة iD تستخدم OAuth مع OpenID Connect.

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