ORCID sistemlerinizin sunucuya bağlanmasına izin veren çeşitli API'ler sunar. ORCID okuma ve yazma dahil olmak üzere kayıt defteri ORCID kayıtlar. Bazı API işlevleri herkes tarafından ücretsiz olarak kullanılabilir (Genel API); diğerleri yalnızca kullanılabilir ORCID üye kuruluşlar (Üye ve Premium Üye API'si). Korumalı alan test sunucumuzda herkes API'larımızdan herhangi birini test etmekte özgürdür.
Başlamadan önce
Entegrasyon planlamanıza başlarken şunları göz önünde bulundurmalısınız:
- ile ne yapmak istiyorsunuz? ORCID API— lütfen şu adresimizi ziyaret edin: iş akışları ve En iyi entegrasyon uygulamaları. Eğer bir ORCID üye kuruluş yardım için bizimle veya konsorsiyum liderinizle iletişime geçebilirsiniz! .
- Halihazırda destekleyen bir sistem kullanıp kullanmadığınız ORCID. Eğer öyleyseniz, sisteminizi çalışacak şekilde yapılandırmak kadar basit olabilir. ORCID. Lütfen kontrol edin ORCID sertifikalı servis sağlayıcı listesi sisteminizin dahil olup olmadığını görmek için
- Uygulanmakta olan değişiklikler hakkında araştırmacılarınızla nasıl iletişim kuracaksınız, onlardan neye ihtiyacınız olacak, onlara faydaları ve ne yapmaları gerekecek. ziyaret edin Sosyal Yardım Kaynakları Yeni entegrasyonunuz etrafında bir iletişim kampanyasının nasıl oluşturulacağına ilişkin fikirler için sayfa. Ayrıca web seminerimizi de izlemenizi öneririz'Artık üyeyim ne olacak? hakkında nasıl konuşulur ORCID'
Korumalı alan kimlik bilgileri için kaydolun ve bir test oluşturun ORCID iD
Özel bir entegrasyon oluşturuyorsanız veya sertifikasız bir hizmet sağlayıcı uygulaması kullanıyorsanız entegrasyonunuzu oluşturup test etmek için öncelikle Sandbox ortamımızı kullanmanızı isteriz.
Yapabilirsin sanal alan Üye API kimlik bilgilerini isteyin Uygulamanızı oluşturmak ve test etmek için. Bu kimlik bilgileri, okuma, yazma ve güncelleme için korumalı alan premium üye API'sine çağrı yapmanıza olanak tanır ORCID kayıtlar. Korumalı alan test ortamına erişim, bir uzman olmasanız bile herkes tarafından ücretsiz olarak kullanılabilir. ORCID üye kuruluş.
not: Eğer kullanıyorsanız ORCID Zaten destekleyen sertifikalı servis sağlayıcı sistemi ORCIDdenemek istemediğiniz sürece korumalı alan API kimlik bilgilerine kaydolmanıza gerek yoktur. ORCID Sandbox ortamında entegrasyon işlevselliği.
Korumalı alan, canlı (üretim) verileri etkileme endişesi duymadan test kullanıcı hesapları oluşturmanıza ve entegrasyonunuzu geliştirmenize olanak tanır. ORCID Kayıt. Korumalı alan, üretimle aynı şekilde davranır ORCID ile kayıt ol birkaç istisna.
test hesabı oluşturma
test etmek için ORCID Okuma ve bir dosyaya bilgi ekleme gibi API ve API çağrıları ORCID kayıt, ayrıca bir test oluşturmanız gerekecek ORCID sandbox'a kaydedin. Bu, üretimde olduğu gibi kullanıcı arabirimi aracılığıyla yapılabilir. ORCID Kayıt. git https://sandbox.orcid.org/register ve bir hesap için kaydolun.
Postacı e-posta adresleri
Korumalı alan sunucusu yalnızca e-postaları gönderir Mailinator (@mailinator.com) e-posta adreslerini istemeden posta sunucularına spam göndermemek için. Bir @mailinator.com adresi kullanmadığınız sürece bir doğrulama e-postası veya parola sıfırlama bildirimi almazsınız ve korumalı alan kayıtlarında herhangi bir manuel düzenleme yapmak için doğrulama gerekir. Ücretsiz genel gelen kutuları hakkında daha fazla bilgi edinin . kullanmak istemiyorsanız Mailinator adresi, ardından lütfen kullanıcı adınızı ve şifrenizi not edin (test sırasında uygulamanıza yetki vermek için bunları kullanacağınız için) ve doğrulama konusunda yardım istemek için bizimle iletişime geçin.
Mailinator halka açık ücretsiz hizmeti ve özel ücretli hizmeti olan bir e-posta hizmetidir. Test için tamamen ücretsiz kamu hizmetini kullanabilirsiniz. Seviyeleri hakkında daha fazla bilgi edinin okuyun.
Mailinator, tarafından yönetilmeyen veya sürdürülmeyen bir üçüncü taraf hizmetidir. ORCID. Bu adresleri kullanmadan önce bu hizmetin nasıl çalıştığını ve sınırlamalarını gözden geçirmenizi öneririz.
İhtiyacınız olan kullanıcı izinlerini belirleyin
The ORCID Üye API'si, bir kullanıcının bilgilerini okumak, eklemek veya güncellemek için kullanılabilir. ORCID kaydedin—yalnızca araştırmacılarınızdan izin istemeniz gerekir.
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, bir derginin üyelik, finansman, çalışmalar, mesleki faaliyetler, araştırma kaynakları ve hakem incelemesi bölümlerindeki öğelerin yazılması, güncellenmesi ve silinmesi 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 kimlik, ara ORCID kayıtları veya özet bilgileri okumak için (yalnızca üye API'si). 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.
Verileri güvenli bir şekilde saklayabildiğinizden emin olun
Sisteminizin bilgileri depolayabilmesi önemlidir. güvenli bir şekilde.
Entegrasyonların yalnızca depolamaktan daha fazlasını depolaması gerekir ORCID kayıtlar. Sisteminizin şunları yapabilmesi gerekir:
- Kabul et ve sakla ORCID kimlikler: Sisteminizin aşağıdakileri bilmesi gerekir: iD arasında ORCID görüntülemek için kayıt yapın iD ve doğru şekilde güncellemek için. Bunu, araştırmacının jeton değişimi yanıtında döndürülen bilgileriyle birlikte saklayın. Tavsiyemiz https URI'sinin tamamını saklamanızdır: https://orcid.org/0000-0001-5727-2427.
- Kalıcı olarak kabul et ve sakla erişim belirteçleri ve jetonları yenile: Erişim belirteçleri, kayıtları okumak ve güncellemek ve aynı zamanda iD kimliği doğrulandı. Erişim belirteçleri yaklaşık 20 yıl süreyle veya kullanıcı bunları iptal edene kadar geçerlidir. Ayrıca saklamanızı da öneririz. belirteç kapsamı, belirteç sona erme ve jetonları yenile. Gerektiğinde aynı veya sınırlı kapsamlara sahip yeni erişim belirteçleri oluşturmak için yenileme belirteçleri kullanılabilir. Erişim belirteci belirteci verilerini araştırmacının bilgileriyle birlikte saklayın.
- Kabul et ve sakla kodları koy : Eklediğiniz her öğe ORCID Registry tarafından bir put kodu ile iade edilecektir. ORCID API'dir. Bu 6 haneli koyma kodunu öğenizle birlikte sisteminize kaydedin; böylece hangi öğenin okunması, güncellenmesi veya silinmesi gerektiğini belirleyeceksiniz.
- Bir etkileşim beklendiği gibi gitmediğinde hata mesajları ve bir destek yetkilisi sağlayın.
ile check-in ORCID uygulamanızın nasıl çalıştığını göstermek için ekibiniz veya Konsorsiyum Lideriniz
Entegrasyonunuz internet üzerinde canlı yayına geçmeden önce ORCID üretim kaydı, Katılım Ekibimiz veya Konsorsiyum Lideriniz, sanal alanda oluşturduğunuz her şeyin üretimde de çalışıp çalışmayacağını iki kez kontrol edecektir. Eğer kullanıyorsanız ORCID Sertifikalı Servis Sağlayıcı sisteminde bu adım atlanabilir. elimizde bir liste var minimum Gereksinimler Üye API Üretimi kimlik bilgilerini verebilmemiz için karşılanması gerekenler.
Üye kuruluşlar talebi ORCID Üretim (canlı) sunucusundaki Üye API kimlik bilgilerini tamamlayarak Üretim Üyesi API istemcisi başvuru formu. Üretim Üyesi API kimlik bilgilerini vermeden önce, ORCID Katılım ekibi/Konsorsiya Lideri entegrasyonunuzun bir demosunu inceleyecektir. ORCID kum havuzu. Bu bize, oluşturduğunuz harika entegrasyonları görme ve iş akışı iyileştirmeleri sunma şansı verir, ayrıca tüm entegrasyonların en iyi uygulamalarımızı ve lansman için minimum gereksinimleri karşılayıp karşılamadığını kontrol etme şansı verir.
Sisteminizin bir demosunu sağlamak için, sistemle çalışan bir entegrasyon kurmanız gerekir. ORCID kum havuzu ORCID ekip önizleme yapabilir. Çalışan sanal alan entegrasyonunuzu paylaşmanın birkaç yolu vardır:
- Önerilen: Canlı demo: Canlı bir gösteri planlamak için bizimle iletişime geçin. Entegrasyonunuzu tanıtmanız için ekranınızı paylaşmanıza olanak tanıyan toplantı yazılımı sağlayacağız.
- Test sitesi: Geliştirme siteniz herkese açıksa, bize URL'yi gönder sisteminize erişmek için test kimlik bilgileri (gerekirse) ve sisteminizin nasıl kullanılacağını açıklayan talimatlar ile birlikte ORCID özellikler. Kullanıcı tarafında göremediğimiz şeyleri doğrulamak için ek belgeler sağlayın, örneğin kullanılan API sürümü, sisteminiz tarafından hangi verilerin depolandığı vb.
- Ekran yayını veya ekran görüntüleri:Bir kayıt veya bir dizi ekran görüntüsü gönderin Bir kullanıcının erişimi reddetmesi veya iD bağlantısını kesmesi durumunda ne olacağı da dahil olmak üzere, entegrasyonunuzun her adımda nasıl çalıştığını açıkça açıklayan ve gösteren açıklamalarla. Kullanılan API sürümü ve verilerin nasıl depolandığı gibi kullanıcı tarafından göremeyeceğimiz herhangi bir şeyi doğrulamak için ek belgeler sağladığınızdan emin olun.
Üye kuruluşlar talebi ORCID Üretim (canlı) sunucusundaki Üye API kimlik bilgilerini tamamlayarak Üretim Üyesi API istemcisi başvuru formu. Listede olmayan bir satıcı sistemi kullanıyorsanız ORCID Sertifikalı Servis Sağlayıcılar, entegrasyonunuzun, aşağıdakilerin sağlanması için bir inceleme sürecinden geçmesi gerekecektir: Entegrasyon ve en iyi uygulamalar için asgari gereksinimler karşılanmaktadır.
Sertifikalı olmayan Hizmet Sağlayıcınızla iletişime geçebilir ve asgari kriterlerin karşılandığına dair doğrudan onlardan kanıt alabilirsiniz. Bu kanıtı şuraya göndermeniz gerekecektir: ORCID Katılım ekibi veya Konsorsiyum Lideriniz.
Bu kanıtı paylaşmanın birkaç yolu vardır:
- Ekran görüntüsü veya ekran görüntüleri: Her adımda entegrasyonunuzun nasıl çalıştığını açıklayan ve gösteren açıklamalarla bir kayıt veya bir dizi ekran görüntüsü gönderin, buna bir kullanıcının erişimi reddetmesi veya kimliğinin bağlantısını kesmesi durumunda ne olacağı da dahildir. Kullanıcı tarafından göremeyeceğimiz herhangi bir şeyi doğrulamak için ek belgeler sağladığınızdan emin olun, örneğin kullanılan API sürümü ve verilerin nasıl depolandığı gibi.
- Kamuya açık entegrasyon dokümantasyonu: Her adımda entegrasyonun nasıl çalıştığına dair net bir açıklama içeren, herkesin erişebileceği ve güncel bir bağlantı gönderin. 1. seçenekte olduğu gibi, kullanılan API sürümü ve verilerin nasıl depolandığı gibi kullanıcı tarafından göremeyeceğimiz herhangi bir şeyi doğrulamak için ek belgeler sağladığınızdan emin olun.
Üye API Kimlik Bilgilerini İste
Entegrasyonunuz tarafından incelendikten sonra üye API kimlik bilgileri için başvurabilirsiniz. ORCID bir takım kullanıyorsanız veya bir takım kullanıyorsanız ORCID sertifikalı servis sağlayıcı sistemi.
doldurmanız gerekecek bir müşteri uygulamasını kaydetmek için form. Aşağıda istenen alanlara hızlı bir genel bakış verilmiştir:
Organizasyonun adı: Sizin ORCID üye kuruluş adı
Kimlik bilgileri için birincil iletişim e-posta adresi: Bu e-posta adresini size kimlik bilgilerini şifrelenmiş bir e-postayla göndermek ve entegrasyonunuzla ilgili herhangi bir soru veya hata ortaya çıkarsa sizinle iletişim kurmak için kullanacağız.
Şifre için ikincil e-posta: Şifrelenmiş e-posta şifrenizi gönderebileceğimiz bir e-posta adresi.
Müşterinizin adı: bu senin olacak ORCID üye kuruluşun adı. Eğer 1'den fazla entegrasyonunuz varsa uygulamayı ismin yanına ekleyeceğiz.
Uygulamanızın ana sayfasının URL'si: Kullanıcılar arasında güvenilen kuruluşlar listesinde bir bağlantı olarak görüntülenir ORCID güvenilir taraflar sayfası. Bu, kuruluşunuza veya başvurunuzun ana sayfasına giden bir bağlantı olmalıdır.
İstemci uygulamanızın kısa açıklaması: Bu metin entegrasyon kullanıcılarınıza yetkilendirme ekranında soru işareti simgesiyle birlikte gösterilecektir. Entegrasyonunuzun kısa bir açıklaması gerekli
Yönlendirme URI'leri: Kullanıcı, uygulamanızı yetkilendirdikten sonra, belirttiğiniz bir URI'ye döndürülür. Bu URI'leri önceden sağlamanız gerekir, aksi takdirde entegrasyon kullanıcılarınız bir hatayla karşılaşır.
- Yalnızca HTTPS URI'leri kabul edilir.
- Kaydedilen alan adları, alt alan adları da dahil olmak üzere, kullanılan alan adlarıyla tam olarak eşleşmelidir.
- Mümkün olan yerlerde tüm yönlendirme URI'lerini tam olarak kaydedin.
- 5'ten fazla yönlendirme URI'si gerekli mi? Lütfen bunu Notlarda belirtin ORCID personel.
için notlar ORCID personel: izin vermek için bu alanı kullanın ORCID personel talebiniz veya entegrasyonunuz hakkında ek her şeyi biliyor
Başvurunuzu şuraya aktarın: ORCID Üretim Kaydı
Kimlik bilgilerinizi aldıktan sonra entegrasyonunuzu hayata geçirmeye hazırsınız. Entegrasyonunuzu halka açılmadan önce test etmek istiyorsanız lütfen test cihazının kendi aracını kullanın. ORCID kayıt veya bir meslektaşın ORCID kayıt.
Başlatın ve herkesin bilmesini sağlayın
Bir uygulamayı canlıya almak son adım değildir; kullanıcılarınızla iletişim kurmaya devam etmeniz gerekir; ORCID iD hızlı ve kolay bir şekilde sisteminize Etkili entegrasyonlar, hem teknik bir bileşeni (bu kılavuzun kapsadığı) hem de bir sosyal bileşeni içerir. Araştırmacıların ne olduğu konusunda bilgilendirilmeleri gerekir. ORCID neden erişim talep ediyorsunuz? ORCID kayıt ve onların verileriyle ne yapacağınız.
- Bir iletişim zaman çizelgesi oluşturun: Paydaşların sizin durumunuzdan haberdar olduğundan emin olun. ORCID lansmandan çok önce projelendirin.
- Yukarıdan aşağıya ve aşağıdan yukarıya iletişimin bir kombinasyonunu kullanın.
- Tanıtın ORCID entegrasyon sık sık ve farklı kitlelere.
- Yerel kaynaklar oluşturun SSS'ler, libguide'ler, web sayfaları, öğreticiler ve videolar gibi kullanıcılarınızı desteklemek için.
- için yerel bir irtibat kişisi atayın ORCID-ilgili sorular.
Yardıma ihtiyacınız olursa, Katılım Liderinizle veya Konsorsiyum Liderinizle iletişime geçin.
Sosyal bileşeni desteklemek için bir araç seti sunuyoruz. Sosyal Yardım Kaynakları entegrasyonunuzu desteklemek için bir kampanya geliştirmenize yardımcı olmak ve araştırmacılarınızla iletişim kurmak için:
- Ne ORCID olduğunu.
- Sisteminizin kimlikleri neden topladığı ve kayıtlarını güncellemek gibi görevleri nasıl gerçekleştireceği.
- Araştırmacılarınız neden bir ORCID iD ve kimliklerini sisteminize bağlama.
- Ne kadar ORCID daha geniş, küresel araştırma topluluğuna fayda sağlar.
Topluluktan gelen geri bildirimlere dayalı olarak bu kaynak "kütüphanesini" sürekli olarak oluşturacağız. Görmek isteyebileceğiniz bir şey için bir fikriniz varsa, lütfen bizimle iletişime geçmekten çekinmeyin.