ORCID si klade za cíl podporovat 2 hlavní verze API najednou. Když je vydána nová hlavní verze API, ORCID zaručuje podporu po dobu nejméně tří let od data vydání. Před vyřazením nejstarší hlavní verze navíc upozorňujeme na 12 měsíců a zasíláme pravidelné e-maily s upomínkami těm členům, kteří ji během výpovědní doby stále používají. Nové hlavní verze jsou vyžadovány vždy, když provedeme prolomení změn v našem schématu metadat a jsou označeny přírůstkem čísla hlavní verze. ORCID vydává novou hlavní verzi API každé 2–4 roky.

Za výjimečných okolností ORCID může zvážit prodloužení 12měsíčního období odchodu do důchodu při vydání nové hlavní verze API, ale to vyžaduje ORCID investovat další prostředky do údržbových prací s následným dopadem na další činnosti, jako je nový vývoj a podpora. ORCID si vyhrazuje právo účtovat dodatečné poplatky za další používání vyřazené verze API po datu odchodu do důchodu, aby pomohly vyrovnat vzniklé dodatečné náklady.

ORCID má zásadu postupného ukončování podpory API, která nám umožňuje rozvíjet naše nabídky API a reagovat na potřeby komunity mezi hlavními verzemi. Tohle znamená tamto ORCID může provádět neporušené změny v kontrolovaných slovnících a polích metadat aktuální verze API.

Uživatelé nejnovější verze API mohou tyto změny ignorovat, měli by si však být vědomi toho, že je lze provést
Uživatelé předchozí verze API neobdrží data, která nelze modelovat v jejich verzi

Příkladem v době psaní tohoto článku je zavedení taxonomie role přispěvatele CREDIT do rozhraní API v3.0. Jakmile začnou fungovat, integrace v2.x pomalu ztratí viditelnost rolí přispěvatelů, protože stále více výzkumníků a integrací přijímá CREDIT. Uživatelé verze 2.x se nerozbijí, ale postupem času dostanou méně bohatá metadata.

Při vývoji nové hlavní verze API je to normální ORCID vyrábět verze „Release candidate“. Jsou zaměřeny na integrátory, kteří jsou schopni upgradovat včas po vydání plné verze API. Očekávaná životnost kandidáta na vydání je maximálně 12 měsíců od vydání hlavní verze, pro kterou byl vyvinut.

Integrátorům doporučujeme, aby postupovali podle Princip robustnosti (aka Postelův zákon) při použití ORCID API.

Pozadí

ORCID od svých skromných začátků pomalu vyvinul své API.

API v1.x (spuštění ~ 2012 společně s registrem) se pokusilo vrátit všechna metadata o výzkumných pracovnících a jejich aktivitách v jediné odpovědi API. Integrátoři byli povinni upravit tato metadata a poslat je zpět jako celek za účelem přidání nových položek nebo aktualizace stávajících. Byl to rozumný první pokus, ale nezměnil se a přidávání a aktualizace bylo bolestivým úkolem. (V důchodu, březen 2018)

API 2.x (vydáno 2017. února XNUMX) rozdělilo naše API do sekcí; práce, přidružení, financování, biografie atd. Byl to velký krok vpřed a umožnil nám i našim klientům mnohem jednodušší správu velkých záznamů. Většina našich ověřovacích a kontrolovaných slovníků však byla ve schématu pevně zakódována, takže bylo obtížné reagovat na změnu

API 3.x (vydané v květnu 2019) přidalo do záznamu nové sekce, jako jsou výzkumné zdroje, zjednodušilo strukturu schématu a poskytlo ORCID s další flexibilitou. Přesunula velkou část ověření ze schématu na naše servery, což nám umožnilo opravit problémy a přidat nové typy identifikátorů bez vydání dalších verzí API.

Vydání nového významného rozhraní API je velkým úkolem - k jeho vytvoření je zapotřebí let úsilí vývojářů a naši členové potřebují roky, aby upgradovali své integrace. Z tohoto důvodu se snažíme omezit provedené změny. Abychom co nejlépe sloužili komunitě, chtěli bychom provést několik změn.

Naším úkolem je vypracovat, když máme kritické množství k vydání nové verze API, nebo vypracovat způsoby, jak aktualizovat naše existující API bez porušení existujících integrací.