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

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

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

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

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

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

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

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

/ webhook

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

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

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

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

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

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

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

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

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

• استعمل أوث للمصادقة ORCID iDs (لا تسمح للمستخدمين بالبحث عن ملفات ORCID معرفات.)
• تشمل ORCID زر أو رابط ذو علامة تجارية على موقعك لبدء المصادقة على iD.
• قم بتقديم شاشة تفويض OAuth وفقًا لـ المبادئ التوجيهية
• استخدم HTTPS لعناوين URL لإعادة توجيه موقعك وعلى ORCID مكالمات API
• قبول وتخزين جميع البيانات التي يتم إرجاعها في تبادل الرمز المميز مع بيانات المستخدم في نظامك
• استخدام المناسب نطاقات و طرق الطلب (على سبيل المثال ، مكالمات POST لإضافة معلومات جديدة ومكالمات PUT لتحديث المعلومات الحالية)
• عرض المصدق عليه علنًا ORCID معرفات. يجب أن يتم عرض معرفات iDs بعد العلامة التجارية و iD عرض المبادئ التوجيهية.

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

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

الاتصال عنوان البريد الإلكتروني: سنرسل أوراق الاعتماد إلى هذا العنوان. يجب أن تكون هذه هي جهة الاتصال التي كنا نعمل معها بشأن التكامل أو جهة الاتصال الفنية التي نحتفظ بها لمؤسستك.

اتصل لتلقي PIN للوصول إلى بيانات الاعتماد: نرسل لك أوراق الاعتماد الكاملة بطريقة آمنة. سنرسل رمز مرور للوصول إلى بيانات اعتماد API الخاصة بك إلى جهة الاتصال هذه. يجب أن يكون هذا جهة اتصال مختلفة عن جهة الاتصال السابقة المدرجة.

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

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

يقوم OAuth2 بإعادة توجيه URIs أو عناوين URL لمعاودة الاتصال للعميل: عناوين URL المسموح بها في تطبيق الويب الخاص بك والتي سيتم إعادة المستخدمين إليها بعد أن يأذنوا بالوصول إلى ملفات ORCID تاريخ التسجيل. يجب أن تكون جميع عناوين URL لإعادة التوجيه HTTPS لعملاء خادم الإنتاج (المباشر). 

بمجرد تقديم طلبك ، تحدث عملية يدوية لإصدار بيانات اعتمادك وستتلقى رسالة بريد إلكتروني من عميلك iD وسر العميل. عادةً ما تتم معالجة هذه الطلبات في أقل من 48 ساعة.

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

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

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