ORCID nabízí několik rozhraní API, která umožňují vašim systémům připojit se k ORCID registru, včetně čtení a zápisu do ORCID evidence. Některé funkce API jsou volně dostupné komukoli (Veřejné API); ostatní jsou k dispozici pouze pro ORCID členské organizace (Členské a prémiové členské API). Kdokoli může libovolně otestovat kterékoli z našich API na našem testovacím serveru izolovaného prostoru.
Než začneš
Na začátku plánování integrace byste měli zvážit:
- Co chcete dělat s ORCID API - navštivte naše Pracovních toků.
- Ať už je vaše organizace už je ORCID člen nebo je plánuje se stát jedním. Pouze ORCID členové mohou přidávat položky do ORCID evidence.
- Ať už používáte systém, který již podporuje ORCID. Pokud ano, může to být stejně jednoduché jako konfigurace systému, se kterým budete pracovat ORCID.
- Jak budete komunikovat se svými výzkumníky o prováděných změnách, co od nich budete potřebovat, výhody pro ně a co budou muset udělat. Navštivte naše Informační zdroje stránka s nápady, jak vybudovat komunikační kampaň kolem vaší nové integrace.
Zaregistrujte se pro přihlašovací údaje karantény a vytvořte test ORCID iD
Vyžadujeme, abyste nejprve vytvořili nástroje, se kterými interagujete ο ORCID pískoviště zabránit ovlivnění jakýchkoli dat v produkčním registru během testování - nebo vašich vlastních systémů.
Můžeš vyžádat si přihlašovací údaje člena API v karanténě k sestavení a otestování vaší aplikace. Tyto přihlašovací údaje vám umožňují volat rozhraní API člena sandboxu, aby bylo možné číst, zapisovat a aktualizovat ORCID evidence. Přístup do testovacího prostředí karantény je volně k dispozici komukoli, i když nejste ORCID členské organizace.
Poznámka: Pokud používáte systém jiného výrobce, který již podporuje ORCID, možná nebudete muset registrovat pověření sandbox API.
Sandbox umožňuje vytvářet testovací uživatelské účty a rozvíjet integraci, aniž byste se museli starat o ovlivnění dat naživo (produkce) ORCID Registr. Sandbox se chová stejně jako výroba ORCID Registrovat se několik výjimek.
Vytvoření testovacího účtu
Aby bylo možné otestovat ORCID API a volání API, jako je čtení a přidávání informací do souboru ORCID záznamu, budete také muset vytvořit test ORCID záznam v karanténě. To lze provést pomocí uživatelského rozhraní, podobně jako ve výrobě ORCID Registr. Jít do https://sandbox.orcid.org/register a zaregistrujte se pro účet.
Mailinátor e-mailové adresy
Sandboxový server odesílá e-maily s upozorněním pouze na adresu Mailinator (@mailinator.com) e-mailové adresy, aby nedocházelo k nechtěnému spamování poštovních serverů. Pokud nepoužijete adresu @mailinator.com, neobdržíte ověřovací e-mail ani upozornění na resetování hesla a k provedení jakýchkoli ručních úprav záznamů v karanténě je vyžadováno ověření. Zjistěte více o jejich bezplatných veřejných schránkách zde. Pokud nechcete používat a Mailinator adresu, poznamenejte si prosím své uživatelské jméno a heslo (protože je budete používat k udělení autorizace vaší aplikaci při testování) a kontaktujte nás s žádostí o pomoc s ověřením.
Mailinator je e-mailová služba, která má veřejnou bezplatnou službu a soukromou placenou službu. Pro testování můžete využít zcela bezplatnou veřejnou službu. Zjistěte více o jejich úrovních zde.
Mailinator je služba třetí strany, kterou nespravuje ani nespravuje ORCID. Před použitím těchto adres doporučujeme zkontrolovat, jak tato služba funguje a její omezení.
Určete potřebná uživatelská oprávnění
Projekt ORCID Member API lze použít ke čtení, přidávání nebo aktualizaci informací o uživateli ORCID záznam - stačí si vyžádat povolení od vašich výzkumníků. Rozsahy, které potřebujete, do značné míry ovlivní, které rozhraní API nejlépe vyhovuje vašemu systému.
Při žádosti o povolení k interakci s ORCID záznam uživatele, určíte jeden nebo více „oborů“. Každý obor umožňuje provádět určité věci, například číst záznam nebo aktualizovat konkrétní část.
3 nohy odkazuje na tři aktéry zapojené do získávání povolení od uživatele; ORCID, váš systém a samotný uživatel.
/ověřit 
Tento rozsah se používá ke shromažďování ORCID iD a číst veřejné informace pouze na záznamu. Všechny ostatní obory se třemi nohami obsahují oprávnění k ověření, takže tento rozsah lze vynechat, pokud požadujete jakýkoli jiný přístup. Tento obor je k dispozici na členské nebo veřejné API.
/ read-limited (pouze členské rozhraní API) 
Tento obor se používá k získání přístupu ke čtení veřejných a omezeně viditelných položek na ORCID záznam. Tento obor je k dispozici pouze v rozhraní API člena.
/ activities / update (pouze členské rozhraní API) 
Tento obor se používá k zápisu, aktualizaci a mazání položek v oddílech přidružení, financování, prací a výzkumu a v recenzních sekcích ORCID záznam. Tento obor je k dispozici pouze v rozhraní API člena.
/ osoba / aktualizace (pouze členské rozhraní API)
Tento obor se používá k zápisu, aktualizaci a mazání položek v jiných částech záznamu, klíčových slov, zemí, výzkumných adres, webů a osobních externích identifikátorů. Tento obor je k dispozici pouze v rozhraní API člena.
otevřený
Tento obor používají integrátoři OpenID, když je vyžadován id_token. Když je zahrnut rozsah openid, registr vrátí id_token uvnitř odpovědi tokenu a udělí klientovi oprávnění pro přístup k koncovému bodu s informacemi o uživateli pro daného uživatele. Tento obor je k dispozici na veřejné a členské API.
Pamatujte, že obor „openid“ nezačíná znakem „/“ jako ten druhý ORCID Rozsahy API. Je to proto, že obor „openid“ není definován ORCID, ale místo toho definováno specifikací OpenID Connect. Přečtěte si prosím naše Dokumentace OpenID Pro více informací.
Více oborů
V rámci jedné interakce lze požádat o více oborů tak, že seznamy oborů uvedete v ověřovací adrese URL s kódovaným prostorem mezi nimi, například scope = / read-limited% 20 / activities / update% 20 / person / update
Kompletní přístup
Pokud chcete plný přístup ke čtení a úpravám záznamu, zahrňte do své ověřovací adresy URL tři obory: / read-limited, / activities / update a / person / update. V adrese URL by se zobrazily jako scope = / read-limited% 20 / activities / update% 20 / person / update
Dvounohé (pověření klienta) obory
U některých činností nemusíte uživatele žádat o povolení. Dvounohé obory OAuth jsou požadovány přímo z ORCID API a nevyžadují, aby výzkumný pracovník udělil povolení. Tokeny s těmito obory jsou platné po dobu 20 let a lze je znovu použít
/ veřejné čtení
Tento obor se používá ke čtení veřejných informací na jednom ORCID iD nebo hledat ORCID evidence. Tento obor je k dispozici na členské nebo veřejné API.
/ webhook
Tento obor umožňuje klientské aplikaci zaregistrovat webhook na ORCID záznam, aby bylo možné přijímat oznámení o aktualizaci záznamu. Tento obor je k dispozici prémiovému ORCID pouze členové. Pokud nejste prémiovým členem, ale chcete tuto funkci otestovat v sandboxu pro vývojáře, prosím Kontakt ORCID Komunita.
- V minulosti ORCID podporovány další obory, které nyní byly vyřazen.
- Můžete zjistit které obory jsou nutné pro přidání nebo aktualizaci konkrétní sekce zde.
Ujistěte se, že můžete data bezpečně uložit
Je důležité, aby váš systém dokázal ukládat informace bezpečným způsobem.
Integrace musí ukládat více než jen ORCID evidence. Váš systém bude muset být schopen:
- Přijměte a uložte ORCID iDs: Váš systém bude muset znát iD z ORCID záznam k aktualizaci. Uložte jej společně s informacemi výzkumného pracovníka. Naše doporučení je uložit úplný https URI: https://orcid.org/0000-0001-5727-2427.
- Přijměte a uložte trvalé přístupové tokeny a obnovovací tokeny: Přístupové tokeny lze použít ke čtení a aktualizaci záznamů a také k označení, že iD byl ověřen. Trvalé tokeny jsou platné přibližně 20 let nebo dokud je uživatel neodvolá. Obnovovací tokeny lze použít k vytvoření nových přístupových tokenů se stejnými nebo omezenými rozsahy. Uložte žetony společně s informacemi o výzkumníkovi. Doporučujeme také uložit rozsah tokenua ‚platnost tokenu.
- Přijměte a uložte vložte kódy (pokud se aktualizuje ORCID záznamů): Každá položka, kterou přidáte do složky ORCID Registr bude vrácen s vloženým kódem ORCID API. Uložte si tento vkládací kód spolu s položkou ve vašem systému, tak zjistíte, kterou položku je třeba přečíst nebo aktualizovat.
- Interakce protokolu: Váš systém by měl zaznamenávat oba hovory uskutečněné na ORCID API a přijaté odpovědi. To je nutné ORCID může pomoci, pokud se problém objeví později.
- Pokud interakce neproběhne podle očekávání, poskytněte chybové zprávy a kontakt na podporu.
Postupujte podle osvědčených postupů
Abychom vašim uživatelům dobře sloužili, ORCID doporučuje dodržovat řadu osvědčených postupů.
Aby bylo zajištěno, že vytvoříte nejlepší možnou integraci pro vaši instituci, výzkumné pracovníky a širší komunitu, doporučujeme vám zvážit následující osvědčené postupy:
- Přizpůsobte uživatelské prostředí: Použijte data, která váš systém uložil, k předvyplnění přihlašovací / registrační obrazovky OAuth. Můžete také zahrnout parametry stavu k identifikaci uživatele ve vašem systému nebo ke změně jazyka zobrazení ORCID.
- Poskytněte pracovní postup uživatelům, kteří popírají vaše oprávnění k systému: Poskytněte uživatelům zprávu, která jasně vysvětluje, co ORCID je důvod, proč váš systém požaduje povolení ORCID zaznamenat, a co s tímto svolením uděláte, a nabídnout možnost znovu udělit svolení.
- Poskytněte uživatelům možnost jejich odebrání ORCID iD a data z vašeho systému: Ve výjimečných případech může uživatel chtít své údaje odstranit iD z vašeho systému, nebo se mohli připojit špatně ORCID iD Zajistěte, aby váš systém současně zrušil všechny aktivní přístupové tokeny.
- Aktualizujte přidané položky, když jsou potřeba opravy, pomocí jedinečného kódu umístění položky.
- Pokud interakce neproběhne podle očekávání, poskytněte svým uživatelům popisné chybové zprávy a kontakt na podporu.
- Zobrazte ORCID logo člena (kontaktujte nás pro jeho obdržení)
- Vytvořte konzistentní uživatelský zážitek přidružením iD ikona s důvěryhodným procesem prosazování. Náš ORCID Pokyny pro značku pro členy a partneryvás provede procesem nastavení zobrazení iD ikona ve vašem systému, stejně jako přehled co dělat a co nezobrazovat ORCID značka.
- Ke kontrole existujících oprávnění použijte přístupový token: Jakmile od uživatele jednou obdržíte oprávnění, neměli byste o něj znovu žádat.
Na podporu sociální složky nabízíme sadu nástrojů Informační zdroje abychom vám pomohli vyvinout kampaň na podporu vaší integrace a komunikovat se svými výzkumníky:
- Co ORCID je.
- Proč váš systém shromažďuje iDs a jak bude váš systém provádět úkoly, jako je aktualizace jejich záznamů.
- Proč budou mít vaši vědci prospěch z vytvoření ORCID iD a připojení jejich ID k vašemu systému.
- Jak ORCID výhody pro širší globální výzkumnou komunitu.
Tuto „knihovnu“ zdrojů budeme neustále budovat na základě zpětné vazby od komunity. Pokud máte nápad na něco, co by vás mohlo zajímat, neváhejte nás kontaktovat.
Přihlaste se pomocí ORCID tým, který předvede, jak vaše aplikace funguje
Než bude vaše integrace spuštěna na internetu ORCID produkční registr, náš Engagement Team dvakrát zkontroluje, zda vše, co jste postavili na karanténě, bude fungovat také na produkci. Pokud používáte systém s vestavěným ORCID podpora, tento krok může být možné přeskočit.
Žádost členských organizací ORCID Vyplnění pověření člena API na produkčním (živém) serveru Formulář žádosti klienta API produkčního člena. Před vydáním pověření produkčního člena API, ORCID Tým provádějící zakázku zkontroluje ukázku vaší integrace v ORCID pískoviště. To nám dává šanci vidět skvělé integrace, které jste vytvořili, a nabídnout vylepšení pracovního toku, stejně jako zkontrolovat, zda všechny integrace splňují naše osvědčené postupy.
Chcete-li poskytnout ukázku svého systému, budete muset nastavit funkční integraci s ORCID pískoviště, že ORCID tým může zobrazit náhled. Existuje několik způsobů, jak sdílet pracovní integraci karantény:
- Doporučená: Živé demo: Kontaktujte nás a naplánujte živou demonstraci. Poskytneme software pro schůzky, který vám umožní sdílet vaši obrazovku a předvést vaši integraci. To nám také dává příležitost dozvědět se více o tom, jak váš systém funguje, a jak vysvětlujete jeho výhody ORCID integraci, abychom vám a vašim uživatelům mohli poskytnout lepší podporu.
- Zkušební místo: Pokud je vaše vývojová stránka veřejná, pošlete nám URL spolu s testovacími údaji (je-li to nutné) pro přístup do vašeho systému a pokyny popisujícími, jak používat váš systém ORCID funkce. Poskytněte další dokumentaci k ověření toho, co bychom z uživatelského konce nemohli vidět, např. Použitá verze API, jaká data jsou uložena ve vašem systému atd.
- Screencast nebo screenshoty (doporučeno pro ORCID- povolené systémy, které vyžadují demonstraci): Odešlete nahrávku nebo sadu snímků obrazovky s popisy jasně vysvětlujícími a demonstrujícími, jak vaše integrace v každém kroku funguje, včetně toho, co se stane, když uživatel odepře přístup nebo odpojí své ID. Nezapomeňte poskytnout další dokumentaci k ověření čehokoli, co bychom nebyli schopni vidět ze strany uživatele, jako je používaná verze API a způsob ukládání dat.¬¨‚‚
Pokud používáte jeden z ORCID-zapnuté systémy, které nevyžadují demonstraci, můžete přímo požádat o produkční pověření člena API. V poznámkách nezapomeňte určit, který systém (a případně verzi) používáte.
Očekáváme, že všechny integrace členů splní řadu požadavků. The ORCID tým zajistí, že tyto požadavky byly splněny jako součást procesu kontroly integrace.
- Použijte OAuth ověřit ORCID iDs (Nepovolit uživatelům hledat nebo psát ORCID ID.)
- Zahrnout ORCID značkové tlačítko nebo odkaz na vašem webu zahájit ověřování iD.
- Prezentujte obrazovku autorizace OAuth podle našich pokyny
- Použijte HTTPS pro přesměrování URI vašeho webu a dále ORCID Volání API
- Přijměte a uložte všechna data vrácená ve výměně tokenů společně s daty uživatele ve vašem systému
- Použijte vhodné dalekohledy a metody žádosti (např. POST volání pro přidání nových informací a PUT volání pro aktualizaci stávajících informací)
- Veřejně zobrazit ověřené ORCID ID. ID by se měla zobrazovat podle našich ochranná známka a iD pokyny k zobrazení.
Nejlepší postupy
Vyžádejte si přihlašovací údaje na produkčním serveru
Jakmile bude vaše integrace zkontrolována, můžete požádat o pověření člena API ORCID tým nebo pokud používáte systém poskytovatele služeb, který má vestavěný ORCID integrace.
Budete muset vyplnit formulář pro registraci klientské aplikace. Níže je uveden rychlý přehled požadovaných polí:
Poznámky k ORCID zaměstnanci: Toto pole použijte ORCID vědět, pokud používáte systém prodejce, byly zkontrolovány integrace atd.
Kontaktní e-mailová adresa: Pověření zašleme na tuto adresu. Měl by to být kontakt, se kterým jsme pracovali na integraci, nebo technický kontakt, který pro vaši organizaci máme.
Kontakt pro příjem PIN pro přístup k pověření: Úplně vám zašleme přihlašovací údaje bezpečným způsobem. Zašleme přístupový kód pro přístup k vašim pověřením API tomuto kontaktu. Musí to být jiný kontakt než předchozí uvedený kontakt.
Krátký popis vaší klientské aplikace: Tento text se zobrazí na autorizační obrazovce s ikonou otazníku vašim uživatelům integrace. Je vyžadován krátký popis vaší integrace.
URL domovské stránky vaší aplikace: Zobrazuje se jako odkaz na seznam důvěryhodných organizací v rámci uživatelů ORCID stránka důvěryhodných stran. Měl by to být odkaz zpět na vaši organizaci nebo na hlavní stránku vaší aplikace.
Přesměrování UA OAuth2 nebo adresy URL zpětného volání pro klienta: Povolené adresy URL ve vaší webové aplikaci, na které budou uživatelé vráceni poté, co k nim povolí přístup ORCID zaznamenat data. Všechny identifikátory URI přesměrování musí být HTTPS pro klienty produkčního (živého) serveru.
Jakmile zadáte požadavek, dojde k manuálnímu procesu, který vám vydá pověření, a dostanete e-mail s klientem iD a tajemství klienta. Tyto požadavky jsou obvykle zpracovány za méně než 48 hodin.
Přeneste svou žádost do ORCID Registr výroby
Jakmile budete mít své přihlašovací údaje, jste připraveni je zveřejnit. Chcete-li otestovat integraci před jejím spuštěním pro veřejnost, použijte vlastní tester ORCID záznam nebo kolega ORCID záznam.
Spusťte - a dejte vědět všem
Zprovoznění aplikace není posledním krokem - budete muset i nadále komunikovat se svými uživateli, aby věděli, že se mohou připojit ORCID iD do vašeho systému rychle a snadno. Efektivní integrace obsahují jak technickou složku (kterou tato příručka popisuje), tak i sociální složku. Vědci musí být informováni o tom, co ORCID je důvod, proč požadujete přístup k nim ORCID záznam a co budete dělat s jejich údaji.
- Vytvořte časovou osu komunikace: Ujistěte se, že o tom vaše zainteresované strany vědí ORCID projekt dobře před spuštěním.
- Použijte kombinaci komunikace shora dolů a zdola nahoru.
- Propagujte své ORCID integrace často a pro různé cílové skupiny.
- Vytvořte místní zdroje k podpoře vašich uživatelů, jako jsou FAQ, libguides, webové stránky, výukové programy a videa.
- Nominujte místní kontaktní osobu pro ORCIDsouvisející otázky.
Na podporu sociální složky nabízíme sadu nástrojů Informační zdroje abychom vám pomohli vyvinout kampaň na podporu vaší integrace a komunikovat se svými výzkumníky:
- Co ORCID je.
- Proč váš systém shromažďuje iDs a jak bude váš systém provádět úkoly, jako je aktualizace jejich záznamů.
- Proč budou mít vaši vědci prospěch z vytvoření ORCID iD a připojení jejich ID k vašemu systému.
- Jak ORCID výhody pro širší globální výzkumnou komunitu.
Tuto „knihovnu“ zdrojů budeme neustále budovat na základě zpětné vazby od komunity. Pokud máte nápad na něco, co by vás mohlo zajímat, neváhejte nás kontaktovat.