Öğretici, bir kimlik doğrulaması için gerekli adımları açıklar. ORCID İD. kullanılarak tamamlanabilir. halka açık or üye API'sı. Bir dosyayı geri almak için gerekli adımları gözden geçirir. Doğrulanmış ORCID iD, daha sonra sisteminizin veritabanında saklanabilir. İki seçenek vardır: 3 aşamalı OAuth (uzun süreli güncelleme izinleri için) ve Örtülü OAuth (salt okunur kısa süreli izinler için).
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.
Yönlendirme URL'lerinizi kaydedin
Oturum açtıktan sonra kullanıcılar, müşteri kaydının bir parçası olarak belirttiğiniz bir URL'ye gönderilir.
Yönlendirme URI'leri nedir ve nasıl kullanılır?
Yönlendirme URI'leri, OAuth kimlik doğrulama hizmetimiz tarafından bir güvenlik önlemi olarak kullanılır. ORCID yalnızca kimlik doğrulaması yapan kullanıcıları, kimlik doğrulama talep eden istemci tarafından kaydedilen URI'lere gönderir. Bu, hizmetlerin birbirinin kimliğine bürünmesini engeller.
Unutmayın ki yalnızca HTTPS URI'leri üretimde kabul edilir. HTTP URI'lerini kullanarak test edebilirsiniz ancak kayıt olmanız gerekir HTTPS URI'leri üretim üyesi API kimlik bilgileri için başvurduğunuzda.
Yönlendirme URI'lerini nasıl eşleştiririz?
- Alt alan adlarını ayrı URI'ler olarak kaydetmeniz GEREKİR. https://anythingelse. Thirdparty.com çalışmayacaktır.
- Yol da dahil olmak üzere tüm yönlendirme URI'lerinin tam olarak kaydedilmesi önerilir, çoğu üçüncü tarafın yaptığı şeydir ve en güvenli seçenektir.
- İstemci uygulaması, yalnızca ana bilgisayar adı olan bir yönlendirme uri'si ile kayıtlıysa, o ana bilgisayardaki herhangi bir yönlendirme uri'si kullanılabilir. Örneğin, aşağıdaki yönlendirme uri'si kayıtlıysa: https://thirdparty.com o zaman aşağıdaki tüm yönlendirme_uris çalışacaktır:
- https://thirdparty.com/oauth/callback1
- https://thirdparty.com/callback2
- https://thirdparty.com/anything-else-as-long-as-the-host-is-the-same
Ancak, https://anythingelse. Thirdparty.com çalışmayacak. Sen ZORUNLU alt etki alanlarını ayrı URI'ler olarak kaydedin.
Yönlendirme URI'm yanlışsa ne olur?
Kimlik doğrulaması için gönderilen kullanıcılar ORCID yanlış yönlendirme URI'leri ile şuna benzer bir hata mesajı görürsünüz:
Üyeler için yönlendirme URI'lerini yönetme
Üye API'sini kullanıyorsanız ve yönlendirme URI'lerinizde herhangi bir değişiklik yapmanız gerekiyorsa, lütfen Etkileşim Ekibimizle iletişime geçin.
Genel istemciler için yönlendirme URI'lerini yönetme
Herkese açık API'yi kullanıyorsanız, sizinle ilişkili yönlendirme URI'leri listenizi güncellemek için aşağıdaki adımları izlemeniz gerekir. ORCID genel API istemci kimliği. Aşağıdaki adımları izleyerek bunu yapabilirsiniz:
- Giriş yapın ORCID kayıt
- Sağ köşedeki adınıza tıklayın
- Geliştirici araçlarını seçin
- Müşteri adının yanındaki düzenle kalemini tıklayın
- Mevcut bir yönlendirme URI'sini düzenleyin veya "Başka bir yönlendirme URI'si ekle"yi tıklayın, mevcut bir yönlendirme URI'sini düzenleyin
- Değişikliklerinizi yaptıktan sonra kaydet simgesine tıklamanız gerekir.
Yalnızca HTTPS URI'leri üretimde kabul edilir. http URI'lerini kullanarak test edebilirsiniz ancak üretim üyesi API kimlik bilgileri için başvurduğunuzda HTTPS URI'lerini kaydetmeniz gerekecektir.
OAuth'u uygula
Aşağıda, tarafından desteklenen OAuth'un üç 'çeşitini' açıklıyoruz. ORCID. Çoğu programlama dilinde, entegrasyonu kolaylaştıran OAuth ve/veya OpenID kitaplıkları bulunur.
3 aşamalı OAuth
Bu, bir kullanıcının kimliğini doğrulamanın standart yoludur. ORCID iD ve kimliği doğrulanmış güncelleme izinlerinin yanı sıra uzun süreli güncelleme izinleri elde etmek için kullanılabilir. ORCID İD.
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.
Örtülü OAuth
Bu, bir kullanıcının kimliğini doğrulamanın tarayıcı merkezli yoludur. ORCID iD güncelleme izinleri gerektirmeyen tarayıcı tabanlı uygulamalar tarafından kullanım için.
Örtülü OAuth, sunucu tarafı bileşenleri olmayan veya kullanmak istemeyen sistemler tarafından kullanılmak üzere tasarlanmış daha hafif bir OAuth sürümüdür. Örtük OAuth, yalnızca javascript kullanılarak tamamen tarayıcıda uygulanabilir. Üyeler ve üye olmayanlar tarafından kullanılabilir ve şu şekilde çalışır:
- Özel bir bağlantı oluşturursunuz
- Tıklandığında, kullanıcı şu adrese gönderilir: ORCID
- ORCID kullanıcıdan i imzalamasını ister
- ORCID kullanıcıdan uygulamanıza izin vermesini ister
- ORCID ile kullanıcıyı sisteminize geri gönderir. ORCID kimlik, bir erişim belirteci ve bir id jeton.
- Sisteminiz, kimliği doğrulanmış verileri ayıklar ve depolar ORCID iD yanıttan.
Güvenlik nedenleriyle örtük OAuth kullanılırken, ORCID güncelleme izinlerine sahip erişim belirteçlerini döndürmez.
örtük akış
Örtülü akış, istemcilerin başlatmak için gizli anahtarlarını kullanmalarına gerek kalmayacak şekilde tasarlanmıştır. ORCID oturum açın. Güvenlik, istemcileri kayıtlı yönlendirme_url'leriyle sınırlayarak sağlanır. Bu daha düşük güvenlik seviyesi şu anlama gelir: ORCID örtülü akış kullanılırken yalnızca /authenticate ve openid kapsamlarını destekler. Jetonlar da kısa ömürlüdür ve 10 dakikalık bir ömre sahiptir. Bu akış, örneğin telefon uygulamaları veya tek sayfa javascript web uygulamaları gibi bir arka uç sunucuya erişimi olmayan istemci tarafı uygulamaları için önerilir.
https://localhost/#access_token=24c11342-f5da-4cf9-94a4-f8a72a30da00&token_type=bearer&expires_in=599&tokenVersion=1&persistent=false&id_token=eyJraWQiOiJxYS1vcmNpZC1vcmctcjlhZmw3cWY2aG2c5bmdzenU1bnQ3Z3pmMGVhNmkiLCJhbGciOiJSUzI1NiJ9.eyJhdF9oYXNoIjoiMW52bXZBbVdwaVd0Z3ZKZW1DQmVYUSIsImF1ZCI6IkFQUC02TEtJSjNJNUIxQzRZSVFQIiwic3ViIjoiMDAwMC0wMDAyLTUwNjItMjIwOSIsImF1dGhfdGltZSI6MTUwNTk4Nzg2MiwiaXNzIjoiaHR0cHM6XC9cL29yY2lkLm9yZyIsIm5hbWUiOiJNciBDcmVkaXQgTmFtZSIsImV4cCI6MTUwNTk4ODQ2MywiZ2l2ZW5fbmFtZSI6IlRvbSIsImlhdCI6MTUwNTk4Nzg2Mywibm9uY2UiOiJ3aGF0ZXZlciIsImZhbWlseV9uYW1lIjoiRGVtIiwianRpIjoiY2U0YzlmNWUtNTBkNC00ZjhiLTliYzItMmViMTI0ZDVkNmNhIn0.hhhts2-4-ibjXPW6wEsFRaNqV_A-vTz2JFloYn7mS1jzQt3xuHiSaSIiXg3rpnt1RojF_yhcvE9Xe4SOtYimxxVycpjcm8yT_-7lUSrc46UCt9qW6gV7L7KQyKDjNl23wVwIifpRD2JSnx6WbuC0GhAxB5-2ynj6EbeEEcYjAy2tNwG-wcVlnfJLyddYDe8AI_RFhq7HrY4OByA91hiYvHzZ8VzoRW1s4CTCFurA7DoyQfCbeSxdfBuDQbjAzXuZB5-jD1k3WnjqVHrof1LHEPTFV4GQV-pDRmkUwspsPYxsJyKpKWSG_ONk57E_Ba--RqEcE1ZNNDUYHXAtiRnM3w
Our bakın teknik döküman daha fazla bilgi için.
Açık Kimlik
OpenID, OAuth üzerine inşa edilmiştir ve bazı ek özellikler sunar.
OpenID Connect 1.0, OAuth 2.0 protokolünün üzerinde basit bir kimlik katmanıdır. Mevcut OAuth kimlik doğrulama akışlarını tamamlar ve kullanıcılar hakkında istemcilere iyi tanımlanmış bir şekilde bilgi sağlar.
OpenID connect, OAuth'u uygulamanın ve kimliği doğrulanmış kullanıcılar hakkında bilgi paylaşmanın standartlaştırılmış bir yoludur. Kullanılacak hizmetleri yapılandırmak artık mümkün olacak ORCID Diğer standartlarla uyumlu OpenID bağlantı sağlayıcılarının yanı sıra "kutudan çıkar çıkmaz". OpenID connect ayrıca paylaşılabilirlik sağlar ID kullanarak kimliği doğrulanmış bir kullanıcıyı kanıtlayabilen imzalı nesneler olan belirteçler ORCID belirli bir zamanda Bu belirteçler, kullanıcı oturumlarını sürdürmek için kullanıcı arabirimi öğeleri tarafından kullanılabilir.
ORCID OAuth yetkilendirme kodu akışının bir uzantısı olan Temel OpenID Sağlayıcı uyumluluk profilini destekler. ORCID ayrıca "/authenticate" ve "openid" kapsamları için örtük belirteç akışını da destekler.
Bu demektir ki, ORCID:
- Yerleştirmeler imzalandı id 'openid' kapsamıyla oluşturulan yetkilendirme kodları için belirteç yanıtlarındaki belirteçler
- "Token" veya "token id_token" yanıt_tipleri ve "openid" kapsamı kullanılırken örtük akışı destekler.
- "openid" kapsamını içeren yetkilendirme istekleri için "prompt", "nonce" ve "max_age" parametrelerini destekler.
- Openid Connect keşfini ve userinfo uç noktalarını destekler
- 'openid' kapsamını içeren yetkilendirme istekleri için üye API'sini kullanan entegratörler için 'amr' alanını destekler. Bu, bir kullanıcının iki faktörlü kimlik doğrulama kullanarak kimliğini doğrulayıp doğrulamadığını keşfetmek için kullanılabilir.
Bir OpenID Connect kimlik doğrulaması başlatmak, normal bir OAuth kimlik doğrulamasıyla aynı şekilde çalışır. Gereken tek şey, istemcinin 'openid' kapsamını istemesidir. /authenticate kapsamını kullanıyorsanız, bunu openid ile değiştirin, çünkü kimlik doğrulama ve openid aynı yetkiye sahiptir, yalnızca biri veya diğeri kullanılmalıdır. Başka kapsamlar kullanıyorsanız, talep edilen kapsamlar listesine openid'i ekleyin. 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.
'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.
Our bakın teknik döküman daha fazla bilgi için.
Kullanarak kimliği doğrulanmış iD'leri toplayın ORCIDOAuth Java Script Widget'ı
ORCID basit sağlar Java Komut Dosyası widget'ı kimlik doğrulaması elde etmek için kullanılabilecek ORCID OpenID Connect ile OAuth kullanan kimlikler.
Widget'ın örtük OAuth kullandığını ve dolayısıyla herhangi bir yazma izni toplamadığını lütfen unutmayın. Bu, kayıtları güncellemek isteyen üye entegrasyonları için uygun olmadığı anlamına gelir. Lütfen eğitimimize bakın Veri ekleme ve güncelleme ORCID Kayıtlar.