ORCID 提供一個公共 API,允許非 ORCID 成員將他們的系統和應用程序連接到 ORCID 具有機器對機器通信的註冊表。 API 是一個 RESTful API,同時支持 XML 和 JSON。
公共 API 可用於以下功能:
我們建議開發人員在 沙盒測試服務器 在使用生產版本之前。 以下是有關如何在沙盒和生產環境中註冊公共 API 憑證的步驟。
- 登錄你的 ORCID 記錄:
生產服務器: https://orcid.org/signin
沙盒測試服務器: https://sandbox.orcid.org/signin - 在右上角點擊你的名字
- 點擊 開發者工具 從菜單選項
注意: 為了訪問開發人員工具,您必須驗證您的電子郵件地址。 如果您尚未驗證您的電子郵件地址,系統會提示您進行驗證,然後才能註冊公共 API 憑據 - 閱讀並同意‘ORCID 公共 API 服務條款
- 點擊“註冊 ORCID 公共 API 憑證”按鈕。
填寫申請詳情表
- 註冊公共 API 憑證後,您將被引導回開發人員工具(https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
- 您需要填寫提交的申請詳細信息表以註冊新申請。
- 名稱:您的應用程序的名稱。 當用戶授予您的應用程序權限以獲取他們的權限時,這將顯示給用戶 ORCID iD,它將顯示在他們的 受信任組織列表. 我們建議使用您的組織或服務的名稱(例如期刊名稱)。
- 申請網址: 用戶可以訪問該網站以了解有關您的應用程序的更多信息。 這也將顯示在他們的 受信任組織列表.
- 應用說明:有關您正在開發的應用程序以及您將如何使用用戶的應用程序的信息 ORCID ID。 這將在 OAuth 屏幕上向用戶顯示。
將 重定向 URI
用戶授權您的應用程序後,他們將返回到您指定的 URI。 您必須提前提供這些 URI,否則您的集成用戶將遇到錯誤。
- 在提供的框中輸入您的重定向 URI
- 如果您需要輸入超過 1 個重定向 URI,請單擊“添加另一個重定向 URI”
請注意:
- 只 HTTPS URI 已在生產中接受
- 已註冊的域 必須(MUST) 與使用的域完全匹配,包括子域
- 盡可能完整註冊所有重定向 URI。 這是最安全的選項,也是我們推薦的選項。 有關重定向 URI 的更多信息,請參閱我們的 重定向 URI 常見問題解答
保存您的申請
填寫完申請表並添加重定向 URI 後,您可以保存您的申請。
- 點擊“儲存我的申請並產生我的客戶端 ID 和密碼”
您將被引導回開發人員工具頁面,該頁面現在將包含您的公共 API 客戶端憑據
更新您的憑據
更改您的申請信息非常簡單。
- 編輯相關信息,然後點擊“保存申請”
使用您的憑據
現在您已擁有憑據,是時候開始使用 ORCID 公共API!
請注意,如果您成為會員,我們可以將您的憑據傳輸到會員 API ORCID 會員 。
瀏覽我們 API 用戶組 有關設置與公共 API 集成的更多信息,請參閱主題。 然而,為了最大化利益 ORCID,我們推薦你 加入 ORCID 作為組織成員,它提供了對附加功能的訪問、我們集成團隊的個人協助,當然也有助於支持我們的工作。