Bu öğretici, bir web kancasını kurmak ve test etmek için tek tek adımlarda size yol gösterecektir. ORCID kayıt.
Web kancaları değişiklik bildirimleri, ORCID Uygulamaların, genel veriler bir ağ içinde olduğunda bilgilendirilmesini sağlayan premium üye özelliği. ORCID değişiklikleri kaydedin. Bu özellik, premium üyelerin yeni bilgilerden haberdar olmalarını ve hatta bir etkinliğe dayalı olarak kendi sistemlerinde olayları tetiklemelerini sağlar. Gerçek veri alışverişinin, tarafından belirlenen gizlilik seviyelerine bağlı olduğunu lütfen unutmayın. ORCID iD sahibi ve bireyin üye kuruluşa verdiği izinler.
API'yi ve üye API istemci kimlik bilgilerinizi kullanarak, her biri için bir geri arama URL'si kaydedebilirsiniz. ORCID iD izliyorsunuz ve ekranda değişiklikler meydana geldiğinde bu geri arama URL'sini bilgilendireceğiz. ORCID kayıt.
Bir web kancası erişim belirteci edinin
Web kancası özelliğini kullanmak için, web kancaları oluşturmanıza izin veren bir erişim belirteci oluşturmanız gerekir. Bu işlemin yalnızca bir kez tamamlanması gerekir, aynı erişim belirteci daha sonra birden fazla web kancası oluşturmak için kullanılabilir. ORCID Kayıtlar.
Herhangi bir premium üye bir '/webhook' erişim belirteci alabilir. Birden çok kayıt için web kancalarını kaydetmek için tek bir belirteç kullanılabilir. 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.
Aşağıda, erişim belirtecini almak için örnek bir çağrı verilmiştir - yer tutucuları kimlik bilgilerinizle değiştirin (parantezleri çıkardığınızdan emin olun.)
curl -i -L -H "Accept: application/json"
-d "client_id=(your client ID)"
-d "client_secret=(your client secret)"
-d "scope=/webhook"
-d "grant_type=client_credentials"
"https://sandbox.orcid.org/oauth/token"
Daha sonra size aşağıdakine benzer bir erişim belirteci iade edilecektir.
{"access_token":"5eb23750-1e19-47a3-b6f6-26635c34e8ee",
"token_type":"bearer",
"refresh_token":"c7d3d5fd-e4c0-4825-89f2-7cfb4a1cf01e",
"expires_in":631138518,
"scope":"/webhook"}
Bir web kancası kaydedin
Web kancalarına erişim belirtecinizi aldıktan sonra, web kancalarını kaydetmeye başlayabilirsiniz. Bir web kancasını bir web kancasına karşı kaydedebilirsiniz. ORCID iD işlevsellik yalnızca kullanıcılarda bulunan genel verilere baktığından, kullanıcıların izni olmadan ORCID kayıt.
Web kancaları, premium üyeler tarafından herhangi bir kişiye karşı kaydedilebilir. ORCID kayıt defterine kaydedin. Adımlar:
URL'yi kodlayın
İstediğiniz URL'yi URL kodlaması ORCID kullanıcının kaydı güncellendiğinde aramak için. Örneğin aşağıdaki URL:
https://nowhere2.com/0000-0002-7465-2162/updated
olur
https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
URL'yi oluşturun
Şunun için tam URL'yi oluşturun: ORCID URL'si ile başlayan API çağrısı ORCID kaydedin, ardından ‚√∫/webhook‚√π ve çağrılmasını istediğiniz URL'yi ekleyin. Yani https://api.sandbox gibi görünmelidir.orcid.org/{ORCID}/webhook/{URL-KODLANMIŞ-WEBHOOK-URL}
Örneğin, yukarıdaki webhook URL'sini ve ORCID iD 0000-0002-7465-2162, tam URL:
https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
webhook'u kaydettirin
Webhook'unuzu kullanıcılara karşı kaydetmek için webhook erişim belirtecinizi kullanın. ORCID kayıt. Bir HTTP PUT isteği kullanmanız gerekir, ancak isteğin gövdesine hiçbir şey eklememelisiniz.
URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdatedn HEADER: Accept: application/json HEADER: Authorization: Bearer [Your access token]n HEADER: Content-Length: 0n METHOD: PUT
Yanıt bir 201 olmalıdır, ancak geri arama zaten mevcutsa yanıt 204 olacaktır.
HTTP/1.1 201nServer: nginx/1.1.19nConnection: keep-alive Location: https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Frequestb.in%2Fz57lzcz5
webhook çağrısını alma
Bir webhook URL'si kaydettikten sonra, kullanıcı ORCID kayıt güncellendi. Tek bir kullanıcı oturumu için birden fazla aramayı önlemek için kanca bildirimleri her beş dakikada bir gönderilir.
The ORCID Bir kayıt güncellendiğinde kayıt defteri aşağıdaki HTTP çağrısını yapacaktır. İstek, HTTP POST yöntemini kullanıyor ancak isteğin gövdesi boş.
curl -v -X POST https://nowhere2.com/0000-0002-7253-3645/updated
Sunucunuz standart HTTP yanıt kodlarıyla yanıt vermelidir. Bu nedenle, arama başarılı olursa 204 No Content döndürmelisiniz.
HTTP/1.1 204 No Content
Herhangi bir 2xx yanıt kodu, aramanın başarılı olduğu anlamına gelir. 2xx olmayan bir kod döndürürseniz, aramayı beş dakika sonra yeniden deneyeceğiz.
Bir web kancasının kaydını iptal etme
Bir web kancasının kaydını bir ORCID iD artık kendi sisteminizdeki verileri söz konusu belirli sistemle senkronize etmek istemiyorsanız ORCID.
Bir webhook'un kaydını silme URL'si, kaydolma URL'si ile aynıdır. Ancak, HTTP DELETE yöntemini kullanmanız gerekir.
URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
HEADER: Authorization: Bearer [Your access token]
HEADER: Content-Length: 0
METHOD: DELETE
Yanıt şu olmalıdır: 204 No Content
.
HTTP/1.1 204 No Content
Server: Apache-Coyote/1.1
Date: Fri, 05 Apr 2013 12:49:17 GMT