我經常被問到如何 ORCID 設法不斷更新註冊表以添加新功能,但仍然支持其擁有和運營的許多企業級系統 ORCID 使用我們的 API 的成員組織。 最根本的答案是靈活性。 但是,當然,它比這更複雜一些。
有點歷史
當我們於 2012 年 1.0.1 月首次推出時,我們從 API 版本 1.0 開始。 (我們之前的原型是 XNUMX 版。)正如您可以想像的,在第一年中,我們進行了許多增強並添加了重要的新功能,例如將資金和隸屬關係連接到一個 ORCID 記錄。 對於每一項改進,我們都保持了向後兼容性,使組織能夠在閒暇時進行更新。 一年後(23 次更新!),我們發現我們正在積極支持 23 個版本的 API。 這需要大量的人力資源來管理,並且意味著我們沒有足夠的時間來添加我們的會員和用戶尋求的更多功能和改進。 更糟糕的是,幾乎所有 API 用戶都使用 1.0.7 或更早版本,這意味著他們無法從我們正在實現和支持的新功能中受益。 顯然這個過程對任何人來說都效果不佳!
聚焦我們的方法
2013 年 XNUMX 月,我們開發了一種方法,其目標如下:
- 將同時支持的 API 數量保持在我們的小團隊可管理的水平。
- 向 API 用戶提供有關主要和次要 API 更新的更好信息。
- 為希望訪問最新更新和功能以及需要長期、企業穩定 API 的 API 用戶提供服務。
- 為積極遷移到新版本的 API 用戶提供靈活性,但需要額外的支持或過渡時間。
企業穩定 API
我們現在每年發布一次新的企業穩定 API 版本,通常在一月份。 該版本包含上一年的所有新功能、更新和改進。
- 雖然之前的企業穩定版本仍然有效,但它被認為是“已棄用”。
- API 用戶會在日落日期前 3-6 個月獲知兩個版本之間的差異,並獲得更新系統的文檔和支持。 我們還向已與會員 API 建立集成的技術聯繫人發出通知。
- 一段時間後,舊版本將被“日落”,之後不再受到積極支持。 最終舊版本將不再有效。
- 積極支持兩個版本的時間長短取決於更改的程度以及更新所需的工作量。
- 我們致力於我們的會員。 在停止對已棄用的 API 版本的支持之前,我們始終確保它們已成功遷移到新版本。
創新API
對於希望儘早訪問新功能和改進的會員,我們提供更頻繁的候選版本 API,其中包含最新的創新。
- 這些版本提供了下一個企業穩定版本中可能的更新的早期視圖。
- 它們包括我們正在測試的功能,並使 API 用戶能夠更早地嘗試新功能。
- 候選版本通常不受支持且文檔有限。 這 ORCID 開發團隊非常有興趣與成員合作使用候選版本來改進臨時功能。
我們在我們的網站中提供有關當前版本、更改發生日期等的詳細信息 版本文檔。 我們還建議任何使用該 API 的人成為 API用戶組 我們在這里分享有關 API 的最新信息。