Nejčastější dotazy k integraci a API

Sbíráte ověřená ID, když požádáte výzkumného pracovníka, aby se přihlásil pomocí svého ORCID iD. Tento proces používá technologii nazvanou „OAuth“ nebo „SSO“ a měl by být zabudován do vašeho pracovního postupu.

Podívejte se na výukový program API 'Získejte ověření ORCID iD' Více podrobností.

Proces získání oprávnění k přidání nebo aktualizaci údajů o uživateli ORCID záznam používá OAuth, jak je popsáno v našem 3 Časté dotazy týkající se legovaných OAuth, Pouze ORCID Členové mohou pomocí rozhraní API člena požádat o oprávnění k aktualizaci. Jednoduše to funguje takto:

• Váš místní systém vytvoří speciální odkaz
• Po kliknutí je uživatel odeslán na adresu ORCID, přihlásí se a udělí povolení
• 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“
• Token přístupu vám umožňuje aktualizovat záznam uživatele

Položky (práce, zaměstnání, financování, vzájemné hodnocení atd.) Lze přidat do ORCID záznam pomocí ORCID členské API. Potřebujete následující:

• Povolení vědců
• Pověření člena API
• A buď:
  • Prodejní systém, který se integruje s ORCID Členské API
  • Váš vlastní systém, který se integruje s ORCID Členské API

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.

Sbírání ověřeno ORCID ID pro jednotlivce prostřednictvím procesu OAUTH jsou důležitá. Jednotlivci se přihlašují ke svým ORCID účty pomocí své registrované e-mailové adresy a hesla, nebo si mohou vytvořit nový účet a poté autorizovat váš systém k získání jejich ORCID iD. Tím je zajištěno, že získáte správné ORCID iD pro výzkumného pracovníka a že informace v tomto záznamu odrážejí jeho výzkumné činnosti (viz Co je tak zvláštního na přihlášení). 

Můžete usnadnit život uživatelům připojením ověřených informací k jejich uživatelům ORCID evidence. Budete také pomáhat budovat důvěru ve vědeckou komunikaci a udržováním těchto údajů v aktuálním stavu můžete snížit zátěž uživatelů pro vytváření zpráv a zlepšit kvalitu dat. 

ORCID pro výzkumné organizace

Kromě jeho použití jako trvalého identifikátoru pro vaše výzkumné pracovníky, ORCID vám pomůže převzít kontrolu nad tím, jak se název vaší instituce používá v rámci výzkumných systémů. V kombinaci s dalšími trvalými identifikátory ORCID umožňuje vám autoritativně prosazovat přidružení zaměstnanců, fakulty a studentů k vaší instituci. Můžete také použít ORCID API pro příjem oznámení o výzkumných aktivitách v reálném čase, pro automatickou aktualizaci formulářů a sledování kariéry vašich absolventů.

ORCID pro finanční organizace

Vložením ORCID ID ve vašich pracovních postupech financování můžete spolehlivě propojit své granty a programy financování - a ušetřit každému čas a snížit chyby způsobené ručním zadáváním informací. Použitím ORCID ve vašem systému (systémech) můžete hrát svoji roli při budování důvěryhodné výzkumné informační infrastruktury prosazováním spojení mezi jednotlivci a granty, které jim udělujete.

ORCID pro vydavatele

Výzkumní pracovníci jsou jádrem všeho, co dělají vědečtí a výzkumní vydavatelé. Přesné informace o autorech a recenzentech jsou zásadní pro indexování, vyhledávání a objevování, sledování publikací, atribuci financování a využívání zdrojů a podporu vzájemného hodnocení.

ORCID slouží jako informační centrum, které vašim autorům a recenzentům umožňuje spolehlivě se připojit k jejich příspěvkům a sdílet informace z nich ORCID zaznamenávejte při jejich interakci s vašimi publikačními systémy. Shromažďování ID pro všechny vaše autory a recenzenty během publikačního procesu - ať už jde o knihy, časopisy, datové sady, skladby, prezentace, kód nebo řadu dalších děl - umožňuje snadné sdílení informací, zajišťuje, že výzkumní pracovníci mohou poskytnout souhlas ke sdílení, šetří výzkumníkům čas a potíže, snižuje riziko chyb a kriticky umožňuje vědcům získat si zásluhy, které si zaslouží za důležitou práci, kterou dělají.

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

Za účelem testování rozhraní ORCD API a volání API, jako je čtení a přidání informací do 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.

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 oznámení o resetování hesla. Pokud chcete provádět jakékoli ruční úpravy záznamů izolovaného prostoru, je vyžadováno ověření. Pokud si nepřejete použít 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 a požádejte o pomoc s ověřením.

Mailinator je bezplatná služba, kterou neřídí ani neudržuje ORCID. Před použitím těchto adres doporučujeme zkontrolovat, jak tato služba funguje a její omezení. 

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ým nebo omezeným rozsahem. Uložte tokeny společně s informacemi výzkumníka. 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 tento put kód spolu s položkou ve vašem systému - podle toho zjistíte, kterou položku je třeba čí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.

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.

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é přihlašovací údaje 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 a Příjmení: 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: URI pro použití s ​​protokolem OAuth 2.0 - to jsou umístění, na která budou vaši uživatelé posláni po udělení povolení klienta k získání jejich ORCID iD.
  
  Veřejné aplikace API musí mít zaregistrovaný alespoň jeden URI přesměrování a URI musí začínat https. Pro testování můžete automaticky přidat URI Google OAuth Playground kliknutím na „+ Google OAuth2 Playground“ pod Test 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!

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žití 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

Ujistěte se, že vaše integrace dodržuje osvědčené postupy

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 nastavení účtu. 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.

Průvodce vyhledáváním a odkazem jsou integrace, které lze použít k importu položek (hlavně děl) do ORCID Registr. Musí podstoupit testování mezi integrátorem a ORCID před tím, než mohou být uvolněny do prostředí produkčního registru.

V závislosti na vašich odpovědích na níže uvedené otázky může být vaše integrace vhodným kandidátem na vyhledávání a propojení - před zahájením vývoje průvodce vyhledáváním a propojením nás prosím kontaktujte, abychom o tom dále diskutovali. 

• Jaké je cílové publikum pro čaroděje? Například autoři, recenzenti nebo žadatelé o granty na národní, disciplinární nebo globální úrovni
• Jak velké je očekávané publikum?
• Bude sloužit populaci, která je v současné době nedostatečně využívána stávajícími kouzelníky? Například výzkumné příspěvky v konkrétním jazyce nebo oboru, nebo příspěvky nového typu
• Jak zajistíte, aby průvodce poskytoval dobrou uživatelskou zkušenost?
• Jakou uživatelskou podporu budete poskytovat?
• Existuje - nebo bude - ORCID nasměrovat osobu ve vaší organizaci, například produktového manažera, na průvodce?
• Jak to zajistíte ORCID ID jsou ověřena?
• Požíváte - nebo budete - přijímat a zobrazovat ORCID ID na vaší platformě?
• Je vyhledávání na platformě povoleno iDs?

Přečtěte si prosím naše Pracovní postup vyhledávání a propojení pro více informací.

Žá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:

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 demonstrovat 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 výhody vašeho ORCID integraci, abychom vám a vašim uživatelům mohli poskytnout lepší podporu.
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 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 funguje vaše integrace v každém kroku, včetně toho, co se stane, když uživatel odepře přístup nebo odpojí svůj iD. Nezapomeňte poskytnout další dokumentaci k ověření všeho, co bychom od koncového uživatele nemohli vidět, například použitou verzi 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.

Webhooky umožňují prémiovým členům „sledovat“ ORCID záznamy a být informováni o všech změnách.

Pomocí přihlašovacích údajů rozhraní API a klienta prémiového člena mohou prémioví členové zaregistrovat adresu URL zpětného volání pro každého ověřeného uživatele ORCID iD které chtějí sledovat. The ORCID držitel záznamu nemusí organizaci udělit zvláštní povolení k registraci adresy URL, ale skutečná výměna dat je založena na úrovních ochrany soukromí stanovených organizací ORCID iD držák. 

S tímto na místě ORCID oznámí uvedenou adresu URL zasláním požadavku, pokud dojde ke změnám ORCID záznam.

Existuje část biografické části an ORCID záznam: 

Také známý jako: To může zahrnovat zkrácené křestní jméno, varianty včetně iniciál pro jedno nebo více křestních jmen, prostřední jméno (jména), dřívější nebo alternativní jméno (jména) nebo jména v jiné znakové sadě. Každé jméno by mělo být přidáno jako jedna položka. Toto je volné textové pole do 255 znaků. 

Webové stránky: Tato část obsahuje popis (volitelně) a URL webových stránek (povinné)

Země: Sekce Země ORCID Záznam umožňuje výzkumným pracovníkům a členským organizacím přidat jednu nebo více zemí, kde provádějí výzkum nebo které jsou tématem jejich výzkumu. Položky v seznamu zemí pocházejí z mezinárodní normy ISO 3166 pro kódy zemí a oblastí. 

Externí identifikátory (jiná ID): Tuto sekci mohou přidávat pouze členské organizace. Vezměte prosím na vědomí, že ačkoli mnoho organizací pro své výzkumné pracovníky shromažďuje další externí identifikátory, např. ID autorů Scopus, pouze autorita těchto identifikátorů je může autoritativně prosadit. Proto důrazně doporučujeme, aby vaše organizace přidávala pouze identifikátory, které váš systém vytvořil, a které používá k identifikaci výzkumných pracovníků. Tato část obsahuje čtyři komponenty (* označuje povinné pole):

• Typ ID *
• Hodnota ID *
• ID vztah *
• ID URL

Všechny sekce přidružení používají stejnou sadu metadat v API:

• Název organizace:* Název organizace na nejvyšší úrovni (např. „Boston University“, spíše než „Boston University School of Medicine“).
• Město organizace: * Město, kde organizace sídlí. 
• Region organizace: Region, kde má organizace sídlo. 
• Země organizace * země organizace. To by mělo být naplněno dvoupísmenný kód země ISO 3166 Alpha-2.
• Organizace ID (Ringgold, GRID nebo LEI): * Jedinečný identifikátor organizace a jejího zdroje.
• Role / název: Držená pozice nebo udělený titul, který má být udělen.
• Oddělení: Jakékoli členění nadřazené organizace.
• URL: Adresa URL zdroje o přidružení
• Datum zahájení: Datum, kdy začal vztah mezi výzkumným pracovníkem a organizací (lze určit až rok, měsíc a den).
• Datum ukončení: Datum ukončení vztahu mezi výzkumným pracovníkem a organizací (lze určit až rok, měsíc a den)
• Externí trvalý identifikátor popisující přidružení: Jedinečný identifikátor skutečného tvrzení o přidružení

*Označuje povinné pole.

