Výukový program API: Hledání v ORCID spisovna

Tento kurz popisuje, jak prohledávat ORCID Registr pomocí ORCID veřejné a členské API. Obě tyto metody vyžadují přístupový token získaný pomocí přihlašovacích údajů klienta.

Jedno ORCID API podporuje vyhledávání v podmnožině ORCID metadata pomocí populární syntaxe dotazů Solr. Vezměte prosím na vědomí, že pouze ORCID iDis vráceno ve výsledcích vyhledávání. Informace o získávání dat z konkrétního ORCID iD lze nalézt v Číst data z ORCID záznam.

Vyhledávání API nemusí být pro vaše použití správné. Možná budete chtít zvážit tyto alternativy:

• Hledání výzkumníka ORCID iD? Nedoporučujeme ruční zadávání žádných ORCID ID do vašich systémů nebo procesů. Doporučujeme vám, abyste shromažďovali ověřené údaje ORCID ID vašich výzkumníků.
• ORCID vydává roční veřejný datový soubor - snímek všech veřejných údajů v ORCID Registr v daném okamžiku - který lze také použít k vyhledávání velkých veřejných dat v registru. Pojistné ORCID členové mohou také získat přístup k datovému souboru na vyžádání pomocí veřejná synchronizace dat.
• Konkrétní pokyny k vyhledání velkého počtu výzkumných pracovníků vaší instituce najdete v našem tipy na hledání ORCID držitelé rekordů ve vaší instituci

a

Proč bych měl aktualizovat ORCID evidence?

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 může pomoci převzít kontrolu nad tím, jak je název vaší instituce používán ve výzkumných systémech. V kombinaci s jiný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ávat, jak interagují s vašimi publikačními systémy. Shromažďování ID pro všechny vaše autory a recenzenty během procesu publikace – ať už jde o knihy, časopisy, datové sady, kompozice, prezentace, kód nebo řadu dalších děl – umožňuje snadné sdílení informací a zajišťuje, že výzkumníci mohou poskytnout souhlas ke sdílení, šetří výzkumníkům čas a námahu, snižuje riziko chyb a v zásadě umožňuje výzkumníkům získat uznání, které si zaslouží za důležitou práci, kterou dělají.

Pomohl vám tento FAQ?

1

0

Trvalý

a

Jak mohu získat ověřené ID?

Integrace ORCID do vašeho systému umožňuje vaší organizaci shromažďovat ověřené ORCID ID a přidejte je ke svým vlastním datům. Zároveň výzkumník poskytuje organizaci povolení číst a zapisovat do az jejich ORCID záznam. 

Aby to fungovalo, organizace MUST získat ověřeno ORCID ID s použitím ORCID OAuth API. To znamená, že zahrnují ORCID značkové tlačítko nebo odkaz v jejich systému, který po kliknutí požádá uživatele o přihlášení do jejich systému ORCID záznam.

Po přihlášení bude uživatel požádán o autorizaci přístupu do systému ORCID iD

uživatele ORCID iD a jméno na ORCID záznam (v závislosti na nastavení viditelnosti) je vrácen organizaci jako součást tohoto procesu. Systém si pak může vyžádat další údaje od ORCID API.

Výše popsaný pracovní postup pro shromažďování ověřených rozhraní API je k dispozici v obou ORCIDveřejná a členská API. Prvně jmenovaný je zdarma k dispozici pro nekomerční služby.

Pomohl vám tento FAQ?

5

0

Trvalý

Získejte vyhledávací token

Kdokoli, kdo má pověření API, může prohledávat ORCID Registr. Členové API vyžaduje a / veřejné čtení přístupový token za účelem volání API. Chcete-li získat token, zavolejte na ORCID API využívající dvounohou autorizaci OAuth (tj. Volání přímo do API). Volání je stejné pro veřejné a členské pověření API.

a

Jak získám přístupový token „/ read-public“?

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. 

Integrátoři používající členské API mohou používat / veřejné čtení prostor ke čtení ORCID souhrny záznamů.

Pomohl vám tento FAQ?

4

32

Trvalý

Základní vyhledávání podle klíčových slov

