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: Abyste měli přístup k vývojářským nástrojům, musíte ověřit svou e-mailovou adresu. Pokud jste dosud neověřili svou e-mailovou adresu, budete k tomu v tomto okamžiku vyzváni. - Klikněte na „Registrovat zdarma ORCID veřejné API“.
- Po zobrazení výzvy si přečtěte podmínky služby a přijměte je.
Zaregistrujte aplikaci
- Po odsouhlasení podmínek služby budete přesměrováni zpět do Vývojářských nástrojů (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools). Vyplňte předložený formulář a zaregistrujte novou žádost.
- 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).
- webová stránka: Web, který může uživatel navštívit, aby se dozvěděl více o vaší aplikaci. Toto se zobrazí v jejich Seznam důvěryhodných organizací.
- Popis: 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ř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.
- 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, kterou doporučujeme. Další informace o URI přesměrování naleznete v našem FAQ
- Veřejné aplikace API musí mít zaregistrovaný alespoň jeden URI přesměrování
- Pro testování můžete automaticky přidat URI Google OAuth Playground kliknutím na „+Google OAuth2 Playground“ v části Testovat URI přesměrování nebo ORCID Public API Swagger kliknutím na „+ORCID veřejné rozhraní naparování “.
- Pro více informací viz O přesměrování URI.
- Kliknutím na ikonu Uložit v dolní části formuláře vygenerujete přihlašovací údaje rozhraní API.
- Chcete-li zobrazit přihlašovací údaje rozhraní API, klikněte na Zobrazit podrobnosti.
- Vaše přihlašovací údaje API - klient ID a Client Secret - jsou zobrazeny těsně pod vašimi přesměrovanými URI. Pod vašimi pověřeními jsou ukázkové adresy URL a volání API s předvyplněnými přihlašovacími údaji.
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.