الشروع في التكامل الخاص بك

اطلع على طلب بيانات اعتماد واجهة برمجة التطبيقات لعضو الحماية لبناء واختبار التطبيق الخاص بك. تسمح لك بيانات الاعتماد هذه بإجراء مكالمات إلى واجهة 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. نوصي بمراجعة كيفية عمل هذه الخدمة وقيودها قبل استخدام هذه العناوين.

عند طلب الإذن بالتفاعل مع ORCID سجل المستخدم ، يمكنك تحديد "نطاق" واحد أو أكثر. يتيح لك كل نطاق القيام بأشياء معينة ، مثل قراءة السجل أو تحديث قسم معين.

نطاقات ثلاثية (كود التفويض)

3 أرجل يشير إلى الجهات الفاعلة الثلاثة المشاركة في الحصول على إذن من المستخدم ؛ ORCIDونظامك والمستخدم نفسه.

/ المصادقة

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

/ read-limited (عضو API فقط)

يستخدم هذا النطاق للوصول لقراءة عناصر الرؤية العامة والمحدودة على ملف ORCID سجل. هذا النطاق متاح فقط على Member API.

/ activities / update (Member API only)

يُستخدم هذا النطاق لكتابة وتحديث وحذف العناصر الموجودة في أقسام الانتساب والتمويل والأعمال والأنشطة المهنية وموارد البحث وأقسام مراجعة النظراء الخاصة بالمنظمة. ORCID سجل. هذا النطاق متاح فقط على Member API.

/ شخص / تحديث (عضو API فقط)

يستخدم هذا النطاق لكتابة وتحديث وحذف العناصر في الأسماء الأخرى ، والكلمات الرئيسية ، والبلدان ، وعناوين url للباحثين ، ومواقع الويب ، وأقسام المعرفات الخارجية الشخصية للسجل. هذا النطاق متاح فقط على Member API.

رض

يتم استخدام هذا النطاق من قبل مكامل OpenID عندما يكون id_token مطلوبًا. عند تضمين نطاق openid ، سيعيد السجل id_token داخل استجابة الرمز المميز ويمنح العميل إذنًا للوصول إلى نقطة نهاية معلومات المستخدم لهذا المستخدم. هذا النطاق متاح على API العامة والأعضاء.

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

نطاقات متعددة

يمكن طلب نطاقات متعددة في تفاعل واحد عن طريق سرد النطاقات في عنوان URL للمصادقة بمسافة مشفرة بين كل منها ، مثل النطاق = / read-limited٪ 20 / activities / update٪ 20 / person / update

الوصول الكامل

إذا كنت تريد الوصول الكامل لقراءة السجل وتحريره ، فقم بتضمين ثلاثة نطاقات في عنوان URL للمصادقة: / read-limited و / activities / update و / person / update. ستظهر في عنوان URL على هيئة النطاق = / read-limited٪ 20 / activities / update٪ 20 / person / update

نطاقات ثنائية (بيانات اعتماد العميل)

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

/ read-public

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

/ webhook

يسمح هذا النطاق لتطبيق العميل بتسجيل webhook على ملف ORCID لتلقي إشعارات عندما يتم تحديث سجل. هذا النطاق متاح للقسط ORCID الأعضاء فقط.

تحتاج عمليات الدمج إلى تخزين أكثر من مجرد ORCID السجلات. سيحتاج نظامك إلى أن يكون قادرًا على:

• قبول وتخزين ORCID iDs: سيحتاج نظامك إلى معرفة ملف iD ل ORCID سجل لعرض iD والتحديث بشكل صحيح. قم بتخزينها مع معلومات الباحث التي يتم إرجاعها في استجابة تبادل الرمز المميز. توصيتنا هي تخزين https URI الكامل: https://orcid.org/0000-0001-5727-2427.
• قبول وتخزين مستمر رموز الوصول تحديث الرموز: يمكن استخدام رموز الوصول لقراءة السجلات وتحديثها ، بالإضافة إلى الإشارة إلى أن ملف iD تمت المصادقة عليه. رموز الوصول صالحة لمدة 20 عامًا تقريبًا أو حتى يقوم المستخدم بإبطالها. ننصحك أيضًا بتخزين نطاق الرمز, انتهاء صلاحية الرمز المميز تحديث الرموز. يمكن استخدام رموز التحديث لإنشاء رموز وصول جديدة بنفس النطاقات أو نطاقات محدودة إذا لزم الأمر. قم بتخزين بيانات رمز الوصول المميز مع معلومات الباحث.
• قبول وتخزين ضع الرموز : كل ​​عنصر تضيفه إلى ORCID سيتم إرجاع السجل مع رمز وضع بواسطة ORCID واجهة برمجة التطبيقات. احفظ رمز الوضع المكون من 6 أرقام مع العنصر الموجود في نظامك، فهذه هي الطريقة التي ستحدد بها العنصر الذي يحتاج إلى القراءة أو التحديث أو الحذف.
• قدِّم رسائل خطأ وجهة اتصال للدعم عندما لا يسير التفاعل كما هو متوقع.

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

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