Vyhledávání lze provádět v testovacím registru karantény nebo v živém produkčním registru. Koncový bod vyhledávacího rozhraní API přijímá GET pro požadavky HTTP. Jediným požadovaným vstupem je řetězec dotazu, který je předán vyhledávači Solr. 

a

Jak mohu použít ORCID Hledat API?

Jedno 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í:

Typ pověření:	Veřejné API	Členské API
URL zdroje:	Sandbox: https://pub.sandbox.orcid.org Produkce: https://pub.orcid.org	Sandbox: https://api.sandbox.orcid.org Produkce: https://api.orcid.org
Verze API:	v3.0
Vyhledat koncový bod	/ search /? = [dotaz]

Příklad volání pro hledání „orcid“ pomocí tokenu na veřejném rozhraní API karantény s výsledky vrácenými ve formátu XML je:

Method:  GET Content-type: application/vnd.orcid+xmlnAuthorization 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.

Pomohl vám tento FAQ?

1

2

Trvalý

Rozšířené vyhledávání

Kromě základního vyhledávání koncový bod rozšířeného vyhledávání rozšířené vyhledávání je k dispozici. Použití tohoto koncového bodu vrátí následující informace: orcid-id, křestní jména, příjmení, kreditní jména, jiná jména, e-mail a instituce při použití standardní syntaxe vyhledávání. Výsledky lze vrátit buď ve formátu XML nebo JSON.

Příklad vyhledávání na veřejném API karantény pro výraz „jones“

URL: https://pub.sandbox.orcid.org/v3.0/expanded-search/?q=spaceman

    <expanded-search:expanded-result>
        <expanded-search:orcid-id>0000-0002-2436-0000</expanded-search:orcid-id>
        <expanded-search:given-names>Dave Theodore</expanded-search:given-names>
        <expanded-search:family-names>Spaceman</expanded-search:family-names>
        <expanded-search:other-name>D Spaceman</expanded-search:other-name>
        <expanded-search:other-name>D T Spaceman</expanded-search:other-name>
        <expanded-search:institution-name>The University of The Moon</expanded-search:institution-name>
        <expanded-search:institution-name>Saturn Institute</expanded-search:institution-name>
    </expanded-search:expanded-result>

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 hledajícího na ringgold ID* s požadovaným výstupem včetně ORCID, jméno a příslušnost. 

Method: GET
  Content-type: text/csv
  Authorization type: Bearer
  Access token: [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í 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. 

Poznámka k uvozovkám nebo známkám řeči.

Při vyhledávání v prohlížeči používejte při vyhledávání přímé uvozovky, jako jsou tyto: „“, nikoli zvlněné uvozovky, jako jsou tyto: „“. Použití složených uvozovek vám poskytne nesprávné výsledky.

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”)

Formátování vyhledávacích dotazů

Výchozí chování je volné, neomezené vyhledávání ve všech dostupných indexovaných polích. Základní hledání výrazu „newman“ proto vyhledá vědce se zveřejněným jménem Newman, křestním jménem Newman nebo spojeným s prací s výrazem „newman“ v názvu atd. Vyhledávání lze vracet v JSON nebo XML podle toho, co je zadáno v typu obsahu.

API také podporuje booleovské vyhledávání pomocí více klíčových slov, přesných frází a dalších booleovských vyhledávacích funkcí. Klíčová slova musí být kombinována v závorkách a velká písmena „AND“ nebo „OR“ - malá písmena „a“ a „nebo“ jsou považována za součást vyhledávání.

Příklad booleovského vyhledávání na veřejném API karantény pro záznamy odpovídající třem klíčovým slovům (johnson, cardiology a houston):

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+AND+cardiology+AND+houston

Příklad booleovského vyhledávání na veřejném API karantény pro záznamy odpovídající klíčovému slovu „johnson“ a klíčovému slovu „caltech“ nebo frázi „California Institute of Technology“ a výsledkům vráceným v XML:

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+AND+(caltech+OR+"California+Institute+of+Technology")

Vyhledejte konkrétní prvky podle pole

Vyhledávání polí můžete použít, pokud potřebujete prohledat konkrétní část souboru ORCID záznam.

