نحن نبذل قصارى جهدنا لتقديم رسائل خطأ وصفية في السجل و API. فيما يلي بعض النصائح لمساعدتك في حل أي أخطاء قد تواجهها.
أخطاء API
تتضمن أكواد خطأ API الخاصة بنا رسائل وصفية يجب أن تكون سهلة الفهم.
تتوفر قائمة برموز أخطاء API الشائعة ومعانيها المحتملة ونصائح حول كيفية استكشافها وإصلاحها في موقعنا وثيقة تقنية.
إذا لم تتمكن من حل المشكلة التي تواجهها ، فالرجاء إخبارنا بذلك.
0
0
أخطاء تنسيق XML / JSON
إذا كنت تواجه مشكلة في تنسيق البيانات التي تحاول إضافتها أو تحديثها على ملف ORCID سجل ، نوصي باستشارة الأمثلة من خلال:
- إرسال مكالمة لقراءة السجل أو العنصر الفردي لتلقي مثال XML / JSON ، أو ، إذا كنت تقوم بتحديث سجل ، فإن XML / JSON الكامل للعنصر الذي تقوم بتحديثه ، واستخدم هذا كنقطة البداية
- استشارة عينة من ملفات XML و JSON في مستودع GitHub لدينا - لدينا كل من XML / JSON النظيف للنشر و XML / JSON الكامل لقراءة الأمثلة
قبل أن تتمكن من إضافة عنصر إلى ORCID سجل ستحتاج إلى تنسيق بياناتك في ملف ORCID مخطط. قم بتنسيق بياناتك بتنسيق ORCID مخطط الرسالة بتنسيق XML أو JSON.
يحتوي مستودع GitHub الخاص بنا على موارد من شأنها أن تساعد في التنسيق عند إنشاء عناصر جديدة على ORCID ، وعند قراءة العناصر الموجودة على ORCID سجل:
لاحظ أن الإصدارات المختلفة من API لها تنسيقات رسائل مختلفة. الإصدار 2.0 و 2.1 مخططات وأمثلة متاحة أيضًا.
يمكن العثور على المزيد من الأمثلة بسهولة من خلال قراءة البيانات الوصفية لسجل ممتلئ جيدًا.
0
0
أخطاء النطاق
إذا كنت تتلقى أخطاء تتعلق بالنطاقات ، فإننا نوصيك بما يلي:
- تحقق من أنك لا تستخدم نطاقات الأعضاء مع عميل API عام.
- إذا كنت تقوم بإضافة أو تحديث أو قراءة بيانات رؤية محدودة لديك النطاقات الصحيحة لتنفيذ الإجراء.
- تحقق من أنك لا تطلب نطاقات ثنائية باستخدام بروتوكول OAuth الثلاثي والعكس بالعكس.
عند طلب الإذن بالتفاعل مع 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 الأعضاء فقط.
0
4
يوجد نطاقان مختلفان للتحديث - أحدهما لتفاصيل السيرة الذاتية والآخر للأنشطة.
| مجال | الوصف | نقاط النهاية API |
| / شخص / تحديث | بيانات السيرة الذاتية - العمود الأيسر من ملف ORCID سجل واجهة المستخدم. | /عنوان / المعرفات الخارجية /الكلمات الدالة /اسماء اخرى / الباحث-urls |
| / الأنشطة / التحديث | بيانات نشاط البحث - العمود الأيمن من ORCID سجل واجهة المستخدم. | /امتياز / الفروق /التعليم / التعليم /توظيف / التوظيف / التمويل / التمويل / موقف مدعو / وظائف مدعوة /عضوية / العضويات /استعراض النظراء /آراء الأقران /المؤهل /مؤهلات / موارد البحث / موارد البحث /الخدمات /خدمات /الشغل / يعمل |
2
7
رسائل خطأ التسجيل
بشكل عام ، لن يواجه المستخدمون سوى عدد قليل من الأخطاء المتعلقة بواجهة برمجة التطبيقات عند السماح بالاتصال بتطبيقك:
إعادة توجيه URI غير صالحة
إعادة التوجيه URI لا يتطابق مع عناوين URI المسجّلة لإعادة التوجيه.
تشير رسالة الخطأ هذه إلى أن رابط التفويض الخاص بك يحدد عنوان URI لإعادة التوجيه لم تسجله في بيانات اعتماد عميل واجهة برمجة التطبيقات. إذا كنت تستخدم واجهة برمجة التطبيقات العامة ، فيمكنك إصلاح ذلك بنفسك في ملف ادوات المطورين. إذا كنت تستخدم Member API ، فستحتاج إلى طلب ORCID فريق العمل لتحديث بيانات الاعتماد الخاصة بك.
رابط غير صالح لنموذج تفويض OAuth
الصفحة المطلوبة لا يمكن العثور عليها. إذا تم وضع إشارة مرجعية على هذه الصفحة ، يرجى حذفها. إذا كنت قد اتبعت رابطًا ، فيرجى الإبلاغ عنه.
يميل هذا الخطأ إلى الحدوث عندما يتم تكوين رابط مصادقة OAuth بشكل غير صحيح ، على سبيل المثال https://orcid.org/signin/oauth/authorize?[….] بدلا من https://orcid.org/oauth/authorize?[…]. لحل المشكلة ، ما عليك سوى تصحيح الرابط.
رسالة غير وصفية
كانت هناك مشكلة في الخادم. إذا استمرت هذه المشكلة ، يرجى الاتصال بالدعم.
يحدث هذا الخطأ غالبًا عندما لا يتم تحديد نطاق. يجب عليك تضمين نطاق على رابط تفويض OAuth ؛ النطاق الأدنى هو / المصادقة.
تحقق فيما لو ORCID يعمل!
إنه نادر جدًا ، ولكن إذا كنت تعتقد أن الخطأ يمثل مشكلة في ORCID الخوادم التي يمكنك التحقق منها http://status.orcid.org/
نلاحظ أن ORCID لا يوجد لدى Sandbox اتفاقية على مستوى الخدمة وقد يكون معطلاً لمدة 20 دقيقة عندما نصدر تحديثات التعليمات البرمجية.
الحصول على تعليمات
يسعدنا دائمًا تقديم المساعدة! ORCID يمكن للمنظمات الأعضاء الحصول عليها دعم من ORCID مباشرة.
يتم تشجيع جميع العاملين في مجال الدمج أيضًا على الانضمام إلى ORCID مجموعة مستخدمي API، حيث يمكنك التواصل مع شركات الدمج ومستخدمي API الآخرين ، بالإضافة إلى ORCID الفريق.