1. أوصى: عرض حي: اتصل بنا لتحديد موعد مظاهرة حية. سنوفر لك برنامج اجتماعات يسمح لك بمشاركة شاشتك لتتمكن من عرض التكامل. 
2. موقع الاختبار: إذا كان موقع التطوير الخاص بك عامًا ، أرسل إلينا عنوان URL إلى جانب بيانات اعتماد الاختبار (إذا لزم الأمر) للوصول إلى نظامك وإرشادات تصف كيفية استخدام نظامك ORCID الميزات. قدم وثائق إضافية للتحقق مما لن نتمكن من رؤيته من طرف المستخدم ، على سبيل المثال إصدار واجهة برمجة التطبيقات المستخدمة ، وما هي البيانات المخزنة بواسطة نظامك ، وما إلى ذلك.
3. Screencast أو لقطات الشاشة:إرسال تسجيل أو مجموعة من لقطات الشاشة مع أوصاف تشرح وتوضح بوضوح كيفية عمل التكامل في كل خطوة، بما في ذلك ما يحدث إذا رفض المستخدم الوصول أو قطع اتصال معرّفه. تأكد من تقديم وثائق إضافية للتحقق من أي شيء لن نتمكن من رؤيته من جانب المستخدم، مثل إصدار واجهة برمجة التطبيقات (API) المستخدم وكيفية تخزين البيانات

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

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

هناك عدة طرق لمشاركة هذا الدليل:

1. تسجيل الشاشة أو لقطات الشاشة:أرسل تسجيلاً أو مجموعة من لقطات الشاشة مع أوصاف تشرح وتوضح بوضوح كيفية عمل التكامل في كل خطوة، بما في ذلك ما يحدث إذا رفض المستخدم الوصول أو فصل معرفه. تأكد من تقديم مستندات إضافية للتحقق من أي شيء لن نتمكن من رؤيته من جانب المستخدم، مثل إصدار واجهة برمجة التطبيقات المستخدم وكيفية تخزين البيانات.
2. وثائق التكامل المتاحة للعامة:أرسل رابطًا متاحًا للعامة ومحدثًا يتضمن وصفًا واضحًا لكيفية عمل التكامل في كل خطوة. كما هو الحال في الخيار 1، تأكد من تقديم مستندات إضافية للتحقق من أي شيء لن نتمكن من رؤيته من جانب المستخدم، مثل إصدار واجهة برمجة التطبيقات المستخدم وكيفية تخزين البيانات.

سوف تحتاج إلى ملء نموذج لتسجيل تطبيق العميل. فيما يلي نظرة عامة سريعة على الحقول المطلوبة:

اسم المنظمة: الخاص بك ORCID اسم المنظمة العضو

عنوان البريد الإلكتروني لجهة الاتصال الأساسية للحصول على بيانات الاعتماد: سوف نستخدم عنوان البريد الإلكتروني هذا لإرسال بيانات الاعتماد إليك في رسالة بريد إلكتروني مشفرة، وللاتصال بك في حالة ظهور أي أسئلة أو أخطاء أثناء عملية التكامل الخاصة بك

البريد الإلكتروني الثانوي لكلمة المرور: عنوان بريد إلكتروني يمكننا إرسال كلمة مرور بريدك الإلكتروني المشفرة إليه.

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

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

وصف موجز لتطبيق العميل الخاص بك: سيتم عرض هذا النص على شاشة التفويض مع رمز علامة الاستفهام لمستخدمي التكامل الخاص بك. مطلوب وصف قصير للتكامل الخاص بك

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

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

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

لدعم المكون الاجتماعي نقدم مجموعة أدوات من موارد التوعية لمساعدتك في تطوير حملة لدعم اندماجك ، والتواصل مع الباحثين لديك:

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

سنعمل باستمرار على بناء هذه "المكتبة" من الموارد بناءً على التعليقات الواردة من المجتمع. إذا كانت لديك فكرة عن شيء ما قد ترغب في رؤيته ، فلا تتردد في الاتصال بنا.