Základní syntaxí pro vyhledávání v poli je pole: hodnota, takže řetězec dotazu název-rodiny: james najde záznam s příjmením „James“, například „Roland James“, ale ne ty, které mají křestní jméno „James“, například jako „James Johnson“.

Lze poskytnout více polí: hodnotové páry. Přiřazování je založeno spíše na podřetězcových tokenech než na surových řetězcích, takže řetězec dotazu other-names: carberry bude odpovídat J. Carberry i JS Carberry.

a

Která pole dělá ORCID Podpora vyhledávání API?

Jedno 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í:

Vyhledávací pole	Popis
Životopisná data
křestní jména	Křestní jméno (jména) uživatele.
rodinné jméno	Příjmení uživatele.
kreditní jméno	„Zveřejněný název“ na internetu ORCID uživatelské rozhraní, název, který se obvykle na publikacích objeví
ostatní jména	Alternativní názvy, které se mohly objevit v publikacích uživatele.
e-mail	E-mailová adresa uživatele.
Klíčové slovo	Jakákoli klíčová slova spojená s uživatelem.
externí-id-reference	Identifikátory z jiných systémů přidané k uživateli ORCID záznam pomocí API.
Údaje o přidružení
název-přidružení-organizace	Název jakékoli organizace v položce vzdělání nebo zaměstnání v záznamu uživatele.
grid-org-id	Jedno ID MŘÍŽKY jakékoli organizace v sekci aktivit záznamu uživatele. Obecně to bude spojeno s položkou vzdělání nebo zaměstnání.
ror-org-id	Jedno ID ROR jakékoli organizace v sekci aktivit záznamu uživatele. Obecně to bude spojeno s položkou vzdělání nebo zaměstnání.
ringgold-org-id	Jedno ID Ringgold* jakékoli organizace v sekci činnosti záznamu uživatele. Obecně to bude spojeno se vzděláním nebo zaměstnáním.
Údaje o financování
finanční tituly	Název jakékoli položky financování v záznamu uživatele.
fundref-org-id	Jedno ID registru křížového funderu jakékoli organizace v sekci činnosti záznamu uživatele. Obecně to bude spojeno s položkou financování, ale může to být také spojeno s přidružením.
čísla grantů	Uveďte číslo (identifikátor) jakékoli položky financování v záznamu uživatele.
Údaje o výzkumných činnostech
pracovní tituly	Názvy jakékoli práce v záznamu uživatele.
ID digitálních objektů	Pracovní externí identifikátor s typem doi
doi-self	Pracovní externí identifikátor s typem doi a vztahem externího identifikátoru nastaveným na sebe
[typ externího identifikátoru] *	Pracovní externí identifikátor s daným typem
[typ externího identifikátoru] * - vlastní	Pracovní externí identifikátor s daným typem a vztahem externího identifikátoru nastaveným na sebe
[typ externího identifikátoru] * - část	Pracovní externí identifikátor s daným typem a vztahem externího identifikátoru nastaveným na část
[typ externího identifikátoru] * - verze	Pracovní externí identifikátor s daným typem a vztahem externího identifikátoru nastaveným na verzi * Úplný seznam externích identifikátorů naleznete v seznam identifikátorů. Některé identifikátory mohou pro vrácení výsledků vyžadovat „-self“, „-part-of“ nebo „-version-of“.
ORCID zaznamenat data
orcid	Osmimístný ORCID identifikátor uživatele ve formátu 0000-0001-2345-6789.
datum odeslání profilu	Datum a čas vytvoření záznamu.
datum poslední změny profilu	Datum a čas, kdy byl záznam naposledy upraven.
Všechny data
(souhrnně „Stránka (Stránky)“), a naše postupy pro shromažďování, využívání, uchovávání, ochranu a zpřístupnění takových informací. Tyto zásady platí pro informace, které shromažďujeme na těchto stránkách nebo v e-mailu, textových a jiných elektronických zprávách mezi vámi a těmito stránkami. Rovněž popisují vaše možnosti týkající se využívání vašich osobních údajů, přístupu k nim a jejich opravě.	Všechna výše uvedená pole. Toto je také výchozí pole pro dotazy na syntaxi Lucene.

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

