我們盡最大努力在我們的註冊表和 API 中提供描述性錯誤消息。 以下是一些提示,可幫助您解決可能遇到的任何錯誤。
API錯誤
我們的 API 錯誤代碼包含應該易於理解的描述性消息。
XML/JSON 格式錯誤
如果您在格式化您嘗試添加或更新的數據時遇到問題 ORCID 記錄,我們建議通過以下方式諮詢示例:
- 發送調用以讀取記錄或單個項目以接收示例 XML/JSON,或者,如果您正在更新記錄,則是您正在更新的項目的完整 XML/JSON,並以此為起點
- 諮詢我們的 示例 XML 和 JSON 文件 在我們的 GitHub 存儲庫中——我們有乾淨的 XML/JSON 用於發布和完整的 XML/JSON 用於讀取示例
在您可以將項目添加到 ORCID 記錄您需要將數據格式化為 ORCID 架構。 格式化您的數據 ORCID XML 或 JSON 中的消息模式。
我們的 GitHub 存儲庫包含在創建新項目時有助於格式化的資源 ORCID 記錄,並在閱讀現有項目時 ORCID 記錄:
請注意,不同版本的 API 具有不同的消息格式。 版本 2.0 和 2.1 模式和示例也可用.
通過閱讀填充良好的記錄的元數據,可以輕鬆找到更多示例。
範圍錯誤
如果您收到與範圍相關的錯誤,我們建議您:
- 檢查您沒有將成員範圍用於公共 API 客戶端。
- 如果您正在添加、更新或讀取具有執行操作的正確範圍的有限可見性數據。
- 檢查您是否沒有使用 2-legged OAuth 和 vis-versa 請求 3-legged 範圍。
當請求與某個人交互的權限時 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 內部使用。
有兩種不同的更新範圍 - 一種用於傳記詳細信息,另一種用於活動。
範圍 | 產品描述 | API端點 |
/人/更新 | 個人資料-左欄 ORCID 記錄用戶界面。 | /地址 /外部標識符 /關鍵詞 /其他名稱 /研究人員網址 |
/活動/更新 | 研究活動數據-右欄 ORCID 記錄用戶界面。 | /區別 /區別 /教育 /教育 /就業 /就業 /資金 /資金 /邀請位置 /邀請職位 /會員 /會員 /同行評審 /同行評審 /資格 /資格 /研究資源 /研究資源 /服務 /服務 /工作 /作品 |
註冊表錯誤信息
通常,您的用戶在授權與您的應用程序連接時只會遇到一些與 API 相關的錯誤:
錯誤的重定向 URI
重定向 URI 與您註冊的重定向 URI 不匹配。
此錯誤消息表明您的授權鏈接指定了您尚未在 API 客戶端憑據中註冊的重定向 URI。 如果您使用的是公共 API,則可以在您的 開發者工具. 如果您使用的是會員 API,則需要請求 ORCID 參與團隊更新您的憑據。
找不到請求的頁面。 如果您將此頁面添加為書籤,請刪除它。 如果您點擊了鏈接,請舉報。
當 OAuth 授權鏈接格式不正確時,往往會出現此錯誤,例如 https://orcid.org/signin/oauth/authorize?[….] 而不是 https://orcid.org/oauth/authorize?[…]. 要解決,只需更正鏈接即可。
非描述性消息
服務器出現問題。 如果此問題仍然存在,請聯繫支持人員。
當未指定範圍時,最常發生此錯誤。 您必須在 OAuth 授權鏈接中包含一個範圍; 最小範圍是/authenticate。
檢查是否 ORCID 正在工作!
這是非常非常罕見的,但是如果您認為錯誤是 ORCID 您可以查看的服務器 http://status.orcid.org/
請注意 ORCID Sandbox 沒有服務級別協議,在我們發布代碼更新時可能會關閉 20 分鐘。
獲得幫助
我們總是很樂意提供幫助! ORCID 會員組織可以獲得 支持 ORCID 直。
也鼓勵所有集成商加入 ORCID API用戶組,您可以在其中與其他集成商和 API 用戶進行交流,以及 ORCID 團隊。