• Titul:* Název práce
• Titulky: Podtitul k dílu
• Přeložený název: Název, pod nímž se práce objevuje v jiném jazyce, je jazyk překládaného názvu zaznamenán jako atribut
• Název deníku: Název větší sbírky, do které dílo patří, například časopis pro články v časopisech nebo kniha pro kapitoly knih. I když je toto označeno názvem časopisu, lze jej použít pro jiná díla
• Stručný popis: Stručný popis nebo abstrakt práce
• Typ citace: Formát, ve kterém je citace uvedena. Toto pole je vybráno ze seznamu obsahujícího následující hodnoty: APA, BIBTEX, CHICAGO, HARVARD, IEEE, MLA, RIS, UNSPECIFIED, VANCOUVER
• Citační hodnota:  Obsah citace
• Typ práce:  Jedná se o typ objektu. Toto pole musí být vybráno z podporované typy práce
• Datum zveřejnění: Datum dokončení práce
• Typ externího ID: * Typ identifikátoru. Toto pole musí být vybráno z podporované identifikátory práce
  • Hodnota externího ID: * Samotný identifikátor
  • Externí-id-url: Adresa URL, na kterou se identifikátor přeloží
  • Vztah externího id: * Identifikátory, které se vztahují pouze na přidávané dílo, budou označeny jako Self. Identifikátory, které se vztahují na větší sbírku, do které tato práce patří, by byly nastaveny na část. Identifikátory, které se vztahují na alternativní verze díla, by byly nastaveny na verzi z. Identifikátory, které se vztahují k financování práce, by byly financovány z.
• Adresa URL práce:  Adresa URL odkazující na dílo
• Přispěvatelé do práce:  Informace o jednotlivcích, kteří práci vytvořili
• Kód jazyka: Jazyk používaný k popisu práce v předchozích polích
• Země: Země, ve které bylo dílo publikováno nebo s nímž je jinak spojeno

* Označuje povinné pole

Existuje mnoho typů výzkumných zdrojů, od reagencií na jedno použití až po mezinárodní spolupráci se specializovanými zařízeními.  ORCID podporuje model na vysoké úrovni, který může odkazovat na další místa pro podrobnosti specifické pro doménu.  

Existují čtyři typy zdrojů na vysoké úrovni:

Kromě typu zdroje, položka zdroje výzkumu v rámci ORCID záznam obsahuje následující informace. * označuje požadované položky

• Název návrhu / registrace: * Toto je hlavní zobrazovací pole pro výzkumné zdroje, např. „Neutron Beam Award“ nebo „Beam time and computing resources“
• ID návrhu / registrace: * Toto je veřejný identifikátor (DOI, PURL atd.) Pro návrh nebo žádost o použití zdroje. V ideálním případě by tento identifikátor měl být trvalý a měl by být vyřešen jako veřejná vstupní stránka s informacemi o návrhu nebo požadavku, jako je databáze ocenění nebo protokol uživatele prostředků. 
• Hostitelé nabídky: * Toto je organizace, která přijímá a zpracovává návrhy nebo žádosti o zdroje. Hostitel nabídky může být stejný jako hostitel zdroje
• Název hostitele nabídky: *
• Hostitelská organizace návrhu iD *  Toto je veřejný identifikátor (jeden z GRID, Ringgold ID, Open Funder ID, LEI) pro organizaci spravující proces návrhu nebo požadavku
• Zdroje):* (až 100)
• Název zdroje: * - např. „Neutron Spallation Source“
• ID zdroje: * - z rozšiřitelného seznamu přijatelných typů PID (např. RRID, DOI, URI)
• Typ zdroje: * - jedna z „infrastruktur“, „sbírek“, „vybavení“ nebo „služeb“
• Hostitelé zdrojů: * Toto je organizace, která spravuje nebo provozuje zdroj, například národní laboratoř, vládní agentura nebo výzkumná univerzita 
• Název hostitele zdroje: * Organizace, které spravují nebo provozují zdroj, obvykle národní laboratoř, vládní agentura nebo výzkumná univerzita.
• ID hostitelské organizace zdroje: * URL návrhu:  Odkaz na návrh
• Datum zahájení návrhu:  Datum zahájení přístupu
• Datum ukončení nabídky:  Datum ukončení nebo ukončení přístupu

* Označuje povinné pole

• Role:* Role jednotlivce v procesu kontroly, kterou lze vybrat z: předsedy, redaktora, člena, organizátora, recenzenta
• Identifikátor skupiny: * Skupina ID který se používá pro účely agregace - u článků v časopisech je výchozím identifikátorem eISSN, který se automaticky vyplní prostřednictvím integrace s databází ISSN. Pokud potřebujete přiřadit jiný identifikátor než ISSN, budete muset vytvořte to dříve.
• Svolávající organizace *: Organizace, která recenzi uspořádala - vydavatel časopisu, organizátor konference, finanční agentura, fakulta atd
  • Identifikátor organizace: Trvalý identifikátor pro svolávající organizaci. V současné době podporujeme identifikátor registru Ringgold, GRID, LEI nebo Crossref Funder. Poznámka: toto není povinné pole, ale doporučujeme vám tyto údaje zveřejnit, pokud je máte k dispozici.
• Zkontrolovat údaje: * Tyto údaje se vztahují k činnosti kontroly a nikoli k tomu, co bylo zkontrolováno
  • Typ: Typ kontrolní činnosti: kontrola nebo hodnocení
  • Datum: Datum dokončení kontroly. Může to být široké (2008) nebo konkrétní (2010-12-10) 
  • Identifikátor recenze: Unikátní, nejlépe řešitelný identifikátor poskytl samotný zdroj kontroly. Pokud recenze není otevřeně k dispozici, doporučujeme, aby neobsahovala identifikovatelné údaje, které lze vysledovat zpět k předmětu kontroly 
• Zkontrolovat URL: Odkaz na reprezentaci recenze nebo záznamu recenze online 
• Informace o subjektu recenze: Ať recenzent recenzoval cokoli
  • Typ předmětu: Typ položky, která byla zkontrolována, např. Článek v časopise, konferenční příspěvek 
    • To zahrnuje: seznam typů prací A seznam typů grantů („Grant“, „smlouva“, „cena“, „odměna za odměnu“) A výzkum - „návrh zdroje“ A „nedefinováno“ 
  • Název předmětu: Název recenzované položky
  • Externí identifikátor subjektu: Jedinečný identifikátor subjektu kontroly, např. Článek DOI 
  • Název kontejneru subjektu: Název objektu, jehož je recenzovaný předmět součástí, např. Konference, ke které byl příspěvek recenzován 
  • URL předmětu: URL subjektu, který byl zkontrolován 

* Označuje povinné pole

• Typ financování: * Typ uděleného financování, Toto pole je vybráno ze seznamu obsahujícího následující hodnoty: Cena, Smlouva, Grant, Plat
• Název financování: * Název položky financování
• Podtitul: Podtitul k položce financování
• Přeložený název: Titul, pod kterým se financování objevuje v jiném jazyce, je jazyk překládaného titulu zaznamenán jako atribut
• Částka: Hodnota ocenění
• Jedinečný identifikátor financování: Přidejte tolik z nich, kolik váš systém ví, protože pomáhá při seskupování ORCID evidence.
  • Typ identifikátoru financování (povoleno je pouze číslo grantu)
  • Hodnota identifikátoru
  • URL identifikátoru (volitelně)
  • Vztah: já / část
    To má indikovat vztah položky financování k identifikátoru. Například pokud je položka financování pro jednu fázi vícedílného grantu a identifikátor je pro vícedílný grant, pak by vztah byl „součástí“; pokud je identifikátor pro jednotlivou fázi, pak by vztah byl „já“.
• Financující agentura (organizace): *  Informace o organizaci, která financování poskytla
  • Název agentury
  • Adresa (město a země)
  • Identifikátor organizace: 

• Datum zahájení: Datum zahájení financování
• Datum ukončení: Datum ukončení financování
• Informace pro přispěvatele:  Informace o jednotlivcích, kteří obdrželi financování
  • ORCID iD: Společnost ORCID iD každého spolupracovníka projektu financování; to by mělo zahrnovat pouze ověřené ORCID ID
  • Role: Povaha příspěvku výzkumného pracovníka

* Označuje povinné pole

Všechny sekce přidružení používají stejnou sadu metadat v API:

• Název organizace:* Název organizace na nejvyšší úrovni (např. „Boston University“, spíše než „Boston University School of Medicine“).
• Město organizace: * Město, kde organizace sídlí. 
• Region organizace: Region, kde má organizace sídlo. 
• Země organizace * země organizace. To by mělo být naplněno dvoupísmenný kód země ISO 3166 Alpha-2.
• Organizace ID (Ringgold, GRID nebo LEI): * Jedinečný identifikátor organizace a jejího zdroje.
• Role / název: Držená pozice nebo udělený titul, který má být udělen.
• Oddělení: Jakékoli členění nadřazené organizace.
• URL: Adresa URL zdroje o přidružení
• Datum zahájení: Datum, kdy začal vztah mezi výzkumným pracovníkem a organizací (lze určit až rok, měsíc a den).
• Datum ukončení: Datum ukončení vztahu mezi výzkumným pracovníkem a organizací (lze určit až rok, měsíc a den)
• Externí trvalý identifikátor popisující přidružení: Jedinečný identifikátor skutečného tvrzení o přidružení

*Označuje povinné pole.

Sekce Pozvané pozice a vyznamenání v ORCID záznam lze použít k rozpoznání lidí v mnoha rolích. 

Všechny sekce přidružení používají stejnou sadu metadat v API:

• Název organizace:* Název organizace na nejvyšší úrovni (např. „Boston University“, spíše než „Boston University School of Medicine“).
• Město organizace: * Město, kde organizace sídlí. 
• Region organizace: Region, kde má organizace sídlo. 
• Země organizace * země organizace. To by mělo být naplněno dvoupísmenný kód země ISO 3166 Alpha-2.
• Organizace ID (Ringgold, GRID nebo LEI): * Jedinečný identifikátor organizace a jejího zdroje.
• Role / název: Držená pozice nebo udělený titul, který má být udělen.
• Oddělení: Jakékoli členění nadřazené organizace.
• URL: Adresa URL zdroje o přidružení
• Datum zahájení: Datum, kdy začal vztah mezi výzkumným pracovníkem a organizací (lze určit až rok, měsíc a den).
• Datum ukončení: Datum ukončení vztahu mezi výzkumným pracovníkem a organizací (lze určit až rok, měsíc a den)
• Externí trvalý identifikátor popisující přidružení: Jedinečný identifikátor skutečného tvrzení o přidružení

*Označuje povinné pole.

Všechny sekce přidružení používají stejnou sadu metadat v API:

