Kayıt Defterimizde ve API'mizde açıklayıcı hata mesajları sağlamak için elimizden gelenin en iyisini yapıyoruz. Karşılaşabileceğiniz hatalarda size yardımcı olacak bazı ipuçlarını burada bulabilirsiniz.
API Hataları
API hata kodlarımız, kolayca anlaşılması gereken açıklayıcı mesajlar içerir.
Yaygın API hata kodlarının bir listesi, olası anlamları ve bunların nasıl giderileceğine ilişkin ipuçları, sayfamızda mevcuttur. teknik döküman.
Yaşadığınız sorunu çözemezseniz lütfen bize bildirin.
XML/JSON biçimlendirme hataları
Bir platformda eklemeye veya güncellemeye çalıştığınız verileri biçimlendirmekte sorun yaşıyorsanız, ORCID kayıt için şu örneklere başvurmanızı öneririz:
- Örnek XML/JSON almak veya bir kaydı güncelliyorsanız, güncellemekte olduğunuz öğenin tam XML/JSON'unu almak için kaydı veya tek tek öğeyi okumak üzere bir çağrı gönderme ve bunu başlangıç noktanız olarak kullanma
- Danışmanlık örnek XML ve JSON dosyaları GitHub depomuzda — hem gönderme için temiz XML/JSON'a hem de okuma örnekleri için tam XML/JSON'a sahibiz
Bir öğe ekleyebilmeniz için önce ORCID kaydında verilerinizi biçimlendirmeniz gerekecek ORCID şema. Verilerinizi şu şekilde biçimlendirin: ORCID XML veya JSON'da mesaj şeması.
GitHub depomuz, üzerinde yeni öğeler oluştururken biçimlendirmeye yardımcı olacak kaynaklar içerir. ORCID kaydedin ve cihazdaki mevcut öğeleri okurken ORCID kayıt:
API'nin farklı sürümlerinin farklı mesaj formatlarına sahip olduğunu unutmayın. Sürüm 2.0 ve 2.1 şemaları ve örnekleri de mevcuttur.
İyi doldurulmuş bir kaydın meta verilerini okuyarak daha fazla örnek kolayca bulunabilir.
Kapsam hataları
Kapsamlarla ilgili hatalar alıyorsanız, şunları yapmanızı öneririz:
- Genel bir API istemcisiyle üye kapsamları kullanmadığınızdan emin olun.
- Sınırlı görünürlük verilerini ekliyor, güncelliyor veya okuyorsanız, eylemi gerçekleştirmek için doğru kapsamlara sahip olduğunuzu gösterir.
- 2 aşamalı OAuth ve tersi kullanarak 3 aşamalı kapsamlar talep edip etmediğinizi kontrol edin.
Biriyle etkileşim kurmak için izin isterken ORCID kullanıcının kaydı, bir veya daha fazla 'kapsam' belirtirsiniz. Her kapsam, kaydı okumak veya belirli bir bölümü güncellemek gibi belirli şeyler yapmanıza izin verir.
3 bacaklı bir kullanıcıdan izin alma sürecinde yer alan üç aktörü ifade eder; ORCID, sisteminiz ve kullanıcının kendisi.
/doğrula
Bu kapsam, ORCID iD ve yalnızca kayıttaki genel bilgileri okuyun. Diğer tüm 3 aşamalı kapsamlar, kimlik doğrulama iznini içerir, bu nedenle başka bir erişim istenirse bu kapsam atlanabilir. Bu kapsam, Üye veya Genel API'de mevcuttur.
/read-limited (yalnızca üye API'si)
Bu kapsam, genel ve sınırlı görünürlük öğelerinin okunmasına erişim elde etmek için kullanılır. ORCID kayıt. Bu kapsam yalnızca Üye API'sinde mevcuttur.
/aktiviteler/güncelleme (yalnızca Üye API'sı)
Bu kapsam, üyelik, finansman, çalışmalar ve araştırma kaynakları ve akran değerlendirmesi bölümlerindeki öğeleri yazmak, güncellemek ve silmek için kullanılır. ORCID kayıt. Bu kapsam yalnızca Üye API'sinde mevcuttur.
/person/update (yalnızca üye API'si)
Bu kapsam, kaydın diğer adlar, anahtar sözcükler, ülkeler, araştırmacı URL'leri, web siteleri ve kişisel dış tanımlayıcılar bölümlerindeki öğeleri yazmak, güncellemek ve silmek için kullanılır. Bu kapsam yalnızca Üye API'sinde mevcuttur.
açık kimlik
Bu kapsam, bir id_token gerektiğinde OpenID entegratörleri tarafından kullanılır. Openid kapsamı dahil edildiğinde, Kayıt Defteri belirteç yanıtı içinde bir id_token döndürür ve istemciye o kullanıcı için kullanıcı bilgisi uç noktasına erişme izni verir. Bu kapsam, genel ve üye API'sinde mevcuttur.
Lütfen 'openid' kapsamının diğerleri gibi bir '/' ile başlamadığını unutmayın. ORCID API kapsamları. Bunun nedeni, 'openid' kapsamının şu şekilde tanımlanmamasıdır: ORCID, ancak bunun yerine OpenID Connect belirtimi tarafından tanımlanır. lütfen bizimkine bakın OpenID belgeleri daha fazla bilgi için.
Birden çok kapsam
Kapsam=/read-limited%20/activities/update%20/person/update gibi, kimlik doğrulama URL'sindeki kapsamları aralarında kodlanmış bir boşlukla listeleyerek tek bir etkileşimde birden çok kapsam talep edilebilir
Tam erişim
Bir kaydı okumak ve düzenlemek için tam erişim istiyorsanız, kimlik doğrulama URL'nize üç kapsam ekleyin: /read-limited, /activities/update ve /person/update. URL'de kapsam=/read-limited%20/activities/update%20/person/update olarak görünürler.
2 aşamalı (müşteri kimlik bilgisi) kapsamları
Bazı aktiviteler için kullanıcıdan izin almanıza gerek yoktur. İki aşamalı OAuth kapsamları doğrudan ORCID API ve araştırmacının izin vermesini gerektirmez. Bu kapsamlara sahip jetonlar 20 yıl geçerlidir ve yeniden kullanılabilir.
/okuma-genel
Bu kapsam, genel bilgileri tek bir cihazda okumak için kullanılır. ORCID iD veya ara ORCID kayıtlar. Bu kapsam, Üye veya Genel API'de mevcuttur.
/web kancası
Bu kapsam, bir istemci uygulamasının bir web kancasını bir ORCID Bir kayıt güncellendiğinde bildirim almak için kayıt. Bu kapsam premium olarak kullanılabilir ORCID sadece üyeler. Premium üye değilseniz, ancak bu işlevi Developer's Sandbox'ta test etmek istiyorsanız, lütfen UAF ile ORCID Topluluk.
- Geçmişte ORCID desteklenen diğer kapsamlar, şu anda aşamalı.
- Bulabilirsin buraya belirli bölümleri eklemek veya güncellemek için hangi kapsamların gerekli olduğu.
Biri biyografik ayrıntılar, diğeri etkinlikler için olmak üzere iki farklı güncelleme kapsamı vardır.
kapsam | Açıklama | API uç noktaları |
/kişi/güncelleme | Biyografik veriler - sayfanın sol sütunu ORCID kullanıcı arabirimini kaydedin. | /adres /harici tanımlayıcılar /anahtar kelimeler /diğer isimler /araştırmacı-url'leri |
/aktiviteler/güncelleme | Araştırma faaliyeti verileri-sağdaki sütun ORCID kullanıcı arabirimini kaydedin. | / ayrım / ayrımlar /Eğitim /eğitimler /iş / istihdam /finansman /fonlar /davet edilen konum /davet edilen pozisyonlar /üyelik /üyelikler /akran değerlendirmesi /akran değerlendirmeleri /vasıf / nitelikler / araştırma-kaynak / araştırma kaynakları /hizmet /Hizmetler /iş /İşler |
Kayıt defteri hata mesajları
Genel olarak kullanıcılarınız, uygulamanızla bir bağlantıya yetki verirken API ile ilgili yalnızca birkaç hatayla karşılaşır:
Kötü yönlendirme URI'sı
Yönlendirme URI'si kayıtlı yönlendirme URI'lerinizle eşleşmiyor.
Bu hata mesajı, yetkilendirme bağlantınızın, API istemci kimlik bilgilerinize kaydetmediğiniz bir yönlendirme URI'sini belirttiğinin bir göstergesidir. Genel API kullanıyorsanız, bunu kendiniz düzeltebilirsiniz. Geliştirici Araçları. Üye API'sini kullanıyorsanız, ORCID Kimlik bilgilerinizi güncellemek için etkileşim ekibi.
İstenen sayfa bulunamadı. Bu sayfaya yer işareti koyduysanız, lütfen silin. Bir bağlantıyı takip ettiyseniz, lütfen bildirin.
Bu hata, OAuth yetkilendirme bağlantısı yanlış bir şekilde oluşturulduğunda, örneğin https://orcid.org/signin/oauth/authorize?[….] yerine https://orcid.org/oauth/authorize?[…]. Çözmek için bağlantıyı düzeltmeniz yeterlidir.
Açıklayıcı olmayan mesaj
Sunucuyla ilgili bir sorun oluştu. Bu sorun devam ederse, lütfen destekle iletişime geçin.
Bu hata genellikle kapsam belirtilmediğinde ortaya çıkar. OAuth yetkilendirme bağlantısına bir kapsam eklemelisiniz; minimum kapsam /authenticate şeklindedir.
Kontrol eğer ORCID çalışıyor!
Çok, çok nadirdir, ancak hatanın sistemle ilgili bir sorun olduğunu düşünüyorsanız ORCID Kontrol edebileceğiniz sunucular http://status.orcid.org/
Unutmayın ORCID Korumalı alanın hizmet düzeyi sözleşmesi yoktur ve kod güncellemeleri yayınlarken 20 dakikalık süreler boyunca hizmet dışı kalabilir.
Yardım almak
Her zaman yardımcı olmaktan mutluluk duyarız! ORCID üye kuruluşlar alabilir Destek ORCID direkt olarak.
Tüm entegratörlerin de katılmaya teşvik edilmesi ORCID API Kullanıcıları Grubu, diğer entegratörlerle ve API kullanıcılarıyla ve ayrıca ORCID takım.