七月標誌著 我們發布後的第五個月 ORCID API v2.0,我們很高興地報告,公共和會員 API 的許多用戶已經或正在升級。 為了鼓勵那些尚未開始升級的人,我們想強調 v2.0 的一些特性 這將簡化您的工作流程,減少傳輸文件的大小,並使您的 ORCID 集成更適合您和您的用戶。
更少的範圍,更少的混亂
我們的舊 API 使您能夠請求大量 來自用戶的權限:在一個部分中創建項目、閱讀同一部分並更新它的權限。 為每個部分請求單獨的權限會導致一系列讓用戶感到困惑的請求。
在 API v2.0 中,我們已經 鞏固我們的範圍 分成三個,它允許您請求讀取(有限)和更新對所有部分的訪問 ORCID 記錄。
仍然擁有那些處於舊權限的令牌? 不用擔心 - 他們將繼續在最初授予的訪問級別上工作。 但是,如果您升級的系統具有涉及訪問其記錄其他部分的新功能,您可能希望構建一個工作流以請求用戶刷新其權限。
按項目讀取和更新
使用以前版本的 API,如果您的系統需要在您添加了多個作品的記錄上添加新的單個作品,那麼它必須更新整個作品部分,包括新作品和所有以前添加的作品。 因此,更新記錄上的單個項目涉及發送一個潛在的大文件,其中包含沒有更改的其他項目,或者丟失該部分中的所有項目,甚至整個記錄。
v2.0 通過以下方式簡化了此過程 單獨管理項目. 你的系統可以 將單個作品添加到 ORCID 記錄,然後編輯或刪除該單個作品。 這是通過實現 把代碼 對於個別項目 ORCID 註冊表。 例如,如果您的系統將新的僱傭關係添加到 ORCID 記錄, ORCID API 會返回一條確認消息以及您的系統僅可用於更新或刪除該項目的放置代碼。 通常,一次只能添加、編輯或刪除一個項目。 ORCID 記錄。 唯一的例外是作品,對於許多研究人員來說,這構成了他們的大部分 ORCID 記錄。 API v2.0 允許您的系統 閱讀多達 50 部作品 一次,並 最多可添加 100 個作品 一次。 編輯或刪除作品仍然必須以項目為基礎進行。
放置代碼具有追溯力:在 1.2 及更早版本中添加的項目都已分配放置代碼。 當您為 v2.0 升級系統時,請記住為其相應的放置代碼添加一個字段。 您可以查詢一個 ORCID 記錄以獲取您的系統添加到註冊表中的任何項目的放置代碼,並相應地更新您的數據庫,以便您將來能夠根據需要更新它們。
更快地讀取記錄
API v2.0 與之前的 API 一樣,允許您的系統 在一次調用中讀取單個部分或整個記錄. 返回的不會是記錄上的所有數據,而是三個部分的摘要視圖,這三個部分往往是最大的 ORCID 記錄:作品、資金和同行評審。
無論您的系統讀取完整記錄還是單個部分, 摘要視圖 顯示這些活動。 摘要包含的信息有限:例如,作品摘要僅返回作品名稱、類型、日期、其唯一標識符及其與作品的關係、項目每個版本的顯示索引(如果有多個版本)、項目的每個版本的源(用戶或 API 客戶端)和相應的放置代碼。
摘要視圖減少了文件大小和傳輸時間,減少了我們系統和您的系統的潛在壓力,並使更新速度更快。
這麼多!
v2.0 中還有很多值得高興的地方:靈活支持外部標識符,添加同行評審活動,更清晰地對多個版本的活動進行分組,默認搜索結果更大,等等。
想了解更多? 加入我們! 每個月我們都會舉辦多個時區和語言的網絡研討會,而在今年餘下的時間裡,我們將討論升級到 API v2.0。 檢查我們的下一個列表, 或者 聯繫我們 (contact us) 了解更多信息。
您是否已經升級到 API v2.0? 讓我們知道您的經驗!