ORCID integrace používají „3 legged OAuth“ k autentizaci uživatelů a vyžádání povolení k interakci s jejich záznamy. Jakákoli integrace může požádat o oprávnění ke čtení pomocí veřejného rozhraní API. ORCID Členové mohou pomocí rozhraní API člena požádat o oprávnění k aktualizaci. Funguje to takto:
- Vytvoříte speciální odkaz
- Po kliknutí je uživatel odeslán na adresu ORCID
- ORCID požádá uživatele o přihlášení
- ORCID požádá uživatele o udělení povolení vaší aplikaci
- ORCID odešle uživatele zpět do vašeho systému s autorizačním kódem
- Váš systém vymění tento kód za přístupový token
Přizpůsobená autorizační adresa URL obsahuje informace o vašem klientovi a také „obory“, které určují konkrétní oblasti jejich záznamu, ke kterým chcete přistupovat. Po přihlášení uživatel autorizuje připojení k vašemu systému a je spolu s autorizačním kódem vrácen na vaši vstupní stránku. Tento kód se poté používá k získání jejich ORCID iD spolu s přístupovým tokenem platným pro požadované obory.
Vytvořte autorizační odkaz a získejte a autorizační kód
Autorizační odkaz vytvoříte zadáním klienta pověření API ID a související vstupní stránka (přesměrování URI). Nastavením zvolíte, o která oprávnění budete žádat parametr oboru.
Níže uvedený příklad požaduje povolení ke čtení dat s omezeným přístupem na webu ORCID sandbox testovací server. V reálném světě zobrazíte tento odkaz na svém webu nebo jej zahrnete do e-mailu, když budete žádat uživatele o ověření a autorizaci. Pro účely testování jej však můžete jednoduše vložit do svého webového prohlížeče. Nahraďte data v závorkách údaji o klientovi a odstraňte hranaté závorky!
https://sandbox.orcid.org/oauth/authorize?client_id=[Your client ID]&response_type=code&scope=/read-limited&redirect_uri=[Your landing page]
Jeden uživatel klikl na odkaz a přihlásil se na ORCID a udělená oprávnění jsou přesměrováni zpět na váš web, například takto:
https://[Your landing page]?code=Q70Y3A
Vyměňte autorizační kód za ORCID iD a přístupový token
Okamžitě byste měli vyměnit autorizační kód za ORCID iD a přístupový token. Autorizační kód vyprší po použití. Žádost vypadá takto a nelze provést ve webovém prohlížeči, musí být provedeno vaším serverem.
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 poté vrátí ověřeného výzkumného pracovníka ORCID iD a přístupový token ve formátu JSON:
{"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"}
Ve výchozím nastavení mají přístupové tokeny dlouhou životnost a jejich platnost vyprší 20 let po vydání. Token lze použít několikrát, než vyprší jeho platnost.
Použijte přístupový token
Třínohé přístupové tokeny jsou propojeny s konkrétními ORCID záznam. Chcete-li je použít, zahrňte je do požadavků API, které zadáte ke čtení nebo aktualizaci tohoto záznamu.