ORCID nabízí veřejné API, které umožňuje organizacím, které nejsou ORCID členy k připojení jejich systémů a aplikací k ORCID registru s komunikací mezi stroji. API je klidné API a podporuje XML i JSON.
Veřejné API lze použít pro následující funkce:
- Přihlaste se do systému pomocí ORCID
- Získejte ověření uživatele ORCID iD
- Načíst veřejná data z údajů uživatele ORCID záznam
- Hledat veřejně ORCID údaje z registru
Vývojářům doporučujeme otestovat veřejné API v sandbox testovací server před použitím produkční verze. Níže jsou uvedeny kroky, jak se zaregistrovat pro veřejné pověření API v prostředí Sandbox i Production.
- Přihlaste se do svého ORCID záznam:
Produkční server: https://orcid.org/signin
Testovací server izolovaného prostoru: https://sandbox.orcid.org/signin - Klikněte na své jméno v pravém horním rohu
- klikněte Vývojářské nástroje z možnosti nabídky
Poznámka: Chcete-li získat přístup k nástrojům pro vývojáře, musíte ověřit svou e-mailovou adresu. Pokud jste ještě neověřili svou e-mailovou adresu, budete vyzváni, abyste tak učinili, než se budete moci zaregistrovat pro veřejné přihlašovací údaje API - Přečtěte si a souhlasíte s 'ORCID Podmínky služby veřejného klienta
- Klikněte na „Registrovat pro ORCID veřejné pověření API“.
Vyplnění formuláře Podrobnosti žádosti
- Jakmile se zaregistrujete pro své veřejné přihlašovací údaje API, budete přesměrováni zpět do nástrojů pro vývojáře (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
- Chcete-li zaregistrovat novou žádost, musíte vyplnit předložený formulář s podrobnostmi žádosti.
- Jméno: Název vaší aplikace. Toto se zobrazí uživatelům, když udělí vaší aplikaci oprávnění k získání jejich ORCID iD a zobrazí se v jejich Seznam důvěryhodných organizací. Doporučujeme použít název vaší organizace nebo služby (např. Název deníku).
- Adresa URL aplikace: Web, který může uživatel navštívit, aby se o vaší aplikaci dozvěděl více. To se také zobrazí v jejich Seznam důvěryhodných organizací.
- Popis aplikace: Informace o aplikaci, kterou vyvíjíte, a o tom, jak ji budete používat ORCID iD. Toto se zobrazí uživatelům na obrazovce OAuth.
Přidání Přesměrování URI
Jakmile uživatel autorizuje vaši aplikaci, bude vrácen na URI, které určíte. Tyto identifikátory URI musíte zadat předem, jinak uživatelé integrace zaznamenají chybu.
- Do zobrazeného pole zadejte URI přesměrování
- Pokud potřebujete zadat více než 1 URI přesměrování, klikněte na „Přidat další URI přesměrování“
Upozornění:
- Pouze HTTPS URI jsou přijímány do výroby
- Registrované domény MUST přesně odpovídat použitým doménám, včetně subdomén
- Pokud je to možné, plně zaregistrujte všechny URI přesměrování. Toto je nejbezpečnější možnost a co doporučujeme. Další informace o URI přesměrování naleznete v našem FAQ přesměrování URI
Ukládání aplikace
Jakmile vyplníte formulář žádosti a přidáte své URI přesměrování, můžete svou žádost uložit.
- Klikněte na 'Uložit moji aplikaci a vygenerovat mého klienta ID a tajemství'
Budete přesměrováni zpět na stránku vývojářských nástrojů, která nyní bude obsahovat vaše přihlašovací údaje klienta Public API
Aktualizace přihlašovacích údajů
Provedení změny informací v aplikaci je velmi jednoduché.
- Upravte příslušné informace a poté klikněte na „Uložit aplikaci“
Použijte své přihlašovací údaje
Nyní, když máte svá pověření, je čas začít používat ORCID Veřejné API!
Vezměte prosím na vědomí, že pokud se stanete členem, můžeme přenést vaše přihlašovací údaje do členského API ORCID člen v budoucnosti.
Prohlédněte si naši Skupina uživatelů API témata, kde najdete další informace o nastavení integrace s veřejným rozhraním API. Chcete-li však maximalizovat výhody ORCID, doporučujeme vám spojit ORCID jako organizační člen, která nabízí přístup k další funkcionalitě, osobní asistenci našeho integračního týmu a samozřejmě pomáhá podporovat naši práci.