Začínáme s integrací

Můžeš vyžádat si přihlašovací údaje člena API v karanténě k vytvoření a testování vaší aplikace. Tyto přihlašovací údaje vám umožňují volat do prémiového člena API sandboxu pro čtení, zápis a aktualizaci ORCID evidence. Přístup do testovacího prostředí karantény je volně k dispozici komukoli, i když nejste ORCID členské organizace.

Pozor: Pokud používáte ORCID certifikovaný systém poskytovatelů služeb, který již podporuje ORCID, nemusíte se registrovat pro přihlašovací údaje sandbox API, pokud si nepřejete vyzkoušet ORCID integrační funkce v rámci prostředí Sandbox. 

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

Sandbox server pouze odesílá e-maily 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í.

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.

Třínohé (autorizační kód) obory

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 rozsah se používá k zápisu, aktualizaci a mazání položek v sekcích přidružení, financování, prací, odborných činností, výzkumných zdrojů a odborných posudků 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, vyhledejte ORCID záznamy nebo ke čtení souhrnných informací (pouze pro členské API). Tento rozsah je dostupný na Member nebo Public 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é.

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 pro zobrazení iD a správně aktualizovat. Uložte jej spolu s informacemi výzkumníka, které se vrátí v odpovědi výměny tokenů. Naše doporučení je uložit celý 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. Přístupové tokeny jsou platné přibližně 20 let nebo dokud je uživatel neodvolá. Doporučujeme také uložit rozsah tokenu, platnost tokenu a obnovovací tokeny. Obnovovací tokeny lze v případě potřeby použít k vytvoření nových přístupových tokenů se stejnými nebo omezenými rozsahy. Uložte data přístupového tokenu společně s informacemi o výzkumníkovi.
• Přijměte a uložte vložte kódy : Každá položka, kterou přidáte do ORCID Registr bude vrácen s vloženým kódem ORCID API. Uložte si tento 6místný 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, aktualizovat nebo smazat.
• Pokud interakce neproběhne podle očekávání, poskytněte chybové zprávy a kontakt na podporu.

Žá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 pro zapojení/vedoucí konsorcia 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ích postupů a také zkontrolovat, zda všechny integrace splňují naše osvědčené postupy a minimální požadavky na spuštění.

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:

1. 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. 
2. 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.
3. Screencast nebo snímky obrazovky: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 nemohli vidět ze strany uživatele, jako je používaná verze rozhraní API a způsob ukládání dat.

Žá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. Pokud používáte systém dodavatele, který není na seznamu ORCID Certifikovaní poskytovatelé služeb, vaše integrace bude muset projít procesem kontroly, aby bylo zaručeno, že minimální požadavky na integraci a osvědčené postupy jsou splněny. 

Můžete kontaktovat svého necertifikovaného poskytovatele služeb a přímo od něj získat důkaz, že jsou splněna minimální kritéria. Tento důkaz budete muset zaslat na ORCID Engagement team nebo váš vedoucí konsorcia.

Existuje několik způsobů, jak tento důkaz sdílet:

1. Screencast nebo snímky obrazovky: 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 nemohli vidět ze strany uživatele, jako je použitá verze rozhraní API a způsob ukládání dat.
2. Veřejně dostupná integrační dokumentace: Odešlete veřejně přístupný a aktuální odkaz, který v každém kroku obsahuje jasný popis toho, jak integrace funguje. Stejně jako u možnosti 1 nezapomeňte poskytnout další dokumentaci k ověření čehokoli, co bychom nemohli vidět ze strany uživatele, jako je použitá verze rozhraní API a způsob ukládání dat.

Budete muset vyplnit formulář pro registraci klientské aplikace. Níže je uveden rychlý přehled požadovaných polí:

Jméno organizace: Vaše ORCID název členské organizace

Primární kontaktní e-mailová adresa pro přihlašovací údaje: Tuto e-mailovou adresu použijeme k zaslání přihlašovacích údajů v zašifrovaném e-mailu a k tomu, abychom vás kontaktovali v případě jakýchkoli dotazů nebo chyb ohledně vaší integrace

Sekundární e-mail pro heslo: E-mailová adresa, na kterou vám můžeme zaslat vaše šifrované heslo.

Jméno vašeho klienta: To bude vaše ORCID název členské organizace. Pokud máte více než 1 integraci, připojíme aplikaci k názvu.

Adresa URL domovské stránky vaší aplikace: Zobrazí se jako odkaz v seznamu 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.

Krátký popis vaší klientské aplikace: Tento text se zobrazí na autorizační obrazovce s ikonou otazníku vašim integračním uživatelům. Je vyžadován krátký popis vaší integrace

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. 

• Jsou přijímány pouze HTTPS URI.
• Registrované domény musí 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í. 
• Je potřeba více než 5 URI přesměrování? Uveďte to prosím v poznámkách pro ORCID personál.

Poznámky k ORCID zaměstnanci: Toto pole použijte ORCID zaměstnanci vědí něco dalšího o vašem požadavku nebo vaší integraci

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.