Často se mě ptají jak ORCID dokáže průběžně aktualizovat registr a přidávat nové funkce, ale stále podporuje mnoho podnikových systémů vlastněných a provozovaných společností ORCID Členské organizace, které používají naše API. Závěrem je flexibilita. Ale samozřejmě je to trochu víc než to.
Trochu historie
Když jsme poprvé spustili v říjnu 2012, začali jsme s API verze 1.0.1. (Náš předchozí prototyp byl verze 1.0.) Jak si dokážete představit, během prvního roku jsme provedli mnoho vylepšení a přidali nové důležité funkce, jako je schopnost propojit financování a přidružení k ORCID Záznam. U každého z těchto vylepšení jsme udržovali zpětnou kompatibilitu, což organizacím umožňovalo aktualizaci ve svém volném čase. O rok (a 23 aktualizací!) Později jsme zjistili, že aktivně podporujeme 23 verzí našeho API. To vyžadovalo značné personální zdroje pro správu a znamenalo to, že jsme měli méně času na přidání dalších funkcí a vylepšení, které naši členové a uživatelé hledali. Ještě horší je, že téměř všichni uživatelé API používali verzi 1.0.7 nebo dřívější, což znamená, že nevyužívali výhody nových funkcí, které jsme implementovali a podporovali. Je zřejmé, že tento proces nikomu nefungoval dobře!
Zaměření našeho přístupu
V listopadu 2013 jsme vyvinuli přístup s následujícími cíli:
- Udržujte počet současně podporovaných API na zvládnutelné úrovni pro náš malý tým.
- Poskytněte uživatelům rozhraní API lepší informace o hlavních a vedlejších aktualizacích rozhraní API.
- Slouží uživatelům rozhraní API, kteří by chtěli mít přístup k nejnovějším aktualizacím a funkcím, a těm, kteří vyžadují dlouhodobější podnikově stabilní rozhraní API.
- Umožněte flexibilitu uživatelům rozhraní API, kteří aktivně migrují na novější verze, ačkoli potřebují další podporu nebo čas na přechod.
Enterprise-Stable API
Nyní vydáváme novou, podnikově stabilní verzi API jednou ročně, obvykle v lednu. Tato verze obsahuje všechny nové funkce, aktualizace a vylepšení z předchozího roku.
- Zatímco předchozí verze stabilní pro podnik je stále funkční, považuje se za „zastaralou“.
- Uživatelé API jsou informováni 3–6 měsíců před datem ukončení platnosti o rozdílech mezi těmito dvěma verzemi a je jim poskytována dokumentace a podpora pro aktualizaci jejich systému. Poskytujeme také oznámení našim technickým kontaktům, kteří vytvořili integraci s API člena.
- Po určité době je stará verze „západem slunce“, poté již není aktivně podporována. Stará verze nakonec již nebude fungovat.
- Doba, po kterou jsou obě verze aktivně podporovány, se liší v závislosti na rozsahu změn a úsilí potřebném k provedení aktualizace.
- Zavázali jsme se k našim členům. Před ukončením podpory pro zastaralou verzi API VŽDY zajistíme, aby úspěšně migrovali na novou verzi.
Inovační API
Pro naše členy, kteří chtějí dřívější přístup k novým funkcím a vylepšením, poskytujeme častější verze kandidátských rozhraní API, která obsahují nejnovější inovace.
- Tyto verze poskytují časný pohled na aktualizace pravděpodobně v příštím vydání stabilním pro podnik.
- Zahrnují funkce, které testujeme, a umožňují uživatelům rozhraní API vyzkoušet si nové funkce dříve.
- Uvolnění kandidáti jsou obecně nepodporovaní a mají omezenou dokumentaci. The ORCID vývojový tým má velký zájem spolupracovat se členy, kteří používají kandidáty na vydání ke zlepšení provizorní funkčnosti.
Podrobnosti o aktuálních verzích, datech, kdy dochází ke změnám, a další naleznete v našem dokumentace k verzi. Doporučujeme také, aby se každý, kdo používá API, stal členem Skupina uživatelů API kde sdílíme nejnovější informace o API.