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ı.
- Kuruluşunuzun olup olmadığı zaten bir ORCID üye veya biri olmayı planlamak. Sadece ORCID üyeler öğe ekleyebilir ORCID Kayıtlar.
- Halihazırda destekleyen bir sistem kullanıp kullanmadığınız ORCID. Eğer öyleyse, sisteminizi çalışacak şekilde yapılandırmak kadar basit olabilir. ORCID.
- 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 fikirlerin bulunduğu sayfa.
Korumalı alan kimlik bilgileri için kaydolun ve bir test oluşturun ORCID iD
Öncelikle etkileşim kuran araçlar oluşturmanızı istiyoruz. the ORCID kum havuzu test sırasında üretim kayıt defterindeki herhangi bir verinin veya kendi sistemlerinizin etkilenmesini önlemek için.
Yapabilirsin sanal alan Üye API kimlik bilgilerini isteyin Uygulamanızı oluşturmak ve test etmek için. Bu kimlik bilgileri, sanal alan üye API'sini okumak, yazmak ve güncellemek için ç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: Halihazırda destekleyen bir üçüncü taraf sistemi kullanıyorsanız ORCID, korumalı alan API kimlik bilgileri için kaydolmanız gerekmeyebilir.
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, bildirim e-postalarını yalnızca 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 kayıt—araştırmacılarınızdan izin istemeniz yeterlidir. İhtiyacınız olan kapsamlar, sisteminize en uygun API'yi büyük ölçüde etkiler.
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.
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üncellemek için kaydedin. Araştırmacının bilgileriyle birlikte saklayın. Önerimiz, tam https URI'sini 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 kimlik doğrulaması yapıldı. Kalıcı belirteçler, yaklaşık 20 yıl boyunca veya kullanıcı bunları iptal edene kadar geçerlidir. Yenileme belirteçleri, aynı veya sınırlı kapsamlara sahip yeni erişim belirteçleri oluşturmak için kullanılabilir. Belirteçleri araştırmacının bilgileriyle birlikte saklayın. saklamanızı da öneririz. belirteç kapsamı, ve,belirteç sona erme.
- Kabul et ve sakla kodları koy (güncelleniyorsa ORCID kayıtları): Listeye eklediğiniz her öğe ORCID Registry tarafından bir put kodu ile iade edilecektir. ORCID API. Bu yerleştirme kodunu sisteminizdeki öğeyle birlikte kaydedin, hangi öğenin okunması veya güncellenmesi gerektiğini bu şekilde belirleyeceksiniz.
- Günlük etkileşimleri: Sisteminiz, kullanıcıya yapılan her iki çağrıyı da kaydetmelidir. ORCID API ve alınan yanıtlar. bu gerekli yani ORCID daha sonra bir sorun gelişirse yardımcı olabilir.
- 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 ekip
Entegrasyonunuz internet üzerinde canlı yayına geçmeden önce ORCID üretim kaydı, Etkileşim Ekibimiz korumalı alanda oluşturduğunuz her şeyin üretimde de işe yarayıp yaramadığını iki kez kontrol edecektir. Yerleşik bir sistem kullanıyorsanız ORCID desteği, bu adım atlanabilir.
Ü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 Etkileşim ekibi, entegrasyonunuzun bir demosunu gözden geçirecek. ORCID kum havuzu. Bu bize, oluşturduğunuz harika entegrasyonları görme ve iş akışı iyileştirmeleri sunma ve ayrıca tüm entegrasyonların en iyi uygulamalarımızı 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. Entegrasyonunuzun demosunu yapmanız için ekranınızı paylaşmanıza izin veren toplantı yazılımı sağlayacağız. Bu aynı zamanda bize sisteminizin nasıl çalıştığı ve ürününüzün faydalarını nasıl açıkladığınız hakkında daha fazla bilgi edinme fırsatı verir. ORCID entegrasyon, böylece siz ve kullanıcılarınız için daha iyi destek sağlayabiliriz.
- 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 kaydı veya ekran görüntüleri (için önerilir ORCID-demonstrasyon gerektiren etkinleştirilmiş sistemler): Bir kayıt veya bir dizi ekran görüntüsü gönderin Bir kullanıcının iD'sine erişimi reddetmesi veya bağlantısını kesmesi durumunda ne olacağı da dahil olmak üzere her adımda entegrasyonunuzun 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öremediğimiz her şeyi doğrulamak için ek belgeler sağladığınızdan emin olun.¬¨‚
Eğer birini kullanıyorsanız ORCID-demonstrasyon gerektirmeyen etkinleştirilmiş sistemler, doğrudan yapabilirsiniz üretim Üyesi API kimlik bilgilerini talep edin. Notlarda hangi sistemi (ve varsa sürümü) kullandığınızı belirttiğinizden emin olun.
Tüm üye entegrasyonlarının karşılamasını beklediğimiz bir dizi gereksinim vardır. bu ORCID ekibi, entegrasyon inceleme sürecinin bir parçası olarak bu gereksinimlerin karşılandığından emin olacaktır.
- kullanım OAuth doğrulamak ORCID kimlikler (Kullanıcıların arama yapmasına veya yazmasına izin verme ORCID Kimlikler.)
- Ekle ORCID markalı düğme veya bağlantı iD'nin kimlik doğrulamasını başlatmak için sitenizde.
- OAuth yetkilendirme ekranını bizim tanımlarımıza göre sunun. kuralları yenileyerek
- Sitenizin yönlendirme URI'leri ve üzerinde HTTPS kullanın ORCID API çağrıları
- Belirteç değişiminde döndürülen tüm verileri, kullanıcının verileriyle birlikte sisteminizde kabul edin ve saklayın
- uygun kullanın kapsamları ve istek yöntemleri (örneğin, yeni bilgiler eklemek için POST çağrıları ve mevcut bilgileri güncellemek için PUT çağrıları)
- Kimliği doğrulanmış olanı herkese açık olarak göster ORCID Kimlikler. iD'ler şu şekilde görüntülenmelidir: ticari marka ve iD yönergeleri görüntüleyin.
Üretim sunucusunda kimlik bilgilerini isteme
Entegrasyonunuz tarafından incelendikten sonra üye API kimlik bilgileri için başvurabilirsiniz. ORCID ekibi veya yerleşik bir servis sağlayıcı sistemi kullanıyorsanız ORCID entegrasyon.
doldurmanız gerekecek bir müşteri uygulamasını kaydetmek için form. Aşağıda istenen alanlara hızlı bir genel bakış verilmiştir:
için notlar ORCID personel: izin vermek için bu alanı kullanın ORCID bir satıcı sistemi kullanıp kullanmadığınızı, entegrasyonların incelenip incelenmediğini vb. bilin.
İletişim e-posta adresi: Kimlik bilgilerini bu adrese göndereceğiz. Bu, entegrasyon üzerinde birlikte çalıştığımız ilgili kişi veya kuruluşunuz için tuttuğumuz teknik kişi olmalıdır.
Kimlik bilgilerine erişmek için PIN almak için iletişim kurun: Tüm kimlik bilgilerini size güvenli bir şekilde gönderiyoruz. API kimlik bilgilerinize erişmesi için bu kişiye bir parola göndereceğiz. Bu, listelenen önceki kişiden farklı bir kişi olmalıdır.
İstemci uygulamanızın kısa açıklaması: Bu metin, yetkilendirme ekranında entegrasyon kullanıcılarınıza soru işareti simgesiyle gösterilecektir. Entegrasyonunuzun kısa bir açıklaması gereklidir.
Uygulamanızın ana sayfasının URL'si: Kullanıcılar içinde güvenilir kuruluşlar listesinde 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.
OAuth2, istemci için URI'leri veya geri arama URL'lerini yeniden yönlendirir: Web uygulamanızda izin verilen URL'ler; burada, kullanıcılara erişim izni verdikten sonra geri dönülecektir. ORCID kayıt verileri. Tüm yönlendirme URI'leri, üretim (canlı) sunucu istemcileri için HTTPS olmalıdır.
İsteğinizi yaptıktan sonra, size kimlik bilgilerini vermek için manuel bir işlem gerçekleşir ve müşterinizden bir e-posta alırsınız. iD ve müşteri sırrı. Genellikle bu talepler 48 saatten daha kısa sürede işlenir.
Başvurunuzu şuraya aktarın: ORCID Üretim Kaydı
Kimlik bilgilerinizi aldıktan sonra, onu canlı olarak almaya hazırsınız. Entegrasyonunuzu halka açılmadan önce test etmek isterseniz, lütfen test eden kişinin kendi 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.
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.