ORCID 提供多種 API,允許您的系統連接到 ORCID 註冊表,包括讀取和寫入 ORCID 記錄。 某些 API 函數可供任何人免費使用(公開API); 其他人只能使用 ORCID 會員組織(會員和高級會員 API)。 任何人都可以在我們的沙盒測試服務器上自由測試我們的任何 API。
在你開始之前
當您開始進行集成規劃時,您應該考慮:
- 你想用 ORCID API——請訪問我們的 工作流程 整合最佳實踐。 如果您是 ORCID 會員組織您可以聯絡我們或您的聯盟領導尋求協助! 。
- 您使用的系統是否已經支持 ORCID。如果是的話,這可能就像配置您的系統一樣簡單 ORCID。請檢查我們的 ORCID 認證服務提供者列表 查看您的系統是否包含在內
- 您將如何與您的研究人員就正在實施的更改進行交流,您需要從他們那裡得到什麼,給他們帶來的好處,以及他們需要做什麼。 訪問我們的 外聯資源 有關如何圍繞新整合建立溝通活動的想法頁面。我們也建議您觀看我們的網路研討會'我現在是會員了怎麼辦?如何談論 ORCID
註冊沙箱憑據並創建測試 ORCID iD
如果您正在建立自訂整合或使用未經認證的服務提供者應用程序,那麼我們要求您先使用我們的沙盒環境來建置和測試您的整合。
您可以 請求沙箱會員 API 憑證 建立並測試您的應用程式。這些憑證可讓您呼叫沙盒高級會員 API 來讀取、寫入和更新 ORCID 記錄。 任何人都可以免費訪問沙盒測試環境,即使您不是 ORCID 會員組織。
備註:如果您使用的是 ORCID 已支援的認證服務提供者係統 ORCID,您不需要註冊沙盒 API 憑證,除非您想嘗試 ORCID 沙盒環境中的整合功能。
沙箱讓您可以創建測試用戶帳戶並開發您的集成,而不必擔心影響實時(生產)上的數據 ORCID 註冊表。 沙箱的行為方式與生產相同 ORCID 註冊與 一些例外.
創建測試帳戶
為了測試 ORCID API 和 API 調用,例如讀取和添加信息到 ORCID 記錄,您還需要創建一個測試 ORCID 記錄在沙箱中。 這可以通過用戶界面完成,就像在生產中一樣 ORCID 註冊表。 去 https://sandbox.orcid.org/register 並註冊一個帳戶。
郵寄者電子郵件地址
沙盒伺服器僅將電子郵件發送至 Mailinator (@mailinator.com) 電子郵件地址,以免無意中向郵件服務器發送垃圾郵件。 除非您使用@mailinator.com 地址,否則您不會收到驗證電子郵件或密碼重置通知,並且需要驗證才能對沙盒記錄進行任何手動編輯。 詳細了解他們免費使用的公共收件箱 並點選這裡。 如果您不想使用 Mailinator 地址,然後請記下您的用戶名和密碼(因為您將在測試時使用它們向您的應用程序授予授權),並聯繫我們請求驗證幫助。
Mailinator 是一種具有公共免費服務和私人付費服務的電子郵件服務。 對於測試,您可以使用完全免費的公共服務。 了解更多關於他們的等級 這裡.
Mailinator 是第三方服務,不受管理或維護 ORCID. 我們建議您在使用這些地址之前查看此服務的工作原理及其限制。
確定您需要的用戶權限
ORCID 會員 API 可用於讀取、添加或更新用戶的信息 ORCID 記錄-你只需要請求你的研究人員的許可。
當請求與某個人交互的權限時 ORCID 用戶的記錄中,您可以指定一個或多個“範圍”。 每個範圍都允許您執行某些操作,例如讀取記錄或更新特定部分。
3條腿 指獲取用戶許可所涉及的三個參與者; ORCID,您的系統和用戶自己。
/認證 
此範圍用於收集 ORCID iD 並僅閱讀記錄中的公共信息。 所有其他 3-legged 範圍都包括身份驗證權限,因此如果要求任何其他訪問權限,則可以省略此範圍。 此範圍在成員或公共 API 上可用。
/read-limited(僅限會員 API) 
此範圍用於訪問讀取公共和有限可見性項目上的 ORCID 記錄。 此範圍僅在成員 API 上可用。
/activities/update(僅限會員 API) 
此範圍用於編寫、更新和刪除某個機構的隸屬關係、資助、作品、專業活動、研究資源和同儕審查部分中的項目。 ORCID 記錄。 此範圍僅在成員 API 上可用。
/person/update(僅限會員 API) 
此範圍用於寫入、更新和刪除記錄的其他名稱、關鍵字、國家/地區、研究人員 URL、網站和個人外部標識符部分中的項目。 此範圍僅在成員 API 上可用。
Openid
當需要 id_token 時,OpenID 集成商使用此範圍。 當包含 openid 範圍時,註冊表將在令牌響應中返回一個 id_token 並授予客戶端訪問該用戶的用戶信息端點的權限。 此範圍在公共和成員 API 上可用。
請注意,“openid”作用域不像其他作用域那樣以“/”開頭 ORCID API 範圍。 這是因為“openid”範圍不是由 ORCID,而是由 OpenID Connect 規範定義。 請看我們的 OpenID 文檔 獲取更多訊息
多個範圍
通過在身份驗證 URL 中列出範圍並在每個範圍之間使用編碼空格,可以在單個交互中請求多個範圍,例如 scope=/read-limited%20/activities/update%20/person/update
完全訪問
如果您想要讀取和編輯記錄的完全訪問權限,請在您的身份驗證 URL 中包含三個範圍:/read-limited、/activities/update 和 /person/update。 在 URL 中,它們將顯示為 scope=/read-limited%20/activities/update%20/person/update
2 條腿(客戶端憑據)範圍
對於某些活動,您不必徵求用戶的許可。 直接從 請求兩個分支的 OAuth 範圍 ORCID API,不需要研究人員授予許可。 具有這些範圍的代幣有效期為 20 年並可重複使用
/讀公開
此範圍用於讀取有關單個的公共信息 ORCID iD,搜尋 ORCID 記錄或讀取摘要資訊(僅限會員 API)。此範圍可在會員或公共 API 上使用。
/ webhook
此範圍允許客戶端應用程序在 ORCID 記錄,以便在記錄更新時接收通知。 此範圍適用於高級 ORCID 內部使用。
確保您可以安全地存儲數據
重要的是您的系統能夠存儲信息 以安全的方式.
集成需要存儲的不僅僅是 ORCID 記錄。 您的系統需要能夠:
- 接受並存儲 ORCID iD:您的系統需要知道 iD 的 ORCID 記錄以顯示 iD 並正確更新。將其與令牌交換響應中返回的研究人員資訊儲存在一起。我們的建議是儲存完整的 https URI: https://orcid.org/0000-0001-5727-2427.
- 接受並存儲持久化 訪問令牌 刷新令牌:訪問令牌可用於讀取和更新記錄,以及指示 iD 已被認證。存取權杖的有效期約為 20 年,或直到使用者撤銷為止。我們還建議您存儲 令牌範圍, 令牌到期 刷新令牌。如果需要,刷新令牌可用於建立具有相同或有限範圍的新存取權杖。將存取令牌令牌資料與研究人員的資訊儲存在一起。
- 接受並存儲 把代碼 :您新增到的每個項目 ORCID 註冊表將返回一個放置代碼 ORCID API。將這個 6 位數字的代碼與項目一起保存在您的系統中,這樣您就可以識別哪些項目需要讀取、更新或刪除。
- 當交互未按預期進行時,提供錯誤消息和支持聯繫人。
與 ORCID 團隊或您的聯盟領導來演示您的應用程式如何運作
在您的集成上線之前 ORCID 生產註冊表、我們的參與團隊或您的聯盟負責人將仔細檢查您在沙箱上建立的所有內容是否也適用於生產。如果您正在使用 ORCID 認證服務提供者係統這一步驟可以跳過。我們有一個清單 最低要求 在我們頒發會員 API 生產憑證之前需要滿足這些要求。
會員組織要求 ORCID 通過完成生產(實時)服務器上的成員 API 憑據 生產會員API客戶端申請表. 在發布生產會員 API 憑證之前, ORCID 參與團隊/聯盟負責人將審核您在 ORCID 沙箱。這使我們有機會看到您建立的出色整合並提供工作流程改進,並檢查所有整合是否符合我們的最佳實踐和最低啟動要求。
要提供您的系統的演示,您需要設置與 ORCID 沙箱 ORCID 團隊可以預覽。 有幾種方法可以共享您的工作沙箱集成:
- 推薦: 現場演示: 聯繫我們安排現場演示。我們將提供會議軟體,允許您共享螢幕以演示整合。
- 測試地點: 如果您的開發站點是公開的, 把網址發給我們 以及訪問系統的測試憑據(如果需要)和描述如何使用系統的說明 ORCID 特徵。 提供額外的文檔以驗證我們無法從用戶端看到的內容,例如使用的 API 版本、您的系統存儲了哪些數據等。
- 截圖影片或螢幕截圖:發送錄音或一組截圖 描述清楚地解釋和展示了整合在每個步驟中的工作原理,包括如果使用者拒絕存取或斷開其 ID 的連接會發生什麼情況。請務必提供額外的文件來驗證我們無法從用戶端看到的任何內容,例如使用的 API 版本以及資料的儲存方式
會員組織要求 ORCID 通過完成生產(實時)服務器上的成員 API 憑據 生產會員API客戶端申請表。如果您使用的供應商系統不在清單中 ORCID 認證服務提供商,您的整合需要經過審核流程,以保證 整合和最佳實踐的最低要求 被滿足。
您可以聯繫您的未經認證的服務提供者,並直接從他們那裡獲取滿足最低標準的證據。您需要將此證據發送至 ORCID 參與團隊或您的聯盟領導。
有幾種方法可以分享此證據:
- 截圖影片或螢幕截圖:發送一段錄音或一組螢幕截圖,並附上說明,清楚地解釋和演示您的整合在每個步驟中的工作原理,包括如果使用者拒絕存取或斷開其 ID 的連接會發生什麼情況。請務必提供額外的文件來驗證我們無法從用戶端看到的任何內容,例如使用的 API 版本以及資料的儲存方式。
- 公開可用的整合文檔:提交可公開訪問的最新鏈接,其中包含有關集成在每個步驟中如何工作的清晰說明。與選項 1 一樣,請務必提供額外的文件來驗證我們無法從使用者端看到的任何內容,例如使用的 API 版本以及資料的儲存方式。
請求成員 API 憑證
一旦您的集成通過審核,您就可以申請成員 API 憑證 ORCID 團隊或如果您正在使用 ORCID 認證服務提供者體系。
您需要填寫 用於註冊客戶端應用程序的表單. 以下是請求字段的快速概覽:
組織名稱: 你的 ORCID 會員組織名稱
憑證的主要聯絡電子郵件地址: 我們將使用此電子郵件地址透過加密電子郵件向您發送憑證,並在您的整合過程中出現任何問題或錯誤時與您聯繫
密碼的輔助信箱:我們可以將您的加密電子郵件密碼傳送到的電子郵件地址。
您的客戶姓名: 這將是你的 ORCID 成員組織名稱。如果您有超過 1 個集成,我們會將應用程式附加到名稱中。
您的應用程式主頁的 URL: 顯示為用戶內受信任組織列表上的鏈接 ORCID 受信任方頁面。 這應該是返回您的組織或應用程序主頁的鏈接。
您的客戶端應用程序的簡短描述:此文字將顯示在授權畫面上,並帶有問號圖示給您的整合使用者。需要對您的整合進行簡短描述
重定向 URI: 用戶授權您的應用程序後,他們將返回到您指定的 URI。 您必須提前提供這些 URI,否則您的集成用戶將遇到錯誤。
- 僅接受 HTTPS URI。
- 註冊的網域必須與使用的網域完全匹配,包括子網域。
- 盡可能完整註冊所有重定向 URI。
- 需要超過 5 個重定向 URI? 請在備註中註明 ORCID 員工。
的注意事項 ORCID 員工: 使用這個字段讓 ORCID 工作人員了解有關您的請求或您的融入的任何其他信息
將您的申請轉移到 ORCID 生產登記處
獲得憑證後,您就可以開始整合了。如果您想在向公眾發布之前測試您的集成,請使用測試人員自己的 ORCID 記錄或同事的 ORCID 記錄。
啟動——並讓所有人知道
使應用程序上線並不是最後一步——您需要繼續與您的用戶溝通,以便他們知道連接他們的 ORCID iD 快速輕鬆地連接到您的系統。 有效的集成包含技術組件(本指南涵蓋)和社交組件。 研究人員需要被告知什麼 ORCID 是,為什麼您要求訪問他們的 ORCID 記錄,以及您將如何處理他們的數據。
- 創建溝通時間表:確保利益相關者了解您的 ORCID 在您啟動之前做好項目。
- 結合使用自上而下和自下而上的溝通方式。
- 推廣你的 ORCID 經常和不同的受眾進行整合。
- 創建本地資源 為您的用戶提供支持,例如常見問題解答、libguides、網頁、教程和視頻。
- 指定當地聯繫人 ORCID-相關問題。
如果您需要任何協助,請聯絡您的參與主管或您的聯盟主管