*I když Ringgold identifikátory stále existují v rámci ORCID registru od 1. srpna 2023, ORCID již nedostává aktualizace databáze identifikátorů organizace RINGGOLD používané naším registrem, ani nebudeme moci zpracovávat nebo používat ID RINGGOLD vytvořené po tomto datu. Podívejte se na naše Nejčastější dotazy pro více informací

Pomohl vám tento FAQ?

1

1

Trvalý

Stránkování výsledků vyhledávání

API ve výchozím nastavení vrací 1000 výsledků (nebo řádků) jak na veřejné, tak na členské API. Chcete-li zobrazit určitý počet najednou nebo k získání posledních 1000 výsledků, přidejte parametry pro počáteční bod a počet výsledků. Maximální počet výsledků, které lze najednou vrátit, je také 1000 XNUMX.

Příklad vyhledávání na veřejném rozhraní API karantény pro druhých 1000 výsledků odpovídajících klíčovému slovu „orcid“:

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=orcid&start=1000&rows=1000

Příklad hledání ve veřejném API karantény pro položky 2 až 4 ve vyhledávání s výrazy „johnson“, „cardiology“ a „houston“:

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+cardiology+houston&start=2&rows=3

Ukázkové dotazy pomocí veřejného API

Příklad 1

Hledejte příjmení všech ORCID záznamy pro název „Sanchez“

Příklad 2

Hledat ve všech prohledávatelných polích všech ORCID záznamy pro slovo „English“

Příklad 3

Vyhledejte přispěvatele spojené s dílem na PubMed ID 2485-7732

Příklad 4

Vyhledejte záznamy s příjmením „Einstein“ a klíčovým slovem „Relativity“. Budou vráceny pouze záznamy obsahující příjmení i klíčové slovo.

Příklad 5

Hledejte záznamy s příjmením Taylor a křestním jménem Michael.

Příklad 6

Hledejte křestní jména a příjmení všech ORCID záznamy pro „Raymond“, ale posílit příjmení. Záznamy s křestním jménem obsahujícím „Raymond“ a příjmením obsahujícím „Raymond“ budou vráceny, ale ty s příjmením se objeví v horní části seznamu a budou mít vyšší skóre relevance.

Příklad 7

Hledejte křestní jména a příjmení všech ORCID záznamy pro „Raymond“, ale posílit příjmení. Záznamy s křestním jménem obsahujícím „Raymond“ a příjmením obsahujícím „Raymond“ budou vráceny, ale ty s příjmením se objeví v horní části seznamu a budou mít vyšší skóre relevance. ORCID ID https://sandbox.orcid.org/0000-0002-0879-455X a https://sandbox.orcid.org/0000-0001-6238-4490 bude z výsledků vyloučeno.

Příklad 8

Vyhledejte záznamy s přesným nastavením DOI 10.1087 / 20120404 na sebe

Příklad 9

Vyhledávejte záznamy pomocí DOI, který obsahuje 10.1087 nastavenou buď na sebe, nebo na část

Příklad 10

Vyhledejte záznamy s identifikátorem PubMed 27281629 nastaveným na sebe

Příklad 11

Hledejte záznamy s identifikátorem ISBN včetně 1234 nastaveného na sebe nebo na část

Příklad 12

Vyhledejte všechny záznamy s e-mailovou adresou s doménou @orcid.org

Příklad 13

Vyhledejte záznamy upravené od 1. ledna 2017 do dneška

Příklad 14

Vyhledejte záznamy přidružené k organizaci s přesným názvem „Boston University“ nebo „BU“

Příklad 15

Vyhledávání záznamů přidružených k Ringgold ID* 1438 (University of California Berkeley) ve formátu CSV

Příklad 16

Vyhledejte záznamy přidružené k mřížce ID GRID.5509.9 (University of Tampere) pomocí rozšířeného vyhledávání

* Přestože Ringgold identifikátory stále existují v rámci ORCID registru od 1. srpna 2023, ORCID již nedostává aktualizace databáze identifikátorů organizace RINGGOLD používané naším registrem, ani nebudeme moci zpracovávat nebo používat ID RINGGOLD vytvořené po tomto datu. Podívejte se na naše Nejčastější dotazy pro více informací