註冊公共 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 會員 。

ORCID 根據您使用的 API 支援不同的 API 使用配額和速率限制。 

請求第二個 是每秒可以發出的請求數。 

爆發 是我們在拒絕之前允許排隊的請求數量。佇列中的請求速度減慢到每秒一個請求的速率。如果超出突發量，您將收到 503 回應。 

如果您超出使用配額，那麼您將無法在該時間範圍內提出進一步的請求。 

請記住 ORCID 公共 API 可供個人免費使用，如 公共 API 服務條款。 「非商業」的意思是，您不得對公共 API 收取任何重複使用費用，且不得將公共 API 用於任何創收產品或服務。 

使用帶有客戶端憑證的公共 API 將允許您的整合獲得比匿名 API 更高的使用配額。請參閱我們的 整合指南 關於如何註冊公共 API 用戶端。 

如果你經常超出公共 API 的使用配額，那麼我們建議你考慮成為 ORCID 會員可訪問我們的 會員API。它不僅允許您存取更高的速率限制和不受限制的使用配額，而且您將能夠存取受信任方數據 ORCID 記錄並提供數據 ORCID 在獲得使用者許可的情況下，從您的機構系統中取得記錄。