Bu öğretici, bir bilgisayarla ilgili genel ve sınırlı erişim bilgilerini okuma konusunda size yol gösterecektir. ORCID genel veya üye API'sini kullanarak kayıt yapın. 3.0 sürümüne dayanmaktadır. ORCID mesaj şeması.
Bazı müşteri kimlik bilgilerini alın
İstemci kimlik bilgileri, uygulamanızın/web sitenizin istemciye erişmek için kullanacağı kullanıcı adı ve paroladır. ORCID API. Salt okunur Genel API kimlik bilgileri için herkes kaydolabilir, ORCID üyeler, üye API'sine kaydolabilir.
Geliştiricilerin Genel API'yi şu adreste test etmelerini öneririz: korumalı alan test sunucusu üretim sürümünü kullanmadan önce. Aşağıda, hem Korumalı Alan hem de Üretim ortamlarında genel API kimlik bilgilerine nasıl kaydolacağınıza ilişkin adımlar yer almaktadır.
- oturum senin ORCID kayıt:
Üretim sunucusu: https://orcid.org/signin
Sandbox test sunucusu: https://sandbox.orcid.org/signin - Sağ üst köşedeki adınıza tıklayın
- Tıkla Geliştirici Araçları menü seçeneğinden
Not: Geliştirici Araçları'na erişmek için e-posta adresinizi doğrulamanız gerekir. Henüz e-posta adresinizi doğrulamadıysanız, genel API kimlik bilgilerine kaydolmadan önce yapmanız istenecektir. - Okuyun ve kabul edin'ORCID Genel Müşteri Hizmet Şartları
- "Kaydol" düğmesini tıklayın ORCID genel API kimlik bilgileri ”düğmesine tıklayın.
Başvuru Detayları Formunun Doldurulması
- Genel API Kimlik Bilgileriniz için kaydolduktan sonra, Geliştirici Araçlarına (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
- Yeni bir başvuru kaydı yapmak için sunulan başvuru ayrıntıları formunu doldurmanız gerekir.
- Name: Uygulamanızın adı. Bu, uygulamanıza izinlerini alma izni verdiklerinde kullanıcılara gösterilecektir. ORCID iD, ve kendilerinde görüntülenecektir. güvenilir kuruluş listesi. Kuruluşunuzun veya hizmetinizin adını (örneğin bir dergi adı) kullanmanızı öneririz.
- Uygulama URL'si: Kullanıcının uygulamanız hakkında daha fazla bilgi edinmek için ziyaret edebileceği web sitesi. Bu aynı zamanda kendi sayfalarında da görüntülenecektir. güvenilir kuruluş listesi.
- Uygulama Açıklaması: Geliştirmekte olduğunuz uygulama ve kullanıcı bilgilerini nasıl kullanacağınız hakkında bilgiler ORCID İD. Bu, OAuth ekranında kullanıcılara gösterilecektir.
Ekleme 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.
- Sağlanan kutuya yönlendirme URI'nizi girin
- 1'den fazla yönlendirme URI'si girmeniz gerekiyorsa, 'Başka bir yönlendirme URI'si ekle'yi tıklayın
Lütfen aklınızda bulundurun:
- Bir tek HTTPS URI'leri üretimde kabul edilir
- Kayıtlı alan adları ZORUNLU alt alanlar da dahil olmak üzere kullanılan alanlarla tam olarak eşleşir
- Mümkün olan yerlerde tüm yönlendirme URI'lerini tam olarak kaydedin. Bu, en güvenli seçenektir ve önerdiğimiz şeydir. Yönlendirme URI'leri hakkında daha fazla bilgi için lütfen şu bölümümüze bakın: yönlendirme URI SSS
Başvurunuz kaydediliyor
Başvuru formunu doldurup yönlendirme URI'lerinizi ekledikten sonra başvurunuzu kaydedebilirsiniz.
- 'Uygulamamı kaydet ve müşterimi oluştur'u tıklayın ID ve gizli'
Artık Genel API istemcisi kimlik bilgilerinizi içerecek olan geliştirici araçları sayfasına geri yönlendirileceksiniz.
Kimlik bilgilerinizi güncelleme
Başvuru bilgilerinizde değişiklik yapmak çok basit.
- İlgili bilgileri düzenleyin ve ardından 'Uygulamayı kaydet'i tıklayın
Kimlik bilgilerinizi kullanın
Artık kimlik bilgileriniz olduğuna göre, kullanmaya başlamanın zamanı geldi. ORCID Genel API!
Üye olmanız durumunda kimlik bilgilerinizi üye API'sine aktarabileceğimizi lütfen unutmayın. ORCID üye gelecekte.
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.
Bir erişim belirteci alın
kullanmak için bir erişim belirteci edinmeniz gerekir. ORCID API. Bu, OAuth ile yapılır. Dikkat:
- ORCID üyeler, araştırmacılardan kendi kayıtlarından 'sınırlı' görünürlük verilerini okumak için izin isteyebilir.
- Müşterilerin, halka açık bilgileri okumak için araştırmacıdan izin almasına gerek yoktur.
Genel veya üye API kimlik bilgilerine sahip olan herkes, /okuma-genel erişim belirteci. Bir belirteç almak için, ORCID API belirteci bitiş noktası.
Bu işleme genellikle istemci kimlik bilgileri OAuth akışı veya 2 adımlı OAuth denir.
Korumalı alandaki genel verileri okumak üzere bir erişim belirteci almak için örnek bir çağrı — yer tutucuları kimlik bilgilerinizle değiştirin (köşeli ayraçları çıkardığınızdan emin olun.
URL=https://sandbox.orcid.org/oauth/token
HEADER: Accept: application/json
METHOD: POST
DATA:
client_id=[Your public API client ID]
client_secret=[Your public API secret]
grant_type=client_credentials
scope=/read-public
Daha sonra size aşağıdakine benzer bir erişim belirteci iade edilecektir. Döndürülen belirteç uzun ömürlüdür (yaklaşık 20 yıl boyunca sona ermez) ve genel verileri almak için birden çok kez kullanılabilir. ORCID Kayıtlar.
{"access_token":"4bed1e13-7792-4129-9f07-aaf7b88ba88f","token_type":"bearer",
"refresh_token":"2d76d8d0-6fd6-426b-a017-61e0ceda0ad2","expires_in":631138518,
"scope":"/read-public","orcid":null}
Not: /authenticate kapsamına sahip tüm belirteçler artık /read-public kapsamına da sahip. Yalnızca /authenticate kapsamını kullanırsanız, yeniden bir erişim belirteci almanıza gerek kalmadan genel verileri okumak için saklanan erişim belirteçlerini kullanabilirsiniz.
Üye API'sini kullanan entegratörler şunları kullanabilir: /okuma-genel okuma kapsamı ORCID özetleri kaydedin.
/read-limited erişimi elde etmek için araştırmacıdan izin istemeniz gerekir. Bunu OAuth kullanarak yaparsınız. özellikle, “3 aşamalı OAuth".
Daha fazla bilgi için lütfen bizim API Öğreticisi: Bir bilgisayardaki verileri okuyun ORCID kayıt
ORCID entegrasyonlar, kullanıcıların kimliğini doğrulamak ve kayıtlarıyla etkileşim izni istemek için "3 aşamalı OAuth" kullanır. Herhangi bir entegrasyon, Genel API'yi kullanarak okuma izinleri isteyebilir. ORCID üyeler, güncelleme izinlerini istemek için Üye API'sini kullanabilir. Şu şekilde çalışır:
- Özel bir bağlantı oluşturursunuz
- Tıklandığında, kullanıcı şu adrese gönderilir: ORCID
- ORCID kullanıcıdan oturum açmasını ister
- ORCID kullanıcıdan uygulamanıza izin vermesini ister
- ORCID kullanıcıyı bir yetkilendirme kodu ile sisteminize geri gönderir
- Sisteminiz bu kodu bir erişim belirteci ile değiştirir
Özelleştirilmiş yetkilendirme URL'si, müşteri bilgilerinizin yanı sıra kayıtlarının erişmek istediğiniz belirli alanlarını belirten 'kapsamları' içerir. Oturum açtıktan sonra, kullanıcı sisteminizle bağlantı yetkisi verir ve bir yetkilendirme koduyla birlikte açılış sayfanıza geri döner. Bu kod daha sonra onların almak için kullanılır ORCID iD istenen kapsamlar için geçerli bir erişim belirteci ile birlikte.
API kimlik bilgilerinizin istemcisini belirterek yetkilendirme bağlantınızı oluşturursunuz ID ve ilişkili açılış sayfası (yönlendirme URI'sı). Ayarlayarak hangi izinlerin isteneceğini siz seçersiniz kapsam parametresi.
Aşağıdaki örnek, bilgisayardaki sınırlı erişim verilerini okumak için izin istemektedir. ORCID sanal alan test sunucusu. Gerçek dünyada, bu bağlantıyı web sitenizde görüntülersiniz veya kullanıcıdan kimlik doğrulaması ve yetkilendirme yapmasını isterken bir e-postaya eklersiniz. Ancak, test amacıyla web tarayıcınıza yapıştırmanız yeterlidir. Parantez içindeki verileri müşteri bilgilerinizle değiştirin ve köşeli parantezleri çıkardığınızdan emin olun!
https://sandbox.orcid.org/oauth/authorize?client_id=[Your client ID]&response_type=code&scope=/read-limited&redirect_uri=[Your landing page]
Bir kullanıcı bağlantıya tıkladı, şu adreste oturum açtı: ORCID ve verilen izinler sitenize geri yönlendirilir, bunun gibi:
https://[Your landing page]?code=Q70Y3A
için yetkilendirme kodunu hemen değiştirmelisiniz. ORCID iD ve erişim belirteci. Yetkilendirme kodunun kullanım süresi sona erer. İstek şuna benziyor ve bir web tarayıcısında yapılamaz, sunucunuz tarafından yapılmalıdır.
URL=https://sandbox.orcid.org/oauth/token
HEADER: Accept: application/json
HEADER: Content-Type: application/x-www-form-urlencoded
METHOD: POST
DATA:
client_id=[Your client ID]
client_secret=[Your client secret]
grant_type=authorization_code
code=Six-digit code
redirect_uri=[Your landing page]
ORCID daha sonra araştırmacının kimliği doğrulanmış ORCID iD ve JSON biçiminde bir erişim belirteci:
{"access_token":"f5af9f51-07e6-4332-8f1a-c0c11c1e3728","token_type":"bearer",
"refresh_token":"f725f747-3a65-49f6-a231-3e8944ce464d","expires_in":631138518,
"scope":"/read-limited","name":"Sofia Garcia","orcid":"0000-0001-2345-6789"}
Erişim belirteçleri varsayılan olarak uzun ömürlüdür ve verildikten 20 yıl sonra sona erer. Belirteç, süresi dolmadan önce birden çok kez kullanılabilir.
Erişim belirtecini kullan
3 aşamalı erişim belirteçleri, belirli ORCID kayıt. Bunları kullanmak için, bu kaydı okumak veya güncellemek için yaptığınız API isteklerine dahil edersiniz.
Görünürlük, kullanıcının belirlediği görünürlük tercihine bağlı olarak öğenin gizlilik ayarını gösterir. API aracılığıyla bilgi gönderildiğinde bir görünürlük etiketi dahil edilirse, dikkate alınmaz. Bunun yerine bilgiler, kullanıcının hesap tercihlerinde ayarlanan varsayılan görünürlük tercihine göre yayınlanacaktır.
Herkese açık öğeler, API aracılığıyla herkes tarafından okunabilir ve araştırmacının genel kaydında gösterilir, Güvenilir taraf öğeleri, yalnızca okuma sınırlı erişimi olan müşterilere API aracılığıyla döndürülür; araştırmacının kamuya açık kayıtlarında yer almazlar. Özel öğeler yalnızca araştırmacı ve öğenin kaynağı tarafından görülebilir – API aracılığıyla döndürülen özel öğeler yalnızca, sizin entegrasyonunuz yoluyla kayda eklenenlerdir. Görünürlük ayarları hakkında daha fazla bilgi için bkz. ORCID kayıt.
Ne okumak istediğine karar ver
The ORCID kayıt birçok bölüme ayrılmıştır. Özetin tamamını veya yalnızca ilgilendiğiniz bölümleri okuyabilirsiniz.
Bu örnek arama, tam bir özetini alır ORCID sanal alan sunucusundaki üye API'sini kullanarak XML biçiminde kaydedin. Genel veya Üye API'ye API istekleri yapmak için bir erişim belirtecine ihtiyacınız var.
Method: GET Accept: application/vnd.orcid+xml
Authorization type and Access token:
Bearer [Stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/record
API, isteğin başarıyla alındığını ve tam özetini belirten bir 200 OK mesajı döndürür. ORCID münferit öğelerin özetleri de dahil olmak üzere kayıt.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">
[...]
</record:record>
Her öğenin (iş, finansman, istihdam vb.) kod koymak. Bu, gerekirse öğenin tüm ayrıntılarını elde etmek için kullanılabilir.
The ORCID kayıt, kaydı daha hızlı ve daha tutarlı bir şekilde okumak için ayrı bölümlere ayrılmıştır. Önce özetini almak için bir bölümü arayabilir ve ardından o öğe hakkında sağlam bilgi almak için tek bir öğenin yerleştirme kodunu kullanarak arayabilirsiniz.
API'yi okumak için kullanabileceğiniz özet bölümlerin bir tablosu aşağıda verilmiştir.
Son nokta | Açıklama |
/ kayıt | Tamamının özet görünümü ORCID kayıt |
/kişi | Biyografik bölüm ORCID aşağıdaki /araştırmacı-url'leri dahil olmak üzere kayıt |
/Özet | Doğrulanmış ve kendi kendine onaylanan öğelerin özet görünümü ORCID kayıt (yalnızca üye API'sinde kullanılabilir) |
/adres | Araştırmacının ülkeleri veya bölgeleri |
/e-posta | Kayıtla ilişkili e-posta adres(ler)i |
/harici tanımlayıcılar | Diğer sistemlerdeki bağlantılı harici tanımlayıcılar |
/anahtar kelimeler | Araştırmacı ve çalışmaları ile ilgili anahtar kelimeler |
/diğer isimler | Araştırmacının bildiği diğer isimler |
/kişisel detaylar | Kişisel ayrıntılar: araştırmacının adı, kredi (yayınlanmış) adı ve biyografi |
/araştırmacı-url'leri | Araştırmacının kişisel veya profil sayfalarına bağlantılar |
/aktiviteler | Faaliyetler bölümünün özeti ORCID aşağıdaki /works dahil olmak üzere kaydedin. |
/eğitimler | eğitim bağlantıları |
/ istihdam | İstihdam bağlantıları |
/fonlar | Finansman faaliyetlerinin özeti |
/akran değerlendirmeleri | Hakem değerlendirmesi faaliyetlerinin özeti |
/İşler | Araştırma çalışmalarının özeti |
/ araştırma kaynakları | Araştırma kaynaklarının özeti |
/Hizmetler | Hizmetlerin özeti |
/ nitelikler | Niteliklerini özeti |
/üyelikler | üyelik özeti |
/ ayrımlar | Ayrımların özeti |
/davet edilen pozisyonlar | Davet edilen pozisyonların özeti |
API'ye erişmek için belirteci kullanın
Artık bir erişim jetonunuz var, verileri XML veya JSON formatında almak için bir API çağrısı yapabilirsiniz.
Tüm öğeler (biyografi metni dışında) ORCID rekor var kod koymak:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0"> [...]
</record:record>
Bu yerleştirme kodu, bir öğenin tüm verilerini almak üzere API'ye çağrı yapmak için kullanılabilir. Aşağıdaki öğeler bir kullanılarak sorgulanabilir: kod koymak:
Son nokta | Açıklama |
/adres/[kodu girin] | Tek bir ülke veya bölge |
/biyografi | Biyografi alanı: yalnızca araştırmacının düzenleyebileceği serbest metin alanı |
/eğitim/[kodu girin] | Bireysel bir eğitim bağlantısı öğesi |
/email/[kodu girin] | Kayıtla ilişkili bireysel bir e-posta adresi |
/istihdam/[kodu girin] | Bireysel istihdam ilişkisi öğesi |
/harici tanımlayıcı/[kodu girin] | Başka bir sistemdeki bireysel bağlantılı harici tanımlayıcı |
/finansman/[kodu girin] | Bireysel finansman faaliyeti |
/keywords/[kod girin] | Araştırmacı ve çalışmaları ile ilgili bireysel bir anahtar kelime |
/diğer isimler/[kodu girin] | Araştırmacının bildiği ayrı bir ek isim |
/peer-review/[kodu girin] | Bireysel akran değerlendirmesi etkinliği |
/araştırmacı-urls/[kodu girin] | Araştırmacının kişisel sayfasına veya profil sayfasına tek bir harici bağlantı |
/work/[kodu girin] | Bireysel araştırma çalışması |
/works/[kod1 girin],[kod2 girin],[kod3 girin] | Toplu bireysel araştırma çalışmaları (100'e kadar) |
Bölüm uç noktasını ve kod koymayı kullanarak, söz konusu öğeyi tam olarak almak için aynı erişim belirtecinizi kullanarak API'yi çağırabilirsiniz. Bu örnek çağrı, korumalı alan sunucusundaki üye API'sini kullanarak tam finansman kalemi 4413'ü XML biçiminde alır.
Method: GET Accept: application/vnd.orcid+xml Authorization type and Access token: Bearer [stored access token]URI: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/funding/4413
API, mesajın başarıyla alındığını belirtmek için bir 200 OK mesajı döndürür ve finansman öğesinin tam XML'sini döndürür:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<funding:funding put-code="4413" path="/0000-0002-9227-8514/funding/4413" visibility="public" [...] >
[...]
</funding:funding>
Kontrol edebilirsiniz bir öğenin kaynağı Okurken kimin eklediğini bilmek istiyorsanız.
Daha fazla bilgi
Gruplama hakkında bir not
Öğeler üzerinde birlikte gruplandırılmıştır ORCID tanımlayıcılarına göre kayıtlar. Okuduğunuz öğelerin bir grubun parçası olduğunu görebilirsiniz.
Çalıştığı yer ORCID hem tanımlayıcılarına hem de bu tanımlayıcıların eserle olan ilişkisine göre birlikte gruplandırılır. Dört tür ilişki vardır:
- öz: tanımlayıcı yalnızca o esere atıfta bulunur ve aynı tanımlayıcıya sahip diğer eserlerle gruplandırılabilir
- Bir parçası: çalışma, bu tanımlayıcının bir parçasıdır ve diğer çalışmalarla gruplandırılamaz
- Sürüm: bu tanımlayıcılar, çalışmanın alternatif sürümleri için geçerlidir ve self ve tanımlayıcıların sürümü ile gruplandırılabilir
- Tarafından finanse edildi: bu tanımlayıcılar, işin finansmanı için geçerlidir. Bu tanımlayıcılar, gruplandırma çalışmaları için kullanılmaz.
API'miz bunun için XSD'de destek sağlar. Her öğenin, kendi grubu içindeki sırasını gösteren bir görüntüleme indeksi özelliği vardır. En yüksek görüntüleme indeksi, araştırmacı tarafından seçilen tercih edilen öğedir, API aracılığıyla eklenen ve araştırmacı tarafından sıralanmayan öğelerin görüntüleme indeksi 0'dır. Görüntüleme indeksi ayrıca, okuma sırasındaki iş sırasını da belirler. ORCID kayıt.
gruplandırma hakkında daha fazla bilgi için ORCID kayıtlar, lütfen bizim destek makalesi.
İçerik türleri hakkında bir not
ORCID XML ve çeşitli JSON türleri dahil olmak üzere birden çok içerik türünü destekler. API isteklerinize bir "Accept header" ekleyerek tercih ettiğiniz türü isteyebilirsiniz. Buna “içerik müzakeresi” denir.
The ORCID kayıt defteri "içerik görüşmesini" destekler. Bu, makinelerin ve diğer sistemlerin sorabileceği anlamına gelir. ORCID farklı biçimlerde kişi meta verileri için kayıt.
Bu formatlardan biri, JSON-LD'dir. schema.org kelime dağarcığı, özellikle Kişi türü, işler, kuruluşlar ve diğer tanımlayıcılarla bağlantı kurduğumuz. Ayrıca XML, JSON, RDF XML ve kaplumbağayı destekliyoruz ve verilerimize erişimi kolaylaştırmak için Kaynaklar arası kaynak paylaşımını (CORS) uyguladık.
Olmayan üzerine bir not ORCIDs
CURL kullanan bir kullanıcıyı şu şekilde aramak:
curl -iL https://orcid.org/0000-0000-0000-0000
Kullanıcı olsa bile bir 200 döndürür değil var olmak. Bunu önlemek için aramanızda içerik pazarlığını şu şekilde kullanın:
curl -iL -H 'Accept: application/xml' https://orcid.org/0000-0000-0000-0000