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.
Yetkilendirme bağlantısını oluşturun ve yetkilendirme kodunu alın
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
Yetkilendirme kodunu bir ORCID iD ve erişim belirteci
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.