Snažíme se poskytovat v našem registru a API popisné chybové zprávy. Zde je několik tipů, které vám pomohou s případnými chybami, se kterými se můžete setkat.
Chyby API
Naše chybové kódy API obsahují popisné zprávy, které by měly být snadno srozumitelné.
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.
Chyby formátování XML / JSON
Pokud máte potíže s formátováním dat, která se pokoušíte přidat nebo aktualizovat na ORCID záznamu doporučujeme konzultovat příklady:
- Odeslání volání ke čtení záznamu nebo jednotlivé položky k přijetí příkladu XML / JSON, nebo pokud aktualizujete záznam, úplný XML / JSON pro položku, kterou aktualizujete, a použijte jej jako výchozí bod
- Konzultujeme naše ukázkové soubory XML a JSON v našem úložišti GitHub - máme jak čisté XML / JSON pro zveřejňování, tak úplné XML / JSON pro příklady čtení
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:
všimněte si, že různé verze rozhraní 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.
Chyby rozsahu
Pokud dostáváte chyby týkající se oborů, doporučujeme vám:
- Zkontrolujte, že nepoužíváte rozsahy členů u veřejného klienta API.
- Pokud přidáváte, aktualizujete nebo čtete data s omezenou viditelností, že máte správné obory k provedení akce.
- Zkontrolujte, zda nepožadujete dvounohé obory pomocí třínohého OAuth a naopak.
Při žádosti o povolení k interakci s ORCID záznam uživatele, určíte jeden nebo více „oborů“. Každý obor umožňuje provádět určité věci, například číst záznam nebo aktualizovat konkrétní část.
3 nohy odkazuje na tři aktéry zapojené do získávání povolení od uživatele; ORCID, váš systém a samotný uživatel.
/ověřit
Tento rozsah se používá ke shromažďování ORCID iD a číst veřejné informace pouze na záznamu. Všechny ostatní obory se třemi nohami obsahují oprávnění k ověření, takže tento rozsah lze vynechat, pokud požadujete jakýkoli jiný přístup. Tento obor je k dispozici na členské nebo veřejné API.
/ read-limited (pouze členské rozhraní API)
Tento obor se používá k získání přístupu ke čtení veřejných a omezeně viditelných položek na ORCID záznam. Tento obor je k dispozici pouze v rozhraní API člena.
/ activities / update (pouze členské rozhraní API)
Tento rozsah se používá k zápisu, aktualizaci a mazání položek v sekcích přidružení, financování, prací, odborných činností, výzkumných zdrojů a odborných posudků ORCID záznam. Tento obor je k dispozici pouze v rozhraní API člena.
/ osoba / aktualizace (pouze členské rozhraní API)
Tento obor se používá k zápisu, aktualizaci a mazání položek v jiných částech záznamu, klíčových slov, zemí, výzkumných adres, webů a osobních externích identifikátorů. Tento obor je k dispozici pouze v rozhraní API člena.
otevřený
Tento obor používají integrátoři OpenID, když je vyžadován id_token. Když je zahrnut rozsah openid, registr vrátí id_token uvnitř odpovědi tokenu a udělí klientovi oprávnění pro přístup k koncovému bodu s informacemi o uživateli pro daného uživatele. Tento obor je k dispozici na veřejné a členské API.
Pamatujte, že obor „openid“ nezačíná znakem „/“ jako ten druhý ORCID Rozsahy API. Je to proto, že obor „openid“ není definován ORCID, ale místo toho definováno specifikací OpenID Connect. Přečtěte si prosím naše Dokumentace OpenID Pro více informací.
Více oborů
V rámci jedné interakce lze požádat o více oborů tak, že seznamy oborů uvedete v ověřovací adrese URL s kódovaným prostorem mezi nimi, například scope = / read-limited% 20 / activities / update% 20 / person / update
Kompletní přístup
Pokud chcete plný přístup ke čtení a úpravám záznamu, zahrňte do své ověřovací adresy URL tři obory: / read-limited, / activities / update a / person / update. V adrese URL by se zobrazily jako scope = / read-limited% 20 / activities / update% 20 / person / update
Dvounohé (pověření klienta) obory
U některých činností nemusíte uživatele žádat o povolení. Dvounohé obory OAuth jsou požadovány přímo z ORCID API a nevyžadují, aby výzkumný pracovník udělil povolení. Tokeny s těmito obory jsou platné po dobu 20 let a lze je znovu použít
/ veřejné čtení
Tento obor se používá ke čtení veřejných informací na jednom ORCID iD, vyhledejte ORCID záznamy nebo ke čtení souhrnných informací (pouze pro členské API). Tento rozsah je dostupný na Member nebo Public API.
/ webhook
Tento obor umožňuje klientské aplikaci zaregistrovat webhook na ORCID záznam, aby bylo možné přijímat oznámení o aktualizaci záznamu. Tento obor je k dispozici prémiovému ORCID pouze členové.
Existují dva různé rozsahy aktualizací - jeden pro biografické podrobnosti a druhý pro aktivity.
Rozsah | Popis | Koncové body API |
/ osoba / aktualizace | Biografické údaje – levý sloupec ORCID zaznamenat uživatelské rozhraní. | /adresa / externí identifikátory / klíčová slova /ostatní jména / adresy výzkumných pracovníků |
/ aktivity / aktualizace | Údaje o výzkumné činnosti – pravý sloupec ORCID zaznamenat uživatelské rozhraní. | /rozdíl / vyznamenání /vzdělání / vzdělávání /zaměstnanost / zaměstnání / financování / financování / pozvaná pozice / pozvány pozice /členství / členství / peer-review / vzájemná hodnocení /kvalifikace /kvalifikace / zdroj výzkumu / zdroje výzkumu /servis / služby /práce / funguje |
Chybové zprávy registru
Obecně se vaši uživatelé při autorizaci připojení k vaší aplikaci setkají pouze s několika chybami souvisejícími s API:
Špatné URI přesměrování
URI přesměrování neodpovídá vašim registrovaným URI přesměrování.
Tato chybová zpráva naznačuje, že váš autorizační odkaz určuje identifikátor URI přesměrování, který jste nezaregistrovali ve svých pověřeních klienta API. Pokud používáte veřejné API, můžete to sami opravit ve svém Vývojářské nástroje. Pokud používáte API člena, budete muset požádat o ORCID Tým provádějící zakázku k aktualizaci vašich přihlašovacích údajů.
Požadovanou stránku nelze najít. Pokud máte tuto stránku označenou jako záložku, smažte ji. Pokud jste sledovali odkaz, nahlaste jej.
K této chybě obvykle dochází, když je autorizační odkaz OAuth nesprávně vytvořen, např https://orcid.org/signin/oauth/authorize?[….] místo https://orcid.org/oauth/authorize?[…]. Chcete-li problém vyřešit, jednoduše opravte odkaz.
Nepopisná zpráva
Došlo k problému se serverem. Pokud problém přetrvává, kontaktujte podporu.
K této chybě nejčastěji dochází, když není zadán žádný obor. Musíte zahrnout obor na autorizační odkaz OAuth; minimální rozsah je / ověřit.
Zkontrolujte, zda ORCID pracuje!
Je to velmi, velmi vzácné, ale pokud si myslíte, že chyba je problém s ORCID Servery, které můžete zkontrolovat na http://status.orcid.org/
Všimněte si, že ORCID Sandbox nemá smlouvu na úrovni služeb a může být po dobu 20 minut nefunkční, když vydáváme aktualizace kódu.
Získání pomoci
Vždy rádi pomůžeme! ORCID členské organizace mohou získat podpora od ORCID přímo.
Všem integrátorům se rovněž doporučuje, aby se připojili k ORCID Skupina uživatelů API, kde můžete komunikovat s dalšími integrátory a uživateli API, stejně jako ORCID tým.