• Název organizace:* Název organizace na nejvyšší úrovni (např. „Boston University“, spíše než „Boston University School of Medicine“).
• Město organizace: * Město, kde organizace sídlí. 
• Region organizace: Region, kde má organizace sídlo. 
• Země organizace * země organizace. To by mělo být naplněno dvoupísmenný kód země ISO 3166 Alpha-2.
• Organizace ID (Ringgold, GRID nebo LEI): * Jedinečný identifikátor organizace a jejího zdroje.
• Role / název: Držená pozice nebo udělený titul, který má být udělen.
• Oddělení: Jakékoli členění nadřazené organizace.
• URL: Adresa URL zdroje o přidružení
• Datum zahájení: Datum, kdy začal vztah mezi výzkumným pracovníkem a organizací (lze určit až rok, měsíc a den).
• Datum ukončení: Datum ukončení vztahu mezi výzkumným pracovníkem a organizací (lze určit až rok, měsíc a den)
• Externí trvalý identifikátor popisující přidružení: Jedinečný identifikátor skutečného tvrzení o přidružení

*Označuje povinné pole.

ORCID umožňuje přidání několika typů děl. Níže je uveden seznam typů prací, které jsou aktuálně podporovány, což je do značné míry v souladu s výstupním standardem CASRAI.

Publikace

Konference

Duševní vlastnictví

Ostatní

An ORCID Záznam může obsahovat informace o práci výzkumného pracovníka, přidružení, financování, vzájemném hodnocení a další.

Položky zapnuty ORCID záznamy lze rozdělit na tvrzení které spojují ORCID Držitel iD s aktivitou nebo přidružením. Tato tvrzení lze přidat do ORCID záznam provedený výzkumným pracovníkem, který záznam vlastní, nebo systémy, k nimž výzkumný pracovník udělil povolení. Říkáme entitě, která přidala tvrzení k ORCID zaznamenat zdroj.

Příklady

V souladu s našimi zásadami transparentnosti a otevřenosti se domníváme, že je důležité vidět zdroj tvrzení - kdo tyto informace do záznamu přidává. Takto to děláme:

1. Když výzkumný pracovník (nebo jejich pověřený důvěryhodný jedinec) přidává k jejich záznamu tvrzení, ORCID automaticky zaznamená tuto osobu jako zdroj
2. Když systém schválený výzkumníkem přidá tvrzení k záznamu, ORCID automaticky zaznamená vlastníka systému (an ORCID jako zdroj  

Zobrazíme název zdroje v uživatelském rozhraní a zpřístupníme jej (s jeho jedinečným identifikátorem) v API:

Pracovní postupy výzkumu informací však mohou být komplikovanější a skutečný zdroj tvrzení může být neúmyslně zakryt tím, že jeden systém přidá položku jménem osoby nebo jiného systému. Abychom zajistili transparentnost, musíme rozlišovat mezi tím, kdo vytvořil spojení mezi osobou a položkou, a kdo přidal položku do záznamu. Jak je uvedeno výše, kdokoli přidá položku do ORCID záznam je zdroj; kdokoli vytvoří spojení mezi ORCID iD a položka je původ tvrzení.

Například:

1. Výzkumník importuje data do svých ORCID záznam ze systému, například z Průvodce vyhledáváním a propojením. Výzkumník dělá tvrzení spojující jejich iD s položkou, takže jsou původ tvrzení; zatímco systém je entita přidávající tvrzení do ORCID záznam - zdroj
2. Výzkumník interaguje se systémem A (dále jen "systém") původ tvrzení), který k aktualizaci využívá služby poskytované systémem B. ORCID záznamy, díky čemuž je systém B zdroj

Doporučujeme naší komunitě, aby se zapojila do kroků k uchování a sdílení informací o původu tvrzení, aby každý mohl mít prospěch z vidění zdroje.

Pro více informací, naleznete na:

• Cesty k zajištění tvrzení: Co jsou zač a proč jsou důležité?
• Plány pro povolení více tvrzení v systému Windows ORCID registr

Pracuje v ORCID jsou seskupeny na základě jejich identifikátorů a vztahu těchto identifikátorů k práci. Existují tři typy vztahů:

• Vlastní: identifikátor odkazuje pouze na toto dílo a lze jej seskupit s jinými pracemi, které mají stejný identifikátor
• Část: práce je součástí tohoto identifikátoru a nelze ji seskupit s jinými pracemi
• Verze: tyto identifikátory platí pro alternativní verze díla a lze je seskupit podle sebe a verze identifikátorů
• Financován: tyto identifikátory se vztahují na financování díla. Tyto identifikátory se nepoužívají pro seskupování děl.

Naše API k tomu poskytuje podporu v XSD. Každá položka má atribut indexu zobrazení, který označuje její pořadí v rámci její skupiny. Nejvyšší index zobrazení je preferovaná položka vybraná výzkumným pracovníkem, položky přidané prostřednictvím API, které výzkumník nezařadil, mají index zobrazení 0. Index zobrazení také určuje pracovní pořadí při čtení ORCID záznam.

Další informace o seskupování na ORCID záznamy, viz naše článek podpory.

Přečtěte si prosím naše seznam podporovaných identifikátorů pro V3.0 API. Příležitostně přidáváme nové typy na žádost ORCID členové, kteří by je chtěli použít při přidávání položek do registru.

ORCID podporuje použití  Identifikátory GRID, Identifikátory organizace Ringgold, Identifikátory právnických osob (LEI) a Registr křížového funderu identifikátory k nejednoznačnosti organizací v EU ORCID evidence. 

Další informace viz Práce s identifikátory organizace

Zavedli jsme nové pole generované systémem, které vyjadřuje externí identifikátory (DOI, PMCID, PMID, ArXiv, Bibcode, ISSN a ISBN) v normalizovaném formátu pro účely shody a seskupování. Normalizace se provádí na základě pravidel typu identifikátoru a může zahrnovat nastavení všech znaků alfa na malá písmena nebo transformaci mezer, pomlček, teček a dalších znaků, které lze považovat za ekvivalentní. Podle potřeby také přidává standardní předpony a přípony. Například, https://doi.org/10.1/123, 10.1 / 123, a https://dx.doi.org/10.1/123 se v tomto poli zobrazí jako https://doi.org/10.1/123. Stávající hodnota identifikátoru je nezměněna.

Pole přispěvatelů v dílech a financování umožňuje integraci členů, aby uvedli seznam výzkumných pracovníků, kteří spolupracovali na díle nebo jsou účastníkem financovaného projektu. 

U financování i prací je možné zahrnout přispěvatele ORCID iD vedle role. Doporučujeme přidat přispěvatele ORCID iDs pouze v případě, že jste ověřili ORCID iD nebo shromáždili ORCID iD ze zdroje, který jej ověřil. Lze přidat více rolí.

Sekvence přispěvatelů se používá k označení, kde by se v seznamu přispěvatelů měla objevit jména spolupracovníků nebo jiných přispěvatelů. 2 možnosti, které podporujeme, jsou:

• Jméno
• Další

Role pro práce API 2.0

Níže je uveden seznam podporovaných rolí přispěvatelů pomocí API 2.0.

• autor
• postupník
• editor
• židle nebo překladatel
• spoluřešitel
• spoluvynálezce
• Absolvent
• jiný vynálezce
• vrchní vyšetřovatel
• postdoktorandský výzkumník
• pomocný personál

Role pro práce API 3.0

S API 3.0 můžete přidat výše uvedené role a další role CRedIT. CRediT taxonomie se skládá z 14 typů příspěvků do vědecké práce, spolu s pokyny, jak lze tyto role přiřadit.

Níže je uveden úplný seznam s hodnotou uživatelského rozhraní a hodnotou metadat. Hodnota metadat je adresa URL podle doporučení implementace NISO 'CRediT by měl být kódován v JATS xml v1.2, popsaném prostřednictvím tohoto odkazu: https://jats4r.org/credit-taxonomy. "

Při přidávání rolí prostřednictvím rozhraní API bude přijata pouze adresa URL.

Příklad metadat přispěvatele do práce:

<work:contributor>
            <common:contributor-orcid>
                <common:uri>https://orcid.org/0000-0001-5109-3700</common:uri>
                <common:path>0000-0001-5109-3700</common:path>
                <common:host>orcid.org</common:host>
            </common:contributor-orcid>
            <work:credit-name>Laure L. Haak</work:credit-name>
            <work:contributor-attributes>
                <work:contributor-sequence>first</work:contributor-sequence>
                <work:contributor-role>author</work:contributor-role>
            </work:contributor-attributes>
        </work:contributor>

Úlohy financování

• vést
• vést
• podporováno
• jiný příspěvek

ORCID poskytuje pole pro bezplatné citování textu, aby mohli vědci snadno zadávat informace v textovém formátu. Důrazně však doporučujeme všem uživatelům API, aby přidávali citace do BibTeXu, který je strojově čitelný. Ctihodný formát, i přes starší datování na internetu, lze transformovat do požadovaného formátu pomocí integrací a autorů. Je podporován většinou referenčních manažerů a publikačních platforem

Další informace o BibTeXu najdete na https://www.bibtex.org.

Každý autor, u kterého jeho vydavatel používá Crossref pro registraci DOI, může těžit z integrace Crossref auto update.

Vydavatelé musí zahrnout ověřené ORCID ID pro jejich autory v rámci metadat zaslaných Crossrefu při registraci DOI.

Crossref poté požádá autora o povolení prostřednictvím oznámení jeho autorovi ORCID doručené pošty aktualizovat ORCID záznam s touto publikací a všemi novými publikacemi od kteréhokoli vydavatele.

Více informací naleznete na: https://www.crossref.org/community/orcid/

Každá položka v ORCID iD je přiřazen put kód, který jej jednoznačně identifikuje. Při čtení celého záznamu nebo sekce lze put kód najít jako atribut položky. Když volání konkrétní položky v záznamu, put kód se používá k identifikaci položky. Put kódy jsou jedinečné v rámci typu položky, na kterou odkazují. Pomocí tohoto příkladu pracuje pouze jedna v ORCID Registr bude mít put kód 733535, ačkoli 733535 může být také použit jako put kód pro položku financování nebo klíčové slovo

Jako výhodu ORCID členství, mohou organizace požádat ORCID na podporu dalších typů PID v ORCID Registr. Například člen může požadovat, abychom přidali podporu pro PID, které používají pro identifikaci vzorků nebo datových sad v jejich geologické databázi. To umožňuje propojení mezi vzorky a lidmi, kteří je shromáždili. A protože všechny nové typy PID, které přidáme, musí být přinejmenším rozlišitelné a nejlépe FAIR, jsou tyto odkazy jednoznačné, trvalé v čase a použitelné - ve prospěch výzkumného pracovníka, členské organizace a širší komunity.

Přidání vašeho PID!

Jako komunitní organizace to chceme zajistit ORCID podporuje PID používané našimi členy. Udržujeme kompletní seznam existujících identifikátorů podporovaných v registrua pozvat ORCID členové k použití tato forma požádat o další PID. Naším cílem je reagovat na vaši žádost co nejdříve.

ORCID má samostatnou část v ORCID záznam zaznamenává informace o kvalifikaci, akreditaci, osvědčeních a odznakech.

Každá kvalifikační položka bude vždy obsahovat:

• Titul kvalifikace
• Organizace poskytovatele ID (např. GRID ID)
• Datum přidání do ORCID záznam
• Kdo přidal kvalifikaci (zdroj)

Mohou obsahovat:

• Datum platnosti, včetně data ukončení, pokud platnost kvalifikace vyprší
• Kvalifikační trvalé ID identifikující typ získané kvalifikace.
• URL kvalifikace, která obsahuje člověkem čitelný popis typu získané kvalifikace.
• Trvalé ID kvalifikace. To by mělo odkazovat na online verzi kvalifikačního certifikátu. Může to být existující jedinečný ID nebo jednoduše URI.

Kdokoli s veřejnými nebo členskými pověřeními API může obdržet / veřejné čtení přístupový token. Chcete-li získat token, zavolejte na ORCID Koncový bod tokenu API.

Tento proces se často označuje jako tok OAuth pověření klienta nebo dvoufázový OAuth.

Ukázkové volání k získání přístupového tokenu ke čtení veřejných dat na karanténě - nahraďte zástupné symboly vašimi pověřeními (nezapomeňte odstranit závorky.

URL=https://sandbox.orcid.org/oauth/token
  HEADER: Accept: application/json
  METHOD: POST
  DATA: 
    client_id=[Your public API client ID]
    client_secret=[Your public API secret]
    grant_type=client_credentials
    scope=/read-public

Poté vám bude vrácen přístupový token podobný následujícímu. Vrácený token má dlouhou životnost (nevyprší po dobu přibližně 20 let) a lze jej použít několikrát k načtení veřejných dat z ORCID evidence. 

{"access_token":"4bed1e13-7792-4129-9f07-aaf7b88ba88f","token_type":"bearer",
"refresh_token":"2d76d8d0-6fd6-426b-a017-61e0ceda0ad2","expires_in":631138518,
"scope":"/read-public","orcid":null}

Poznámka: Všechny tokeny s rozsahem / authenticate mají nyní také rozsah / read-public. Pokud používáte pouze obor / authenticate, můžete použít uložené přístupové tokeny ke čtení veřejných dat, aniž byste museli znovu získat přístupový token. 

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é specifikují 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.

Chcete-li získat přístup omezený na čtení, musíte požádat výzkumného pracovníka o povolení. Uděláte to pomocí OAuth. Konkrétně „3nohý OAuth".

Více informací naleznete na Výukový program API: Čtení dat na ORCID záznam

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 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.

Pokud vás zajímá více uživatelů, kteří jsou na stejném počítači a neodhlašují se mezi relacemi, můžete je během procesu OAuth přinutit k opětovnému ověření. Jednoduše zahrňte prompt=login v požadavku OAuth. Můžete také nastavit max_age během několika sekund, aby uživatelé byli nuceni znovu se autentizovat, pokud je jejich relace delší než určitá délka. Podívejte se na naše Dokumentace OpenID Connect pro více informací.

Můžete také uživatele odhlásit ORCID programově pomocí požadavku ajax na https://orcid.org/userStatus.json?logUserOut=true. Pro tento účel nepoužívejte iframe. Pracovní příklad toho je na http://orcid.github.io/test/log-user-out-jsonp.html. Chcete-li zjistit, jak se odhlášení na této stránce nazývá skript, podívejte se na zdroj stránky.

Pokud si přejete odkazovat na naši stránku přihlášení, aby ji uživatelé mohli navštívit, je na adrese https://orcid.org/signout. Opět se prosím nepokoušejte použít to v iframe.

uživatelé mohou kdykoli změnit svůj jazyk zobrazení. K dispozici jsou následující jazyková nastavení:

Lze použít některý nebo všechny parametry:

Příklad adresy URL s těmito parametry je

https://sandbox.orcid.org/oauth/authorize?client_id=APP-NPXKK6HFN6TJ4YYI
&response_type=code
&scope=/authenticate
&redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplayground
&family_names=Finn&given_names=Huckleberry&email=huckle%40mailinator.com

Pokud aktivní přístupový token již existuje se stejnými obory, jaké požaduje vaše autorizační adresa URL OAuth, a uživatel je přihlášen do svého ORCID záznamu, nebudou vyzváni k opětovnému udělení autorizace. Místo toho budou přeneseny přímo do přesměrování URI. Pokud chcete požadovat, aby uživatel udělil autorizaci při každém připojení, použijte vynucená metoda odhlášení

Implicitní OAuth je odlehčená verze OAuth určená k použití v systémech, které nemají nebo nechtějí používat komponenty na straně serveru. Implicitní OAuth lze implementovat zcela v prohlížeči pouze pomocí JavaScriptu. Je k dispozici pro členy i nečleny a funguje 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 pošle uživatele zpět do vašeho systému s jeho ORCID iD, přístupový token a id žeton.
• Váš systém extrahuje a ukládá ověřené ORCID iD z odpovědi.

Z bezpečnostních důvodů při použití implicitního OAuth ORCID nevrátí přístupové tokeny s oprávněním k aktualizaci.

Implicitní tok

Implicitní tok je navržen tak, aby klienti nemuseli k zahájení používat svůj tajný klíč ORCID přihlásit se. Zabezpečení je vynuceno omezením klientů na jejich registrované redirect_urls. Tato nižší úroveň zabezpečení to znamená ORCID podporuje pouze obory / authenticate a openid při použití implicitního toku. Tokeny jsou také krátkodobé s 10minutovou životností. Tento postup se doporučuje pro klientské aplikace, které nemají přístup k serveru typu back-end, například aplikace pro telefon nebo jednostránkové webové aplikace v jazyce JavaScript.

https://localhost/#access_token=24c11342-f5da-4cf9-94a4-f8a72a30da00&token_type=bearer&expires_in=599&tokenVersion=1&persistent=false&id_token=eyJraWQiOiJxYS1vcmNpZC1vcmctcjlhZmw3cWY2aGNnN2c5bmdzenU1bnQ3Z3pmMGVhNmkiLCJhbGciOiJSUzI1NiJ9.eyJhdF9oYXNoIjoiMW52bXZBbVdwaVd0Z3ZKZW1DQmVYUSIsImF1ZCI6IkFQUC02TEtJSjNJNUIxQzRZSVFQIiwic3ViIjoiMDAwMC0wMDAyLTUwNjItMjIwOSIsImF1dGhfdGltZSI6MTUwNTk4Nzg2MiwiaXNzIjoiaHR0cHM6XC9cL29yY2lkLm9yZyIsIm5hbWUiOiJNciBDcmVkaXQgTmFtZSIsImV4cCI6MTUwNTk4ODQ2MywiZ2l2ZW5fbmFtZSI6IlRvbSIsImlhdCI6MTUwNTk4Nzg2Mywibm9uY2UiOiJ3aGF0ZXZlciIsImZhbWlseV9uYW1lIjoiRGVtIiwianRpIjoiY2U0YzlmNWUtNTBkNC00ZjhiLTliYzItMmViMTI0ZDVkNmNhIn0.hhhts2-4-ibjXPW6wEsFRaNqV_A-vTz2JFloYn7mS1jzQt3xuHiSaSIiXg3rpnt1RojF_yhcvE9Xe4SOtYimxxVycpjcm8yT_-7lUSrc46UCt9qW6gV7L7KQyKDjNl23wVwIifpRD2JSnx6WbuC0GhAxB5-2ynj6EbeEEcYjAy2tNwG-wcVlnfJLyddYDe8AI_RFhq7HrY4OByA91hiYvHzZ8VzoRW1s4CTCFurA7DoyQfCbeSxdfBuDQbjAzXuZB5-jD1k3WnjqVHrof1LHEPTFV4GQV-pDRmkUwspsPYxsJyKpKWSG_ONk57E_Ba--RqEcE1ZNNDUYHXAtiRnM3w

Podívejte se na naši technická dokumentace Pro více informací.

Existují různé možnosti registrace identifikátorů URI přesměrování s pověřeními klienta. Vezměte prosím na vědomí, že všechno URI přesměrování pro vaše produkční pověření musí být https. 

Zaregistrujte plně všechny identifikátory URI přesměrování
To je to, co je doporučeno v registračním formuláři a co dělá většina třetích stran.

Zaregistrujte pouze název hostitele
Pokud je klientská aplikace registrována s přesměrováním URI, které je pouze názvem hostitele, lze použít libovolné přesměrování URI u daného hostitele. Například pokud je zaregistrována následující adresa URL přesměrování: https://thirdparty.com

pak budou fungovat všechny následující redirect_uris:

https://thirdparty.com/oauth/callback1
https://thirdparty.com/callback2
https://thirdparty.com/anything-else-as-long-as-the-host-is-the-same

Pokud se rozhodnete, že by tento přístup mohl fungovat pro vás - můžete identifikátory URI zpracovat tak, že zaregistrujete všechny identifikátory URI přesměrování v jedné z vašich domén a poté znovu přesměrujete do příslušné domény.

Zaregistrujte vůbec žádný přesměrovaný uris (pouze karanténa)
Pokud je klientská aplikace nakonfigurována bez redirect_uris, lze použít libovolnou redirect_uri. To je méně bezpečné než zadání redirect_uris. Redirect_uris poskytuje další úroveň zabezpečení, protože brání tomu, aby někdo používal odcizené pověření klienta někoho jiného (protože bychom se nikdy nepřesměrovali na jeho doménu - museli by také mít kontrolu nad DNS uživatele, aby to obešli!). Z důvodu možných rizik povolujeme tuto možnost pouze v rozhraní Sandbox API.

Při registraci pro přihlašovací údaje, pokud si nepřejete registraci požadavku na přesměrování URI “žádné přesměrování URI“V poli poznámek.

Pokud používáte členské rozhraní API a požadujete jakékoli změny svých identifikátorů URI přesměrování, obraťte se prosím na náš Engagement Team.

Mějte na paměti, že přesměrování jsou volitelná data jako součást výměny kódu OAuth. Pokud je zahrnut identifikátor URI přesměrování, musí přesně odpovídat tomu, který byl použit v autorizační adrese URL. Další informace naleznete v našich dalších FAQ v této kategorii.

OpenID Connect 1.0 je jednoduchá vrstva identity nad protokolem OAuth 2.0. Doplňuje stávající toky ověřování OAuth a poskytuje klientům informace o uživatelích dobře popsaným způsobem.

OpenID connect je standardizovaný způsob implementace OAuth a sdílení informací o ověřených uživatelích. Nyní bude možné nakonfigurovat služby k použití ORCID „Out of the box“ spolu s dalšími standardy kompatibilními poskytovateli připojení OpenID. OpenID connect také umožňuje sdílení ID tokeny, což jsou podepsané objekty, které mohou prokázat ověření uživatele pomocí ORCID v určitou dobu. Tyto tokeny mohou být použity prvky uživatelského rozhraní k udržování uživatelských relací.

ORCID podporuje základní profil shody poskytovatele OpenID, což je rozšíření toku autorizačního kódu OAuth. ORCID také podporuje tok implicitních tokenů pro obory „/ authenticate“ a „openid“.

To znamená, že ORCID:

• Vložení podepsáno id tokeny v rámci odpovědí na tokeny pro autorizační kódy generované s rozsahem „openid“
• Podporuje implicitní tok při použití 'token' nebo 'token id_token' response_types a 'openid' oboru.
• Podporuje parametry „prompt“, „nonce“ a „max_age“ pro žádosti o autorizaci, které zahrnují obor „openid“.
• Podporuje zjišťování Openid Connect a koncové body userinfo
• Podporuje pole 'amr' pro integrátory používající členské API pro žádosti o autorizaci, které zahrnují obor 'openid'. To lze použít k zjištění, zda se uživatel ověřil pomocí dvoufaktorového ověřování.

Zahájení ověřování OpenID Connect funguje stejně jako běžné ověřování OAuth. Vyžaduje se pouze to, aby klient požadoval obor „openid“. Pokud používáte obor / authenticate, nahraďte jej rozsahem openid, protože autentizace a openid mají stejnou autorizaci, měla by být použita pouze jedna nebo druhá. Pokud používáte jiné obory, přidejte openid do seznamu požadovaných oborů. 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.

Všimněte si, ž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.

Podívejte se na naši technická dokumentace Pro více informací.

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ž je potřeba provést opravy, pomocí jedinečného kódu dané 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řehledy toho, co a co nesmí zobrazovat 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.

ORCID umožňuje uživatelům povolit Dvoufaktorová autentizace (2FA) na jejich ORCID účet. 2FA je sekundární bezpečnostní kontrola prováděná během procesu přihlášení. Poskytuje další potvrzení, že uživatel je skutečně osoba, která se přihlašuje k účtu ORCID účet. Další informace o tom, jak to lze nakonfigurovat pro uživatele, najdete v našem Článek KB.

OpenID připojit integrátory pomocí API člena může zkontrolovat, zda se uživatel přihlásil do svého ORCID účet s povolenou 2FA jako součást procesu OAuth. To může členským integrátorům umožnit udělit přístup svým výzkumným pracovníkům k systémům vyšší bezpečnosti.

V souladu s náš závazek kontrolovat jejich výzkumné pracovníky ORCID záznam, držitel záznamu může kdykoli zrušit jakýkoli přístupový token odstraněním z oprávnění v Důvěryhodná organizace seznamu v části Nastavení účtu.

Od roku 2018 mohou vědci udělit pouze dlouhodobé přístupové tokeny, které trvají 20 let, pokud uživatel neodvolá povolení.

ORCID poskytuje jednoduchý Widget Java Script které lze použít k získání ověřeného ORCID ID používající OAuth s OpenID Connect.

Vezměte prosím na vědomí, že widget používá implicitní OAuth, takže neshromažďuje žádná oprávnění k zápisu. To znamená, že není vhodný pro integrace členů, kteří chtějí aktualizovat záznamy. Přečtěte si prosím náš návod pro Přidávání a aktualizace dat na ORCID evidence.

Společnost ORCID záznam je rozdělen do jednotlivých sekcí, aby bylo čtení záznamu rychlejší a konzistentnější. Nejprve můžete zavolat sekci, abyste získali její souhrn, a potom zavolat pomocí put kódu jednotlivých položek a získat podrobné informace o této položce.

Níže je uvedena tabulka souhrnných oddílů, které můžete ke čtení použít pomocí rozhraní API.

Položky (práce, zaměstnání, financování, vzájemné hodnocení atd.) Lze přidat do ORCID záznam pomocí ORCID členské API. Potřebujete následující:

• Povolení vědců
• Pověření člena API
• A buď:
  • Prodejní systém, který se integruje s ORCID Členské API
  • Váš vlastní systém, který se integruje s ORCID Členské API

Tento příklad volání načte souhrn celého ORCID nahrávat ve formátu XML pomocí členské API na izolovaném serveru. K odeslání požadavků API na veřejné nebo členské API potřebujete přístupový token.

Method: GET
Accept: application/vnd.orcid+xml 
Authorization type and Access token: Bearer [Stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/record

API vrátí zprávu 200 OK, což znamená, že požadavek byl úspěšně přijat, a úplné shrnutí ORCID záznam, včetně shrnutí jednotlivých položek

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
     <funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">
  [...] 
  </record:record>

Každá položka (práce, financování, zaměstnanost atd.) Má a vložte kód. To lze v případě potřeby použít k získání úplných podrobností o položce.

Než budete moci přidat položku do ORCID záznamu budete muset naformátovat svá data do ORCID schéma. Naformátujte svá data v ORCID schéma zprávy v XML nebo JSON.

Naše úložiště GitHub obsahuje prostředky, které vám pomohou s formátováním při vytváření nových položek na serveru ORCID záznamu a při čtení existujících položek na disku ORCID záznam:

• Ukázkové soubory XML
• XSD pro všechny sekce ORCID záznam

Všimněte si, že různé verze API mají různé formáty zpráv. K dispozici jsou také schémata a příklady verze 2.0 a 2.1.

Další příklady lze snadno najít čtením metadat dobře naplněného záznamu.

Starší verze ORCID API mělo další obory. Tyto obory byly vyřazeny pomocí 2.0 API. Doporučujeme všem integracím používat pouze doporučené obory. Níže jsou uvedeny dřívější obory s aktuálním oborem, který by měl být použit místo toho

• /orcid-profil / omezeno na čtení místo toho použít / omezeno na čtení
• /orcid-práce / omezeno na čtení místo toho použít / omezeno na čtení
• /orcid-bio / read-limitemísto toho použít / omezeno na čtení
• /orcid-pracovat / vytvořit místo toho použít / aktivity / aktualizace
• /orcid-práce / aktualizace místo toho použít / aktivity / aktualizace
• / přidružení / vytvořit místo toho použít / aktivity / aktualizace
• / přidružení / aktualizace místo toho použít / aktivity / aktualizace
• / financování / vytvořit místo toho použít / aktivity / aktualizace
• / financování / aktualizace místo toho použití / aktivity / aktualizace
• /orcid-bio / aktualizace místo toho použít / osoba / aktualizace
• /orcid-bio / externí identifikátory / vytvořit místo toho použít / osoba / aktualizace

Obnovovací tokeny se používají ke generování dalších přístupových tokenů. Při výměně autorizačního kódu jako součásti se vrací obnovovací token s přístupovým tokenem třínohé procesy OAuth, a lze jej použít, dokud přístupový token zůstane aktivní.

Nové přístupové tokeny mohou mít stejné vypršení platnosti a rozsahy jako původní přístupový token, nebo mohou být zadány tak, aby měly kratší životnost a menší podmnožinu oborů z původního přístupového tokenu. Lze vygenerovat nové přístupové tokeny, které nahradí původní token, nebo vygenerovat, aby sloužily jako další token. Můžete také použít volání obnovovacích tokenů k úplnému vypršení platnosti původních přístupových a obnovovacích tokenů a veškerých oprávnění udělených uživatelem. 

Doporučujeme použít obnovovací tokeny za následujících podmínek:

• Výměna přístupových tokenů, které mohly být ohroženy (nezapomeňte odvolat původní přístupový token); nebo 
• Poskytování třetí strany, která je také součástí vašeho ORCID integrace omezenější přístup a / nebo přístup na omezenou dobu.

Ke zrušení dvojice tokenů použijte ID klienta, tajný klíč a buď aktivní token, nebo jeho přidružený obnovovací token. Můžete zrušit dvojice tokenů vytvořené jak ve dvounohých, tak v třínohé procesy OAuth. Pokud máte více sad tokenů, např. Pro různé obory, bude odvolán pouze určený přístupový token a odpovídající obnovovací token.

Doporučujeme zrušit tokeny za následujících podmínek:

• Odvolat tokeny vydané dodavateli třetí strany po ukončení vztahu;
• Odvolání tokenů, když uživatelé odpojí své ORCID iD z vašeho systému;
• Umožnit uživatelům odvolat tokeny z vašeho systému.

Doporučujeme použít obnovovací tokeny omezit rozsah nebo dobu trvání existujícího přístupového tokenu nebo aktualizovat token, pokud byl ohrožen.

Odvolání volání API

https://sandbox.orcid.org/oauth/revoke (or https://orcid.org/oauth/revoke)
  METHOD: POST
  HEADER: accept:application/json
  DATA: 
    client_id=[Your client ID]
    client_secret=[Your client secret]
    token=[access token or refresh token for token pair to be revoked]

Všechny položky (kromě textu životopisu) na ORCID záznam mít vložte kód:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>   
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>      
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">   [...] 
</record:record>

Tento put kód lze použít k volání rozhraní API k načtení úplných dat položky. Následující položky lze dotazovat pomocí a vložte kód:

Pomocí koncového bodu sekce a vloženého kódu můžete volat API pomocí stejného přístupového tokenu a získat tak konkrétní položku v plném rozsahu. Toto příkladové volání načte plnou položku financování 4413 ve formátu XML pomocí členské API na izolovaném serveru.

Method: GET
Accept: application/vnd.orcid+xml 
Authorization type and Access token: Bearer [stored access token]
URI: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/funding/4413

Příklad volání: GitHub

Rozhraní API vrátí zprávu 200 OK, což znamená, že zpráva byla úspěšně přijata, a vrátí úplné XML položky financování:

<?xml version="1.0"  encoding="UTF-8" standalone="yes"?>
    <funding:funding put-code="4413" path="/0000-0002-9227-8514/funding/4413" visibility="public"  [...] >
    [...] 
    </work:work>

Můžete zkontrolovat zdroj položky při čtení chcete vědět, kdo ji přidal.

Existují dva různé rozsahy aktualizací - jeden pro biografické podrobnosti a druhý pro aktivity.

Seznam běžných chybových kódů API, jejich možných významů a tipů, jak je řešit, je k dispozici v našem technická dokumentace.

Pokud nejste schopni vyřešit problém, se kterým se setkáváte, dejte nám prosím vědět.

ORCID členové mohou aktualizovat informace, které dříve přidali do souboru ORCID záznam. Najednou lze aktualizovat pouze jednu položku a lze ji aktualizovat pouze pomocí přihlašovacích údajů klienta, které ji vytvořily.

Chcete-li usnadnit aktualizaci, ujistěte se uložte put kód a přístupový token při vytváření položek.

Naformátujte aktualizovanou položku in ORCID schéma zprávy se změněnými informacemi a zahrnout uložené vložte kód.

<?xml version="1.0" encoding="UTF-8"?>      <employment:employment put-code="739288" [...]>     [...]            </employment:employment>

Volejte API:

Method: PUT
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
Data: link to file or text of affiliation to update
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288

Příklad volání: GitHub

API vrátí zprávu 200 OK, která označuje, že se položka aktualizovala správně. Pokud se zobrazí jiná zpráva, podívejte se na naši stránku pro řešení potíží.

Položky (práce, zaměstnání, financování, vzájemné hodnocení atd.) Lze přidat do ORCID záznam pomocí ORCID členské API. Chcete-li to provést, musíte nejprve získat povolení od výzkumníka pomocí OAuth a naformátovat metadata položky s použitím ORCID schéma zprávy.

Jakmile naformátujete data a shromáždíte ORCID iD a přístupový token, vytvoříte požadavek API pomocí HTTP POST se specifikací relevantní koncový bod.

Method: POST
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
Data: link to file or text of single employment item to add
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment

Volání níže přidává nový zaměstnání přidružení k záznamu na testovacím serveru karantény:

<?xml version="1.0" encoding="UTF-8"?>      
<employment:employment [...]>     
[...]            
</employment:employment>

Příklad volání: Github

API vrátí zprávu 201, která označuje, že položka byla správně zaúčtována spolu s položkou vložte kód. Váš klient bude uveden jako zdroj položky.

Podívejte se na náš Řešení problémů stránka, pokud je vrácena jiná zpráva. Budete muset uložit  uložte put kód a přístupový token provádět jakékoli aktualizace nebo odebrat položku.

Viditelnost označuje nastavení ochrany osobních údajů položky na základě preferencí viditelnosti nastavených uživatelem. Pokud je při zveřejňování informací prostřednictvím rozhraní API zahrnuta značka viditelnosti, bude ignorována. Místo toho budou informace zveřejňovány podle výchozí preference viditelnosti uživatele, jak je nastavena v předvolbách jeho účtu.

Veřejné položky může číst kdokoli prostřednictvím rozhraní API a jsou zobrazeny ve veřejném záznamu výzkumného pracovníka. Položky důvěryhodné strany jsou vráceny prostřednictvím rozhraní API pouze klientům, kteří mají přístup omezený na čtení; nejsou ve veřejném záznamu výzkumníka. Soukromé položky jsou viditelné pouze pro výzkumného pracovníka a zdroj položky - jediné soukromé položky vrácené prostřednictvím rozhraní API jsou ty, které byly přidány do záznamu prostřednictvím vaší integrace. Další informace o nastavení viditelnosti v ORCID registr.

Pokud jste přidali data, která je třeba odstranit, například pokud byla spojena s nesprávným ORCID iD, pak můžete provést požadavek HTTP DELETE specifikující relevantní koncový bod, spolu s ORCID iD, uložený přístupový token a uložený put kód. Najednou lze smazat pouze jednu položku a můžete smazat pouze položky přidané vaším klientem.

Toto ukázkové volání odstraní položku zaměstnání s kódem put „739288“ ze záznamu “

Method: DELETE
Content-type:  application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288

Příklad volání: GitHub

Společnost ORCID vyhledávací API používá syntaxi SOLR. Jsou podporovány všechny syntaxe dotazů dostupné v SOLR 3.6, včetně Lucene s rozšířeními Solr (Default), DisMax a Extended Dismax.

K použití potřebujete přístupový token „/ read-public“. Jakmile získáte svůj vyhledávací token, vytvořte si základní adresu URL pro vyhledávání:

Příklad volání k vyhledávání „orcid„S tokenem na veřejném API karantény s výsledky vrácenými ve formátu XML je:

Method:  GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=orcid

Výsledky budou specifikovat počet nalezených výsledků (počet nalezených) a ve výchozím nastavení zobrazí prvních 1000 výsledků:

  <?xml version="1.0"  encoding="UTF-8" standalone="yes"?>
  <search:search num-found="385" xmlns:search="https://www.orcid.org/ns/search"  xmlns:common="https://www.orcid.org/ns/common">
  <search:result>
  <common:orcid-identifier>
    <common:uri>https://sandbox.orcid.org/0000-0001-2345-6789</common:uri>
    <common:path>/0000-0001-2345-6789</common:path>
    <common:host>sandbox.orcid.org</common:host>
  </common:orcid-identifier>
  </search:result>
  [...]
  </search:search>

Příklad základního vyhledávání na veřejném API karantény s výsledky vrácenými ve formátu json:

Method: GET
Content-type: application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=newman

Hledání vrátí pouze jednotlivce ORCID ID záznamů uchovávajících veřejná data odpovídající vyhledávání. Chcete-li získat více informací o výsledku, zavolejte a přečtěte si ORCID nahrávat přímo.

Více informací naleznete v našem Výukový program pro vyhledávání API.

Společnost ORCID vyhledávací API používá syntaxi SOLR. Jsou podporovány všechny syntaxe dotazů dostupné v SOLR 3.6, včetně Lucene s rozšířeními Solr (Default), DisMax a Extended Dismax.

Vyhledávání polí můžete použít, pokud potřebujete prohledat konkrétní část souboru ORCID záznam. Aktuální seznam polí rozpoznaných při vyhledávání API spolu s jejich odpovídajícími prvky struktury záznamu jsou následující:

Podívejte se na naši Výukový program pro vyhledávání API Pro více informací.

V reálných situacích jsou interakce API dokončeny vaším systémem pomocí programovacího jazyka, jako je PHP, Java nebo Ruby on Rails. Pro nácvik a testování můžete komunikovat s ORCID API využívající řadu nástrojů schopných vytvářet a přijímat požadavky HTTP. Většina nástrojů HTTP pro stolní počítače se spouští v příkazovém řádku; pro ty, kteří dávají přednost grafickému rozhraní, jsou webové nástroje užitečnou alternativou.

Ověření XML / XSD

Existuje mnoho nástrojů, které za vás ověří váš XML; je dobrý nápad si jeden adoptovat. U mnoha volání API budete pracovat s informacemi ve formátu XML. Zejména při práci s ORCID Zpráva API, bude důležité, aby XML, který používáte, byl platný pro XSD. (Viz naše dokumentace na GitHub pro ORCID schéma zprávy XSD.)

ORCID ZKUŠEBNÍ SERVER SANDBOXU

Společnost sandbox testovací server je kopií souboru ORCID Registrační software a obsahuje pouze testovací data. Byl navržen tak, aby poskytoval místo k vyzkoušení věcí, aniž by to ovlivnilo jakékoli skutečné ORCID ID, zejména pokud pracujete s ORCID API a potřebujete místo pro otestování vaší práce. Můžete si vytvořit uživatelské účty a otestovat volání API na karanténě, aniž byste se museli starat o ovlivnění produkčních dat nebo o náhodném spamování výzkumníků. 

Ani nemusíte být ORCID member to try the member API in the sandbox. Všichni jsou vítáni, když požádají o přihlašovací údaje API člena sandboxu a vyzkoušejí všechny funkce dostupné pro členské API.

Web a rozhraní API nebudou tak spolehlivá jako u produkčních serverů. Neručíme za data na karanténě; nejsou zálohovány a mohou být odstraněny. Sandbox může také obsahovat některé experimentální funkce, které zatím nejsou na produkčních serverech, takže si můžete vyzkoušet věci dříve, než existují v registru. Přečtěte si více o serveru pro testování izolovaného prostoru nebo požádat o přihlašovací údaje klienta.

NÁSTROJE HTTP

Ke spouštění požadavků HTTP je k dispozici mnoho nástrojů. Některé používáme:

• kučera
• Listonoš
• wget
• hurl.it
• Hřiště Google OAuth 2.0
• Naparování: členské API (karanténa), veřejné API (karanténa)

Webhooky mohou prémioví členové zaregistrovat proti všem ORCID záznam v registru. Kroky jsou:

Zakódujte adresu URL

URL zakódujte požadovanou adresu URL ORCID volat, když se aktualizuje záznam uživatele. Například následující adresa URL:

https://nowhere2.com/0000-0002-7465-2162/updated

se stává

https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated

Vytvořte adresu URL

Vytvořte úplnou adresu URL pro ORCID Volání API počínaje adresou URL ORCID zaznamenejte a poté přidejte „/ webhook“ a adresu URL, kterou chcete volat. Mělo by to tedy vypadat jako https: //api.sandbox.orcid.org / {ORCID} / webhook / {URL-ENCODED-WEBHOOK-URL}

Například pomocí výše uvedené adresy URL webhooku a ORCID iD 0000-0002-7465-2162, úplná adresa URL je:

https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated

Zaregistrujte webhook

Použijte token přístupu k webhookům k registraci webhooku proti uživateli ORCID záznam. Musíte použít požadavek HTTP PUT, ale neměli byste do těla požadavku nic zahrnout.

URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
   HEADER: Accept: application/json
   HEADER: Authorization: Bearer [Your access token]
   HEADER: Content-Length: 0
   METHOD: PUT

Odpověď by měla být 201, ale pokud zpětné volání již existovalo, bude odpověď 204.

HTTP/1.1 201
Server: nginx/1.1.19
Connection: keep-alive
Location: https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Frequestb.in%2Fz57lzcz5

Adresa URL pro zrušení registrace webhooku je stejná jako pro registraci. Musíte však použít metodu HTTP DELETE.

URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
   HEADER: Authorization: Bearer [Your access token]
   HEADER: Content-Length: 0
   METHOD: DELETE

Odpověď by měla být 204 No Content.

HTTP/1.1 204 No Content
Server: Apache-Coyote/1.1
Date: Fri, 05 Apr 2013 12:49:17 GMT

Společnost ORCID Registr provede následující volání HTTP, když je záznam aktualizován. Požadavek používá metodu HTTP POST, ale tělo požadavku je prázdné.

curl -v -X POST https://nowhere2.com/0000-0002-7253-3645/updated

Váš server by měl reagovat standardními kódy odpovědí HTTP. Pokud byl hovor úspěšný, měli byste vrátit 204 Žádný obsah.

HTTP/1.1 204 No Content

Libovolný kód odpovědi 2xx znamená, že hovor byl úspěšný. Pokud vrátíte kód, který není 2xx, zkusíme hovor zkusit znovu o pět minut později.

V reálných situacích jsou interakce API dokončeny vaším systémem pomocí programovacího jazyka, jako je PHP, Java nebo Ruby on Rails. Pro procvičování a testování však můžete komunikovat s ORCID API využívající řadu nástrojů schopných vytvářet a přijímat požadavky HTTP. Většina nástrojů HTTP pro stolní počítače (například kučera) jsou spuštěny v příkazovém řádku; pro ty, kteří dávají přednost grafickému rozhraní, jsou webové nástroje užitečnou alternativou.

Jeden populární nástroj je Hřiště OAuth 2.0 společnosti Google, bezplatný webový nástroj vyvinutý a udržovaný společností Google. Přečtěte si prosím naši příručku o rozhraní API na adrese: https://orcid.github.io/orcid-api-tutorial/

Poznámka: ORCID neudržuje hřiště OAuth 2.0 - tento nástroj vytvořil Google, který výhradně udržuje jeho kód. I když tuto dokumentaci pravidelně aktualizujeme, mohou se čas od času vyskytnout určité nepřesnosti, protože si nemusíme být okamžitě vědomi změn v OAuth 2.0 Playground.

Společnost ORCID registr podporuje „vyjednávání obsahu“. To znamená, že stroje a další systémy se mohou zeptat ORCID registr pro metadata osob v různých formátech.

Jedním z těchto formátů je JSON-LD, který používá schema.org slovní zásoba, konkrétně typ osoby, které spojujeme s pracemi, organizacemi a dalšími identifikátory. Podporujeme také XML, JSON, RDF XML a želvu a implementovali jsme Cross-origin resource sharing (CORS), abychom usnadnili přístup k našim datům.

• Viz tento blogový příspěvek pro přehled ORCID a schema.org
• Podívejte se na naši technická dokumentace k jednání o obsahu

Pro naše API verze 2.0 a vyšší jsou limity:

• Požádejte o sekundu - 24
• Burst - 40

Žádost o sekundu - Počet požadavků, které lze zadat za sekundu.

Burst - Počet požadavků, které dovolíme zařadit do fronty před zamítnutím. Požadavky ve frontě jsou zpomaleny na rychlost požadavků za sekundu. Pokud překročíte dávku, dostanete odpověď 503.

Pokud narazíte na problémy s omezeními, požádejte o podporu svého vedoucího týmu Engagement Team.

Kontrola výzkumného pracovníka je jádrem ORCID princip, takže e-mailové adresy zaregistrovány a přidány do ORCID záznamy jsou ve výchozím nastavení nastaveny jako viditelné pouze pro držitele záznamu. Neověřené e-maily se ve veřejném zobrazení záznamu nezobrazí a ve výsledcích API se zobrazí pouze e-mailové adresy, které byly ověřeny. 

Jakmile vědci ověří svou e-mailovou adresu, musí se rozhodnout, že ji bude viditelná pro všechny (tj. Veřejné) nebo pro důvěryhodné strany (tj. Omezený přístup), aby si e-mailovou adresu mohli přečíst organizace třetích stran.

Pokud výzkumný pracovník nastavil svou e-mailovou adresu na Důvěryhodné strany, vrátí se spolu se záznamem, pokud vám ji výzkumný pracovník poskytl přístup omezený na čtení. Další informace naleznete v části ORCID nastavení viditelnosti.

API 3.0 je výchozí verze API a doporučujeme, abyste při vytváření nových integrací používali tuto verzi. V dohledné budoucnosti budeme i nadále podporovat API 2.0 a 2.1 a před vypnutím těchto verzí poskytneme upozornění nejméně 12 měsíců.

Během přechodu z API 1.2 na API 2 jsme se toho hodně naučili. Tentokrát jsme správu upgradovali mnohem snáze. API 3.0 přidává nové funkce, přičemž stávající funkce upravuje pouze v nezbytných případech. To znamená, že integrátoři by měli být schopni přejít na nové API s minimem rozruchu. To také znamená, že ačkoli vám doporučujeme začít plánovat upgrade co nejdříve, aby vaše organizace a výzkumní pracovníci mohli těžit z nových funkcí, máte velkou flexibilitu při rozhodování o aktualizaci na verzi 3.0.  

Malý seznam potenciálně zlomových změn je v našich poznámkách k vydání API zde  a  zde. Kolem volitelných / povinných polí existuje několik změn, výčty JSON byly mírně upraveny a máme také malou refaktoring našich schémat XML, přidáním některých nových polí, která obsahují metadata požadovaná pro novou funkčnost.

Každý prémiový člen může získat přístupový token '/ webhook'. Jeden token lze použít k registraci webhooků pro více záznamů. Chcete-li získat token, zavolejte na ORCID Koncový bod tokenu API. 

Tento proces se často označuje jako tok OAuth pověření klienta nebo dvoufázový OAuth.

Níže je ukázkové volání k získání přístupového tokenu - zástupné symboly nahraďte svými přihlašovacími údaji (nezapomeňte odstranit závorky.)

 
curl -i -L -H "Accept: application/json"
  -d "client_id=(your client ID)"
  -d "client_secret=(your client secret)"
  -d "scope=/webhook"
  -d "grant_type=client_credentials"
  "https://sandbox.orcid.org/oauth/token"

Poté vám bude vrácen přístupový token podobný následujícímu.

{"access_token":"5eb23750-1e19-47a3-b6f6-26635c34e8ee",
  "token_type":"bearer",
  "refresh_token":"c7d3d5fd-e4c0-4825-89f2-7cfb4a1cf01e",
  "expires_in":631138518,
  "scope":"/webhook"}

Ano, máme! Více informací o našich verzích API, důvodech a dalších si můžete přečíst zde na našem Zásady verze API.

Jak pokračujeme ve vývoji našich produktů, existuje řada funkcí, které jsou k dispozici pouze s API 3.0, což je naše nejnovější a výchozí verze API.

Níže uvedená tabulka poskytuje krátký popis každé funkce. Máte-li jakékoli dotazy týkající se některé z funkcí nebo upgradu na verzi 3.0, obraťte se na svého vedoucího zakázky nebo svého vedoucího konsorcia.

Podrobnější informace lze nalézt zde.

Obdrží oznámení v jejich ORCID Doručená pošta. Kdykoli dojde ke změně dat na ORCID záznamu, uživatel obdrží oznámení se základními informacemi o změně, včetně jména klienta provádějícího aktualizaci, data změny a položky v ORCID záznam, který byl aktualizován. Podívejte se na naše uživatelská znalostní databáze pro více informací o oznámeních.  

ORCID záznamy na pískovišti také mají fungující schránky. Doporučujeme pravidelně procházet složky doručené pošty vašeho testování ORCID záznamy při plánování, jak budou vaše systémy plánovat aktualizace dat. 

Aktualizace a další oznámení pro uživatele API jsou sdíleny prostřednictvím ORCID Skupina uživatelů API. Můžete se také přihlásit k odběru obecných zpráv a aktualizací prostřednictvím ORCID Blog.

ORCID členové také dostávají ORCID Zpravodaj pro členské země, kde jsou tyto informace uvedeny. Nakonec technický kontakt pro všechny ORCID člen s aktivní integrovanou integrací bude také dostávat e-mailové zprávy o všech důležitých aktualizacích systému ORCID Registr. Pokud chcete být uveden jako technický kontakt pro vaši organizaci, prosím kontaktujte nás.

ORCID je odhodlána být otevřená a transparentní. To znamená naše cestovní mapa produktu je k dispozici pro prohlížení, stejně jako práce aktuálně ve vývoji.

Plán produktů je ústředním bodem programu ORCID proces vývoje produktu. Požadavky putují od týmově spravovaných trello desek, přes trello board Product Roadmap a dále až po trello board Current Development, kde jsou implementovány a přesunuty do našich produkčních systémů.

Tato deska obsahuje přesně definované požadavky, které jsou naplánovány na implementaci v určitém okamžikua seznam prioritních požadavků naplánovaných na implementaci v blízké budoucnosti.

Odkud pocházejí požadavky?

Požadavky shromažďuje z mnoha zdrojů ORCID personál. Mohou pocházet mimo jiné z požadavků členů, zpětné vazby od konsorcia, testování uživatelů, strategických projektů a hlášení o chybách. Navíc všechny ORCID týmy generují své vlastní interní požadavky, jako jsou změny webových stránek, aktualizace infrastruktury a aktualizace operačních systémů. Každá karta je označena týmem, který požadavek vytvořil - komunikace, strategie, technologie, zapojení nebo operace.

Jak se má postupovat podle plánu?

ORCID usiluje o vyvážený vývojový cyklus produktu a má pravidelné schůzky napříč týmy za účelem projednání blízkých a dlouhodobých priorit. Snažíme se co nejlépe řešit chyby, nové funkce, technické zadlužení, aktualizace webových stránek a strategické položky stejně.

Jak mohu přispět do plánu?

Vítáme návrhy, jak zlepšit ORCID registr. Zašlete prosím jakoukoli zpětnou vazbu na adresu náš tým.

Kromě toho, ORCID je projekt s otevřeným zdrojovým kódem a vítáme příspěvky do našeho zdrojového kódu i do všech naše úložiště.

Předtisk je kompletní vědecký rukopis, který autoři nahrají na veřejný server. Předtisk obsahuje úplná data a metodiky; často se jedná o stejný rukopis, který se předkládá do deníku. Po krátké inspekci kontroly kvality, aby se zajistilo, že práce má vědeckou povahu, je autorský rukopis zveřejněn přibližně za den na webu bez vzájemného hodnocení a může si jej bezplatně prohlížet kdokoli na světě. Na základě zpětné vazby a / nebo nových údajů lze odeslat nové verze předtisku; zůstanou však zachovány i předchozí verze předtisků. Servery preprint umožňují vědcům přímo řídit šíření jejich práce do celosvětové vědecké komunity. Ve většině případů je stejná práce zveřejněná jako předtisk také odeslána k recenzování v časopise. Preprinty (rychlé, ale ne validované prostřednictvím peer-review) a publikace časopisů (pomalé, ale zajišťující validaci pomocí peer-review) tedy fungují paralelně jako komunikační systém pro vědecký výzkum.

Poznámka: Tento obsah a video se původně objevily na webu Web ASAPBio Děkujeme ASAPBio za jeho zpřístupnění pod licencí CC-BY!

Členský zpravodaj zasílaný měsíčně z ORCID obsahuje odkaz na složku Disku Google, kde jsou uloženy všechny vaše členské zprávy.

• Prémioví členové s aktivní integrací obdržíte jedinečný odkaz na složku obsahující samostatné přizpůsobené zprávy s daty pro každou integraci v předchozím měsíci.
• Prémioví členové, kteří ještě nemají aktivní integraci obdrží jedinečný odkaz na složku obsahující přizpůsobené zprávy s e-mailovými statistikami pro jejich instituci a také odkaz na složku, která obsahuje obecné zprávy se souhrnnými údaji pro všechny aktivní integrace členů.
• Základní členové obdrží odkaz na složku obsahující obecné zprávy vydávané dvakrát ročně s agregovanými údaji o všech aktivních integracích členů v předchozím půl roce; zpráva za první pololetí je vydána v červenec (Údaje za leden až červen), zpráva za druhou polovinu roku vydaná v leden (Červenec - prosinec následujícího roku).

Pokud jste ORCID člen a momentálně neobdržíte měsíční informační bulletin pro členy, kontaktujte [chráněno e-mailem]

Prémioví členové s aktivní integrací

Složka Disk Google obsahuje zprávu člena pro každý vydaný ID produkčního klienta. Názvy souborů zahrnují zobrazovaný název klienta iD a datum zprávy; řiďte se podle data změny, abyste našli nejnovější přehled. K dispozici je také složka raw_data obsahující data použitá ke generování zprávy, která je v případě potřeby k dispozici pro další analýzu.

Prémioví členové, kteří ještě nemají aktivní integraci

Složka Disku Google obsahuje zprávu o členech pouze s e-mailovými statistickými údaji a také odkaz na složku Disku Google s obecnými měsíčními přehledy se souhrnnými údaji o všech aktivních integracích členů pro aktuální a předchozí roky. Nezpracovaná data pro tyto přehledy nejsou k dispozici.

Počty e-mailových domén

Tato část poskytuje počty ORCID iDs aktuálně zaregistrovaly e-mailové domény vaší instituce ve všech časových obdobích. Abychom tyto počty vygenerovali, vyhledáme domény, které odpovídají adrese URL webových stránek, kterou máme v evidenci pro vaši organizaci (např. Pokud je adresa URL vašeho webu www.universitycollege.edu, vyhledáme e-maily končící na @universitycollege). Pokud nemáme uloženou adresu URL webových stránek, zobrazí se v této části text „Nejsou poskytovány žádné e-mailové domény“. Pokud jsme vaši e-mailovou doménu nezjistili úplně správně nebo pokud chcete přidat další domény, prosím kontaktujte nás.

• Záznamy zaregistrované do vašich e-mailových domén Počet jedinečných ORCID ID, která obsahují adresu v e-mailových doménách vaší instituce
• Záznamy registrované k vašim e-mailovým doménám A přidružené k vašemu ID klienta Počet jedinečných ORCID ID, která obsahují adresu v e-mailových doménách vaší instituce A která obsahují vaši instituci jako důvěryhodnou stranu (tj .: záznamy, pro které má vaše instituce platný přístupový token)

Vytvořené a nárokované záznamy

(Poznámka: Většina klientů nebude mít tuto část ve svých přehledech)

Pokud máte institucionálního klienta, který byl použit k vytváření záznamů jménem výzkumných pracovníků prostřednictvím rozhraní API, obdržíte sekci nazvanou Statistika registru. To zahrnuje informace o počtu záznamů, které jste vytvořili, a o tom, kolik jich bylo nárokováno (soubor raw_data obsahuje více informací o konkrétních záznamech použitých k vygenerování těchto čísel).

uživatelé

Tato část zprávy obsahuje celkový počet výzkumných pracovníků, kteří pomocí vaší integrace propojili své ORCID iD do vašeho systému za měsíc hlášení. Kromě toho udává celkový počet výzkumníků, kteří se přihlásili k novému ORCID iD jako součást iD proces připojení. 

Graf označený Total Integration Events ukazuje počet výzkumných pracovníků, kteří vaši integraci použili za poslední měsíc, ve dne

Akce

Zpráva také obsahuje akce informace, akce, které výzkumník provedl při připojování ORCID zaznamenávejte se svým systémem v měsíci hlášení. Každá událost představuje jakýkoli přístup, který uživatel udělil, nebo akci, kterou na něm provedli ORCID stránky (například přihlášení nebo poskytnutí přístupu s omezením pro čtení). Většina výzkumných pracovníků bude mít více než jednu událost spojenou s nimi.

Pokud je k události připojeno „P“, znamená to, že výzkumník udělil dlouhodobou (Persistent) token ve srovnání s krátkodobým tokenem, jehož platnost vyprší za jednu hodinu. Od března 2018 jsou na platformě podporovány pouze tokeny s dlouhou životností ORCID Registr; váš integrovaný systém nebo uživatel může token kdykoli zrušit. 

Uživatelé podle země

Závěrečná část zpráv obsahuje informace o výzkumných pracovnících, kteří vaši integraci použili, rozdělené podle zemí, ze kterých k vaší integraci přistupovali. Tyto údaje jsou odvozeny z adresy IP výzkumného pracovníka nebo z jejich geografické polohy ID (sám určuje Google z IP adresy výzkumníka).

Vzorkování

Protože tolik vědců používá ORCID Registru, není možné spouštět zprávy o celé sadě dat výzkumných pracovníků. Namísto toho se zde uvedená čísla vytvářejí pomocí trendů ze vzorkované a nezařazené sady. Sekce přehledu odvozené ze vzorkovaných dat jsou signalizovány hvězdičkou a velikost a prostor vzorkování jsou specifikovány na kartě Data Analytics. Čísla v části Google Analytics v přehledu se nemusí zcela shodovat s místními statistikami, které uchováváte, a v počtu mezi částmi v přehledu mohou být malé nesrovnalosti.

Parametry vzorkování uvedené pod Integration Analytics se vztahují na všechny sekce označené hvězdičkou. Procento relací zachycených analytickými daty je (velikost vzorku) / (prostor vzorku) * 100%. Další informace o odběru vzorků najdete na adrese Google Vývojáři.

Prázdné zprávy

Sekce Uživatelé a Události v přehledu obsahují pouze data z minulého měsíce. Pokud vaši integraci v minulém měsíci nevyužili žádní vědci, nebudou vrácena žádná data.

otázky

Máte-li jakékoli dotazy týkající se zpráv členů, prosím kontaktujte nás.

Společnost ORCID Registr je navržen tak, aby uživatelé mohli poskytovat svá ID organizacím používajícím OAuth, což zajišťuje správnost iD se shromažďuje pro každého výzkumného pracovníka. Odrazujeme organizace od přidávání ORCID ID k jejich systémům na základě vyhledávání výzkumných pracovníků podle jména. Může však být užitečné zjistit, kolik výzkumných pracovníků ve vaší organizaci má ORCID ID, které lze provést pomocí API. Níže jsou uvedeny návrhy na vyhledávání podle organizace.

Úvod do vyhledávání, jak získat přístupový token, jak porozumět výsledkům vyhledávání a podrobnosti o dalších polích, která lze prohledat, najdete v našem Prohledávání výukového programu API v registru

Hledání podle jména a DOI

Při kontrole, zda jednotlivec má ORCID záznamu doporučujeme prohledat jak jejich jméno, tak DOI jedné nebo více z jejich nedávných prací. Výsledkem by měl být pouze záznam výzkumného pracovníka, kterého hledáte, a nikoli záznamy kohokoli jiného, ​​kdo sdílí stejné jméno.

Ukázkové volání k vyhledání všech záznamů s názvem „Laurel Haak“ a buď DOI 10.1087 / 20120404 nebo DOI 10.6084 / M9.FIGSHARE.1115124: 

Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL:  https://pub.orcid.org/v3.0/search?q=family-name:Haak+AND+given-names:Laurel+AND+digital-object-ids:%2210.1087/20120404%22+OR+digital-object-ids:%2210.6084/M9.FIGSHARE.1115124’%22

Hledání podle přidružení

V polích přidružení lze prohledávat buď název přidružení, nebo jedinečný Ringgold organizace ID nebo GRID ID. (Můžete najít Ringgold vaší organizace ID v Ringgold Identify Database a GRID vaší organizace ID in GRID.)

Hledání podle názvu organizace

Method: GET Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token] 
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:"University+of+Johannesburg" 

Nebo pro přesnou shodu

Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:(%22Boston%20University%22)

Hledání podle GRID ID

Ukázkové volání k vyhledání všech záznamů pomocí GRIDU ID grid.5509.9 (University of Tampere):

Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=grid-org-id:grid.5509.9

Hledání podle ID Ringgold

Ukázkové volání k vyhledání všech záznamů pomocí Ringgold ID 1438 (Kalifornská univerzita, Berkeley):

Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=ringgold-org-id:1438

Hledání podle e-mailové domény

Rozhraní API můžete použít k vyhledávání výzkumných pracovníků podle e-mailové domény. Pamatujte, že přibližně 97% e-mailových adres je v ORCID jsou soukromé a žádné záznamy se soukromou nebo důvěryhodnou e-mailovou adresou nebudou při tomto hledání vráceny.

Ukázkové volání k vyhledání všech záznamů pomocí znaku @orcidE-mailová adresa .org:

Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL:  https://pub.orcid.org/v3.0/search/?q=email:*@orcid.org

Výsledky vyhledávání vrácené ve formátu CSV

Výsledky vyhledávání lze také vrátit ve formátu CSV. V rámci výzvy můžete určit výstupní sloupce ze seznamu dostupných polí níže:

orcid
e-mail
křestní jméno
rodinné jméno
křestní jména a příjmení
kreditní jméno
jiné jméno
název aktuální přidružení instituce
název minulé instituce-přidružení 

Pomocí svých přihlašovacích údajů musíte určit záhlaví, které má být 'text / csv '. V rámci vyhledávacího volání musíte do dotazu přidat také pole, která požadujete na výstupu.  

Příklad volání pro člena, který hledá na prstenu ID s požadovaným výkonem včetně ORCID, jméno a příslušnost. 

Method: GET
Content-type: text/csv
Authorization type and Access token: Bearer [stored access token]
URL:  https://api.orcid.org/v3.0/csv-search/?q=ringgold-org-id:385488&fl=orcid,given-names,family-name,current-institution-affiliation-name,'

Hledání pouze pomocí vašeho prohlížeče

Hledání můžete dokončit také pomocí prohlížeče. Adresa URL je konstruována stejným způsobem, ale nemusíte používat žádná pověření API. Upozorňujeme, že toto lze dokončit pouze pomocí veřejného rozhraní API. 

Níže je ukázkové volání pomocí veřejného API vyhledávání podle názvu organizace pomocí ORCID, křestní jména, příjmení, aktuální název přidružení instituce a název přidružení minulosti instituce jako požadovaný výstup. 

https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:ORCID&fl=orcid,given-names,family-name,current-institution-affiliation-name,past-institution-affiliation-name

Níže je uveden další příklad volání pomocí veřejného API vyhledávání podle různých variant názvu organizace.

https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:("University of Plymouth" OR "Plymouth University")

Schéma eduPerson přidalo eduPersonOrcid atribut v jeho Aktualizace z února 2016.

Podle specifikace eduPerson:

  RFC4512  definition
  ( 1.3.6.1.4.1.5923.1.1.1.16
  NAME 'eduPersonOrcid'
  DESC 'ORCID researcher identifiers belonging to the principal'
  EQUALITY caseIgnoreMatch
  SYNTAX  '1.3.6.1.4.1.1466.115.121.1.15' )

Formát tohoto pole je ORCID-preferovaná URI reprezentace iD, tj https://orcid.org/0000-0001-5727-2427.

Další informace o formátu souboru ORCID iD lze nalézt v Struktura ORCID identifikátor.

ORCID byla založena na princip že vědci by měli mít kontrolu nad jejich informacemi. Abychom tuto zásadu ctili, máme silnou stránku Zásady ochrany osobních údajů, který byl navržen tak, aby zohledňoval místní rozdíly v předpisech o ochraně osobních údajů, a my se při vývoji zásad a funkčnosti zaměřujeme na perspektivu výzkumného pracovníka.

V souladu s našimi základní princip kontroly výzkumného pracovníka, ORCID záznamy mohou vytvářet pouze samotní výzkumní pracovníci na internetu ORCID webová stránka.

V rámci vašeho pracovního postupu integrace se vaši výzkumní pracovníci budou moci zaregistrovat pro nový ORCID iD nebo se přihlaste k jejich stávajícímu záznamu, což vám umožní shromáždit jejich ověřené údaje ORCID iD. Přečtěte si prosím naše Výukové programy API Pro více informací.