ORCID 提供多種 API,允許您的系統連接到 ORCID 註冊表,包括讀取和寫入 ORCID 記錄。 某些 API 函數對任何人都可以免費使用(公共 API); 其他人只能使用 ORCID 會員組織(會員和高級會員 API)。
任何人都可以在我們的沙盒測試服務器上自由測試 API 我們鼓勵所有組織使用 ORCID – 會員和非會員 – 加入我們 API用戶組,您可以在這裡提問並了解新技術的發展。
在此處搜索常見問題解答:
基礎
會員組織要求 ORCID 通過完成生產(實時)服務器上的成員 API 憑據 生產會員API客戶端申請表。如果您使用的供應商系統不在清單中 ORCID 認證服務提供商,您的整合需要經過審核流程,以保證 整合和最佳實踐的最低要求 被滿足。
您可以聯繫您的未經認證的服務提供者,並直接從他們那裡獲取滿足最低標準的證據。您需要將此證據發送至 ORCID 參與團隊或您的聯盟領導。
有幾種方法可以分享此證據:
- 截圖影片或螢幕截圖:發送一段錄音或一組螢幕截圖,並附上說明,清楚地解釋和演示您的整合在每個步驟中的工作原理,包括如果使用者拒絕存取或斷開其 ID 的連接會發生什麼情況。請務必提供額外的文件來驗證我們無法從用戶端看到的任何內容,例如使用的 API 版本以及資料的儲存方式。
- 公開可用的整合文檔:提交可公開訪問的最新鏈接,其中包含有關集成在每個步驟中如何工作的清晰說明。與選項 1 一樣,請務必提供額外的文件來驗證我們無法從使用者端看到的任何內容,例如使用的 API 版本以及資料的儲存方式。
整合 ORCID 進入您的系統允許您的組織收集經過身份驗證的 ORCID iD 並將它們新增至您自己的資料。同時,研究人員向組織提供讀寫其資料的權限。 ORCID 記錄。
為了使這項工作發揮作用,組織 必須(MUST) 獲得 認證 ORCID 身份證 使用 ORCID OAuth API。這意味著它們包括一個 ORCID 系統內的品牌按鈕或鏈接,點擊後會要求用戶登錄 ORCID 記錄。
登入後,系統將要求使用者授權存取系統,並要求其提供資訊 ORCID iD
用戶的 ORCID iD 並在上面寫上名字 ORCID 記錄(取決於可見性設定)將作為此過程的一部分傳回給組織。然後系統可以向系統請求附加數據 ORCID API。
上述用於收集經過驗證的 API 的工作流程在以下兩個版本中均可使用 ORCID的公共和成員 API。前者可供非商業服務免費使用。
獲得添加或更新用戶數據權限的過程 ORCID 記錄使用 OAuth,如我們的 3 條腿 OAuth 常見問題解答。 只要 ORCID 會員可以使用會員API請求更新權限。 簡單來說,它的工作原理如下:
- 您的本地系統會創建一個特殊鏈接
- 單擊時,用戶將被發送到 ORCID, 登錄並授予權限
- ORCID 使用“授權碼”將用戶發送回您的系統
- 您的系統將該代碼交換為“訪問令牌”
- 訪問令牌可讓您更新用戶的記錄
ORCID 致力於透過為個人在從事研究、學術和創新活動時使用的唯一、持久的標識符提供一個獨特的、持久的標識符,努力在研究人員、他們的貢獻和他們的隸屬關係之間建立透明和值得信賴的聯繫。確保正確 ORCID iD 與合適的研究人員聯繫是建立可信度的關鍵一步 ORCID 數據集和更廣泛的學術交流生態系統。為此原因, ORCID 不允許手動收集或輸入 ORCID 任何可以收集的工作流程中的 ID ORCID 直接來自記錄持有者本人的 ID。
研究人員可以輕鬆、安全地分享他們的研究成果 ORCID iD 及其與之互動的系統,證明他們擁有自己的 ORCID ID。然後,這些系統可以與其他系統共享有關研究人員活動的信息,從而創建一系列有關研究人員活動的經過驗證和可信的斷言。最終結果是,正確的人與廣泛的學術資訊工作流程中的正確活動相關聯。
有關更多信息,請參閱 https://info.orcid.org/collecting-and-sharing-orcid-ids/
您可以通過將經過驗證的信息連接到他們的 ORCID 記錄。 您還將幫助建立對學術交流的信任,並且通過使數據保持最新,您可以減輕用戶的報告負擔並提高數據質量。
ORCID 研究機構
除了用作研究人員的持久標識符之外, ORCID 可以幫助您控制您的機構名稱在研究系統中的使用方式。 結合其他持久標識符 ORCID 使您能夠權威地聲明您的教職員工和學生與您所在機構的關係。 你也可以使用 ORCID 用於接收有關研究活動的實時通知、自動更新表格以及關注校友職業的 API。
ORCID 資助機構
通過嵌入 ORCID iDs 在您的資助工作流程中,您可以可靠地連接您的受助人和資助計劃 - 並節省每個人的時間並減少因手動鍵入信息而導致的錯誤。 使用 ORCID 在您的系統中,您可以通過斷言個人與您授予他們的贈款之間的聯繫,在構建值得信賴的研究信息基礎設施方面發揮自己的作用。
ORCID 對於出版商
研究人員是學術和研究出版商所做一切的核心。 準確的作者和審稿人信息對於索引、搜索和發現、出版物跟踪、資金和資源使用歸屬以及支持同行評審至關重要。
ORCID 充當信息中心,使您的作者和審稿人能夠可靠地連接到他們的貢獻,並共享來自他們的信息 ORCID 在他們與您的發布系統交互時進行記錄。 在出版過程中為所有作者和審稿人收集 iD——無論是書籍、期刊、數據集、作文、演示文稿、代碼還是各種其他作品——允許輕鬆共享信息,確保研究人員可以同意共享,節省了研究人員的時間和麻煩,降低了出錯的風險,而且至關重要的是,使研究人員能夠獲得他們所做的重要工作應得的榮譽。
會員組織要求 ORCID 通過完成生產(實時)服務器上的成員 API 憑據 生產會員API客戶端申請表. 在發布生產會員 API 憑證之前, ORCID 參與團隊/聯盟負責人將審核您在 ORCID 沙箱。這使我們有機會看到您建立的出色整合並提供工作流程改進,並檢查所有整合是否符合我們的最佳實踐和最低啟動要求。
要提供您的系統的演示,您需要設置與 ORCID 沙箱 ORCID 團隊可以預覽。 有幾種方法可以共享您的工作沙箱集成:
- 推薦: 現場演示: 聯繫我們安排現場演示。我們將提供會議軟體,允許您共享螢幕以演示整合。
- 測試地點: 如果您的開發站點是公開的, 把網址發給我們 以及訪問系統的測試憑據(如果需要)和描述如何使用系統的說明 ORCID 特徵。 提供額外的文檔以驗證我們無法從用戶端看到的內容,例如使用的 API 版本、您的系統存儲了哪些數據等。
- 截圖影片或螢幕截圖:發送錄音或一組截圖 描述清楚地解釋和展示了整合在每個步驟中的工作原理,包括如果使用者拒絕存取或斷開其 ID 的連接會發生什麼情況。請務必提供額外的文件來驗證我們無法從用戶端看到的任何內容,例如使用的 API 版本以及資料的儲存方式
整合
會員組織要求 ORCID 通過完成生產(實時)服務器上的成員 API 憑據 生產會員API客戶端申請表。如果您使用的供應商系統不在清單中 ORCID 認證服務提供商,您的整合需要經過審核流程,以保證 整合和最佳實踐的最低要求 被滿足。
您可以聯繫您的未經認證的服務提供者,並直接從他們那裡獲取滿足最低標準的證據。您需要將此證據發送至 ORCID 參與團隊或您的聯盟領導。
有幾種方法可以分享此證據:
- 截圖影片或螢幕截圖:發送一段錄音或一組螢幕截圖,並附上說明,清楚地解釋和演示您的整合在每個步驟中的工作原理,包括如果使用者拒絕存取或斷開其 ID 的連接會發生什麼情況。請務必提供額外的文件來驗證我們無法從用戶端看到的任何內容,例如使用的 API 版本以及資料的儲存方式。
- 公開可用的整合文檔:提交可公開訪問的最新鏈接,其中包含有關集成在每個步驟中如何工作的清晰說明。與選項 1 一樣,請務必提供額外的文件來驗證我們無法從使用者端看到的任何內容,例如使用的 API 版本以及資料的儲存方式。
公共客戶憑據授予個人而非組織。 憑證不能從一個人轉移到另一個人,但如果收到各方的同意並且該組織是 API 的活躍成員,則它們可以轉換為成員 API 憑證 ORCID.
將用戶端 ID 移至會員 API 不會變更用戶端 ID,只會變更用戶端金鑰,且您將保留具有唯讀權限的已連線 iD 的數量。
將公共 API 客戶端轉換為成員 API 客戶端時 公共客戶服務條款 不再適用,並由會員協議的條款取代。
對於轉移,我們需要:
- 確認要轉換的公共 API 用戶端 ID。
- 該組織的主要聯絡人和目前公共 API 用戶端 ID 的記錄持有者同意服務條款的變更。 (記錄持有者必須是會員組織的員工、承包商或高級職員)我們將保存雙方同意的記錄。
- 遷移發生的日期/時間。作為此遷移的一部分,我們將更新客戶端 ID 並透過加密電子郵件向您發送新的客戶端金鑰。請注意,一旦我們更新客戶端,您的整合將無法運作,直到您更新客戶端金鑰。這就是為什麼我們需要確定執行此操作的日期和時間,並防止給用戶帶來不便。
要完成轉換,您需要更新:
- 舊客戶端密碼到新客戶端密碼。
- API主機來自 pub.orcid.org 至 api.orcid.org.
使用轉換後的成員 API 客戶端 ID,您可以更新範圍以添加 成員 API 範圍. 這將需要用戶授權,並且將生成新的訪問令牌以包含新的範圍/權限。
請注意,我們無法將成員 API 客戶端憑據轉換為公共 API 憑據。
您可以 請求沙箱會員 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 記錄。 您的系統需要能夠:
- 接受並存儲 ORCID iD:您的系統需要知道 iD 的 ORCID 記錄以顯示 iD 並正確更新。將其與令牌交換響應中返回的研究人員資訊儲存在一起。我們的建議是儲存完整的 https URI: https://orcid.org/0000-0001-5727-2427.
- 接受並存儲持久化 訪問令牌 刷新令牌:訪問令牌可用於讀取和更新記錄,以及指示 iD 已被認證。存取權杖的有效期約為 20 年,或直到使用者撤銷為止。我們還建議您存儲 令牌範圍, 令牌到期 刷新令牌。如果需要,刷新令牌可用於建立具有相同或有限範圍的新存取權杖。將存取令牌令牌資料與研究人員的資訊儲存在一起。
- 接受並存儲 把代碼 :您新增到的每個項目 ORCID 註冊表將返回一個放置代碼 ORCID API。將這個 6 位數字的代碼與項目一起保存在您的系統中,這樣您就可以識別哪些項目需要讀取、更新或刪除。
- 當交互未按預期進行時,提供錯誤消息和支持聯繫人。
我們建議開發人員在 沙盒測試服務器 在使用生產版本之前。 以下是有關如何在沙盒和生產環境中註冊公共 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 作為集成審查過程的一部分,團隊將確保滿足這些要求。
- 使用 OAuth的 認證 ORCID iDs(不允許用戶搜索或輸入 ORCID 身份證。)
- 根據我們的提示顯示 OAuth 授權屏幕 方針
- 包括一個 ORCID 品牌按鈕或鏈接 在您的站點上啟動 iD 身份驗證。
- 將 HTTPS 用於您網站的重定向 URI 和 ORCID API調用
- 接受並存儲在令牌交換中返回的所有數據以及您系統中的用戶數據
- 使用適當 範圍 請求方法 (例如 POST 調用添加新信息和 PUT 調用更新現有信息)
- 公開顯示已認證的 ORCID 身份證。 應按照我們的要求顯示 ID 商標和 iD 顯示指南。
- 請勿 請求用戶更改其上項目的可見性設置 ORCID 記錄以使用您的整合。
您需要填寫 用於註冊客戶端應用程序的表單. 以下是請求字段的快速概覽:
組織名稱: 你的 ORCID 會員組織名稱
憑證的主要聯絡電子郵件地址: 我們將使用此電子郵件地址透過加密電子郵件向您發送憑證,並在您的整合過程中出現任何問題或錯誤時與您聯繫
密碼的輔助信箱:我們可以將您的加密電子郵件密碼傳送到的電子郵件地址。
您的客戶姓名: 這將是你的 ORCID 成員組織名稱。如果您有超過 1 個集成,我們會將應用程式附加到名稱中。
您的應用程式主頁的 URL: 顯示為用戶內受信任組織列表上的鏈接 ORCID 受信任方頁面。 這應該是返回您的組織或應用程序主頁的鏈接。
您的客戶端應用程序的簡短描述:此文字將顯示在授權畫面上,並帶有問號圖示給您的整合使用者。需要對您的整合進行簡短描述
重定向 URI: 用戶授權您的應用程序後,他們將返回到您指定的 URI。 您必須提前提供這些 URI,否則您的集成用戶將遇到錯誤。
- 僅接受 HTTPS URI。
- 註冊的網域必須與使用的網域完全匹配,包括子網域。
- 盡可能完整註冊所有重定向 URI。
- 需要超過 5 個重定向 URI? 請在備註中註明 ORCID 員工。
的注意事項 ORCID 員工: 使用這個字段讓 ORCID 工作人員了解有關您的請求或您的融入的任何其他信息
搜索和鏈接嚮導 是可用於將項目(主要是有效的)導入到 ORCID 註冊表。 它們必須在集成商和 ORCID 在它們可以發佈到生產註冊環境之前。
根據您對以下問題的回答,您的集成可能適合搜索和鏈接——請在開始開發搜索和鏈接嚮導之前聯繫我們進一步討論:
- 嚮導的目標受眾是什麼? 例如,國家、學科或全球層面的作者、審稿人或資助申請者
- 預期的觀眾人數大約有多少?
- 它會服務於現有巫師服務不足的人群嗎? 例如,在特定語言或學科中的研究貢獻,或者是新穎的類型
- 您將如何確保嚮導提供良好的用戶體驗?
- 您將提供哪些用戶支持?
- 是否有——或將有——一個 ORCID 貴組織中為嚮導指定人員,例如產品經理?
- 你將如何確保 ORCID 身份證經過驗證?
- 你 - 或者你會 - 攝取和展示 ORCID 您平台上的 ID?
- 您的平台搜索是否由 iD 啟用?
請參閱我們的 搜索和鏈接工作流程 閲讀更多的細節。
會員組織要求 ORCID 通過完成生產(實時)服務器上的成員 API 憑據 生產會員API客戶端申請表. 在發布生產會員 API 憑證之前, ORCID 參與團隊/聯盟負責人將審核您在 ORCID 沙箱。這使我們有機會看到您建立的出色整合並提供工作流程改進,並檢查所有整合是否符合我們的最佳實踐和最低啟動要求。
要提供您的系統的演示,您需要設置與 ORCID 沙箱 ORCID 團隊可以預覽。 有幾種方法可以共享您的工作沙箱集成:
- 推薦: 現場演示: 聯繫我們安排現場演示。我們將提供會議軟體,允許您共享螢幕以演示整合。
- 測試地點: 如果您的開發站點是公開的, 把網址發給我們 以及訪問系統的測試憑據(如果需要)和描述如何使用系統的說明 ORCID 特徵。 提供額外的文檔以驗證我們無法從用戶端看到的內容,例如使用的 API 版本、您的系統存儲了哪些數據等。
- 截圖影片或螢幕截圖:發送錄音或一組截圖 描述清楚地解釋和展示了整合在每個步驟中的工作原理,包括如果使用者拒絕存取或斷開其 ID 的連接會發生什麼情況。請務必提供額外的文件來驗證我們無法從用戶端看到的任何內容,例如使用的 API 版本以及資料的儲存方式
Webhooks 允許高級會員“觀看” ORCID 記錄並通知任何更改。
使用 API 和高級會員客戶端憑據,高級會員可以為每個經過身份驗證的用戶註冊回調 URL ORCID iD 他們希望跟踪。 這 ORCID 記錄持有者不必授予組織特定的註冊 URL 的權限,但實際的數據交換基於由組織設置的隱私級別 ORCID iD 持有人。
有了這個 ORCID 當有更改時,將通過發送請求來通知指定的 URL ORCID 記錄。
元數據
所有附屬部分在 API 中使用相同的元數據集:
- 機構名稱:* 最高級別組織的名稱(例如“波士頓大學”而不是“波士頓大學醫學院”)。
- 組織城市:* 組織所在的城市。
- 組織區域: 組織所在的地區。
- 組織國家* 組織所在的國家/地區。 這應該填充 兩個字母的 ISO 3166 Alpha-2 國家代碼.
- 組織 ID(ROR、GRID、Ringgold** 或 LEI):* 組織及其來源的唯一識別碼。我們建議在附屬機構內使用上級組織 ID,而不是在部門內使用。
- 角色/頭銜: 所擔任的職位,或授予或將授予的學位。
- 部門: 上級組織的任何分部。
- 網址: 有關從屬關係的資源的 URL
- 開始日期: 研究人員和組織之間的關係開始的日期(可以指定為年、月和日)。
- 結束日期: 研究人員和組織之間的關係結束的日期(可以指定為年、月和日)
- 描述從屬關係的外部持久標識符: 實際從屬關係斷言的唯一標識符
*表示必填字段。
**儘管 Ringgold 識別碼仍然存在於 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我們不再接收註冊機構使用的 RINGGOLD 組織識別碼資料庫的更新,也無法處理或使用該日期之後建立的 RINGGOLD ID。 看看我們的 常見問題 獲取更多信息。
在傳記部分下有許多部分 ORCID 記錄:
也稱為: 這可以包括縮寫的名字、變體,包括一個或多個名字的首字母、中間名、舊名或備用名,或不同字符集中的名稱。 每個名稱都應作為單個項目添加。 這是一個最多 255 個字符的自由文本字段。
網站: 此部分包括說明(可選)和網站 URL(必需)
國家: 國家/地區部分 ORCID record 允許研究人員和成員組織添加一個或多個他們進行研究的國家,或者是他們研究的主題。 國家/地區列表中的項目來自 ISO 3166,即國家和地區代碼的國際標準。
外部標識符(其他 ID): 此部分只能由成員組織添加。 請注意,儘管許多組織為其研究人員收集其他外部標識符,例如 Scopus 作者 ID,但只有這些標識符的發布者才能對其進行權威聲明。 因此,我們強烈建議您的組織僅添加您的系統創建並用於識別研究人員的標識符。 此部分包括四個組成部分(* 表示必填字段):
- 身份證類型*
- 身份證值*
- 身份證關係*
- 身份證網址
- 標題:* 作品名稱
- 字幕: 作品的副標題
- 翻譯標題: 作品以另一種語言出現的標題,翻譯標題的語言被記錄為一個屬性
- 期刊名稱: 作品所屬的更大集合的名稱,例如期刊文章的期刊或書籍章節的書籍。 即使這被標記為期刊標題,它也可以用於其他作品
- 簡短的介紹: 作品的簡要描述或摘要
- 引用類型: 提供引文的格式。此字段是從包含以下值的列表中選擇的:APA、BIBTEX、CHICAGO、HARVARD、IEEE、MLA、RIS、UNSPECIFIED、VANCOUVER
- 引文價值: 引文內容
- 工作類型: 作品的對像類型。 該字段必須從 支持的工作類型
- 出版日期: 作品發表的日期。 我們建議使用最早的出版日期
- 外部 ID 類型:* 標識符的類型。 該字段必須從 支持的工作標識符
- 外部 ID 值:* 標識符本身
- 外部 ID 網址: 標識符解析為的 url
- 外部身份關係:* 僅適用於正在添加的作品的標識符將被標記為 Self。 應用於此作品所屬的更大集合的標識符將設置為 Part-of。 適用於作品替代版本的標識符將設置為 version-of。 適用於工作資助的標識符將設置為資助者。
- 工作網址: 鏈接到作品的網址
- 工作貢獻者: 有關創作作品的個人的信息
- 語言代碼: 用於描述之前領域工作的語言
- 國家: 作品出版地或以其他方式與之相關的國家/地區
* 表示必填字段
有多種類型的研究資源,從一次性試劑到具有專用設施的國際合作。 ORCID 支持可以鏈接到其他地方以獲取特定領域詳細信息的高級模型。
有四種高級資源類型:
資源類型 | 定義 | 包機成本結構範例 |
基礎建設 | 用於進行研究的設施、建築物或其他物理空間 | 中子散裂源、動物設施、數據飛地、考古遺址、望遠鏡陣列。 船舶、飛機、農場、實驗室 |
保養系列 | 用於研究目的的一個物體或一組物體; 可以是有形的或數字的 | 海洋任務、實地活動、協作數據集或資源、善本收藏; 博物館收藏,生物標本收藏 |
可租用的設備 | 用於研究目的的硬件 | 顯微鏡、電腦、玻璃器皿、樣品、材料 |
服務 | 用於研究目的的服務 | 蛋白質組學分析、計算服務、數據分析、後勤支持、法律服務、文案編輯、專家或員工建議 |
除了資源類型之外,一個研究資源項目 ORCID 記錄包含以下信息。 * 表示必填項目
- 提案/註冊名稱:* 這是研究資源的主要顯示領域,例如“中子束獎”或“束時間和計算資源”
- 提案/註冊 ID:* 這是使用資源的提議或請求的公共標識符(DOI、PURL 等)。 理想情況下,此標識符應該是持久的,並解析為包含有關提案或請求的信息的公共登錄頁面,例如獎勵數據庫或資源用戶日誌。
- 提案主持人:* 這是接收和處理資源建議或請求的組織。 提案主機可能與資源主機相同
- 提案主辦機構 ID* 這是管理提案或請求流程的組織的公共標識符(ROR、GRID、開放資助者 ID、LEI 之一)
- 資源):* (最多100個)
- 資源名稱:* – 例如,“中子散裂源”
- 資源 ID:* – 來自可接受的 PID 類型的可擴展列表(例如 RRID、DOI、URI)
- 資源類型:* – “基礎設施”、“集合”、“設備”或“服務”之一
- 資源主機:* 這是管理或運營資源的組織,例如國家實驗室、政府機構或研究型大學
- 資源宿主組織 ID:* 這是託管資源的組織的公共標識符(ROR、GRID、Ringgold**、開放資助者 ID、LEI 之一)
- 提案網址: 提案的鏈接
- 提案開始日期: 訪問開始日期
- 提案結束日期: 訪問結束或將結束的日期
* 表示必填字段
**儘管 Ringgold 識別碼仍然存在於 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我們不再接收註冊機構使用的 RINGGOLD 組織識別碼資料庫的更新,也無法處理或使用該日期之後建立的 RINGGOLD ID。 看看我們的 常見問題 獲取更多信息。
- 角色:* 個人在審稿過程中的角色,可以選擇:主席、編輯、成員、組織者、審稿人
- 組標識符:* 用於聚合目的的群組 ID — 對於期刊文章,預設識別碼是 eISSN,它是透過與 ISSN 資料庫整合自動填入的。請注意,如果您需要指派 ISSN 以外的標識符,則需要 之前創建它。
- 召集機構*: 組織評審的組織——期刊出版商、會議組織者、資助機構、教師等
- 組織標識符: 召集組織的持久標識符。 我們目前支持 ROR、Ringgold**、GRID、LEI 或 Crossref 資助者註冊標識符。 請注意:這不是必填字段,但我們建議您發布此數據(如果您有可用的數據)。
- 審查數據:* 此數據指的是審查活動,而不是審查的內容
- 類型: 評審活動類型:評審或評估
- 日期: 審查完成的日期。 這可以是廣泛的 (2008) 或具體的 (2010-12-10)
- 評論標識符: 一個獨特的,最好是可解析的 識別碼 由審查本身的來源提供。 除非評論是公開可用的,否則我們建議這不包含可以追溯到評論主題的可識別數據
- 評論網址: 指向在線評論或評論記錄的表示的鏈接
- 審查對象的相關資料: 無論審稿人如何評論
- 科目類型: 被審閱的項目類型,例如期刊文章、會議論文
- 這包括 工作類型列表和資助類型列表 (“撥款”、“合同”、“獎”、“薪水獎”) AND 研究-“資源提案” AND “未定義”
- 科目名稱: 審查項目名稱
- 主題外部標識符: 評論主題的唯一標識符,例如文章 DOI
- 主題容器名稱: 評審主題所屬對象的名稱,例如論文被評審的會議
- 主題網址: 被審查的主題的 URL
- 科目類型: 被審閱的項目類型,例如期刊文章、會議論文
* 表示必填字段
**儘管 Ringgold 識別碼仍然存在於 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我們不再接收註冊機構使用的 RINGGOLD 組織識別碼資料庫的更新,也無法處理或使用該日期之後建立的 RINGGOLD ID。 看看我們的 常見問題 獲取更多信息。
- 資金類型:* 授予的資金類型,此字段從包含以下值的列表中選擇:Award、Contract、Grant、Salary-award
- 資金名稱:* 資助項目名稱
- 字幕: 資助項目的副標題
- 翻譯標題: 資助的標題以另一種語言出現,翻譯標題的語言被記錄為屬性
- 產品描述:資助項目的描述或簡短摘要。
- 金額: 獎項的價值
- 唯一的資金標識符: * 添加您的系統知道的盡可能多的內容,因為它有助於分組 ORCID 紀錄。
- 資金標識符類型: 使用授權號、DOI、URI 或提案 ID
- 標識符的值
- 標識符 URL(可選)
- 關係:自我/部分
這是為了表明資助項目與標識符的關係。 例如,如果資助項目是針對多部分撥款的一個階段,而標識符是針對多部分撥款的,則關係將是“part-of”; 如果標識符用於單個階段,則關係將是“自我”。
- 資助機構(組織):* 有關授予資助的組織的信息
- 機構名稱
- 地址(城市和國家)
- 組織標識符: 支援的識別碼包括 ROR、Fundref 和 Ringgold** 識別碼。
- 開始日期: 資金開始日期
- 結束日期: 資助結束日期
- 貢獻者信息: 有關獲得資助的個人的信息
- ORCID ID: ORCID iD 資助項目的每個合作者; 這應該只包括經過身份驗證的 ORCID 身份證
- 角色: 研究人員貢獻的性質
* 表示必填字段
**儘管 Ringgold 識別碼仍然存在於 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我們不再接收註冊機構使用的 RINGGOLD 組織識別碼資料庫的更新,也無法處理或使用該日期之後建立的 RINGGOLD ID。 看看我們的 常見問題 獲取更多信息。
所有附屬部分在 API 中使用相同的元數據集:
- 機構名稱:* 最高級別組織的名稱(例如“波士頓大學”,而不是“波士頓大學醫學院”)。
- 組織城市:* 組織所在的城市。
- 組織區域: 組織所在的地區。
- 組織國家* 組織所在的國家/地區。 這應該填充 兩個字母的 ISO 3166 Alpha-2 國家代碼.
- 組織 ID(ROR、GRID、Ringgold** 或 LEI):* 組織及其來源的唯一識別碼。我們建議在附屬機構內使用上級組織 ID,而不是在部門內使用。
- 角色/頭銜: 所擔任的職位,或授予或將授予的學位。
- 部門: 上級組織的任何分部。
- 網址: 有關從屬關係的資源的 URL
- 開始日期: 研究人員和組織之間的關係開始的日期(可以指定為年、月和日)。
- 結束日期: 研究人員和組織之間的關係結束的日期(可以指定為年、月和日)
- 描述從屬關係的外部持久標識符: 實際從屬關係斷言的唯一標識符
*表示必填字段。
**儘管 Ringgold 識別碼仍然存在於 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我們不再接收註冊機構使用的 RINGGOLD 組織識別碼資料庫的更新,也無法處理或使用該日期之後建立的 RINGGOLD ID。 看看我們的 常見問題 獲取更多信息。
所有附屬部分在 API 中使用相同的元數據集:
- 機構名稱:* 最高級別組織的名稱(例如“波士頓大學”,而不是“波士頓大學醫學院”)。
- 組織城市:* 組織所在的城市。
- 組織區域: 組織所在的地區。
- 組織國家* 組織所在的國家/地區。 這應該填充 兩個字母的 ISO 3166 Alpha-2 國家代碼.
- 組織 ID(ROR、GRID、RInggold** 或 LEI):* 組織及其來源的唯一識別碼。我們建議在附屬機構內使用上級組織 ID,而不是在部門內使用。
- 角色/頭銜: 所擔任的職位,或授予或將授予的學位。
- 部門: 上級組織的任何分部。
- 網址: 有關從屬關係的資源的 URL
- 開始日期: 研究人員和組織之間的關係開始的日期(可以指定為年、月和日)。
- 結束日期: 研究人員和組織之間的關係結束的日期(可以指定為年、月和日)
- 描述從屬關係的外部持久標識符: 實際從屬關係斷言的唯一標識符
*表示必填字段。
**儘管 Ringgold 識別碼仍然存在於 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我們不再接收註冊機構使用的 RINGGOLD 組織識別碼資料庫的更新,也無法處理或使用該日期之後建立的 RINGGOLD ID。 看看我們的 常見問題 獲取更多信息。
所有附屬部分在 API 中使用相同的元數據集:
- 機構名稱:* 最高級別組織的名稱(例如“波士頓大學”,而不是“波士頓大學醫學院”)。
- 組織城市:* 組織所在的城市。
- 組織區域: 組織所在的地區。
- 組織國家* 組織所在的國家/地區。 這應該填充 兩個字母的 ISO 3166 Alpha-2 國家代碼.
- 組織 ID(ROR、Ringgold**、GRID 或 LEI):* 組織及其來源的唯一識別碼。我們建議在附屬機構內使用上級組織 ID,而不是在部門內使用。
- 角色/頭銜: 所擔任的職位,或授予或將授予的學位。
- 部門: 上級組織的任何分部。
- 網址: 有關從屬關係的資源的 URL
- 開始日期: 研究人員和組織之間的關係開始的日期(可以指定為年、月和日)。
- 結束日期: 研究人員和組織之間的關係結束的日期(可以指定為年、月和日)
- 描述從屬關係的外部持久標識符: 實際從屬關係斷言的唯一標識符
*表示必填字段。
**儘管 Ringgold 識別碼仍然存在於 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我們不再接收註冊機構使用的 RINGGOLD 組織識別碼資料庫的更新,也無法處理或使用該日期之後建立的 RINGGOLD ID。 看看我們的 常見問題 獲取更多信息。
An ORCID 記錄可能包含有關研究人員的工作、隸屬關係、資助、同行評審等的信息。
上的項目 ORCID 記錄可以分解為 斷言 連接 ORCID 具有活動或從屬關係的 iD 持有人. 這些斷言可以添加到 ORCID 由擁有記錄的研究人員或由研究人員授予許可的系統進行記錄。 我們稱添加斷言的實體為 ORCID 記錄 資源.
包機成本結構範例
遵循我們透明和公開的原則,我們認為能夠看到斷言的來源很重要——誰將這些信息添加到記錄中。 這是我們如何做到的:
- 當研究人員(或其委託的 值得信賴的個人) 在他們的記錄中添加一個斷言, ORCID 自動將該人記錄為來源
- 當研究人員批准的系統向記錄添加斷言時, ORCID 自動記錄系統所有者(一個 ORCID 成員)作為來源。
我們在用戶界面中顯示源名稱並使其在 API 中可用(及其唯一標識符):
然而,研究信息工作流程可能比這更複雜,斷言的真正來源可能會被一個系統代表一個人或另一個系統添加項目無意中掩蓋。 為了確保透明度,我們需要區分誰在人和項目之間建立了聯繫,以及誰將項目添加到記錄中。 如上所述,無論誰將項目添加到 ORCID 記錄是 資源; 誰在兩者之間建立聯繫 ORCID iD 該項目是 斷言起源。
例如:
- 研究人員將數據導入他們的 ORCID 從系統記錄,例如搜索和鏈接嚮導。 研究人員正在斷言將他們的 iD 與項目,所以他們是 斷言起源; 而係統是將斷言添加到 ORCID 記錄—— 資源
- 研究人員與系統 A(系統 A 斷言來源),它使用系統 B 提供的服務來更新 ORCID 記錄,使系統 B 成為 資源
我們鼓勵我們的社區採取措施來保存和共享有關斷言來源的信息,以便每個人都能從查看來源中受益。
欲了解更多信息,請訪問:
在...工作 ORCID 根據他們的標識符和這些標識符與作品的關係組合在一起。 有四種類型的關係:
- 自:標識符僅指該作品,可以與具有相同標識符的其他作品分組
- 的一部分:作品是此標識符的一部分,不能與其他作品分組
- 版本號:這些標識符適用於作品的替代版本,並且可以與標識符的自我和版本分組
- 資助:這些標識符適用於工作的資金。 這些標識符不用於對作品進行分組。
我們的 API 在 XSD 中提供了對此的支援。每個項目都有一個顯示索引屬性,指示其在其群組中的排名。顯示指數最高的項目是研究者選擇的首選項目。透過 API 新增且尚未由研究人員排名的項目的顯示索引為 1,並用作群組內的預設首選來源,直到研究人員進行更改。顯示索引也決定了讀取時的工作順序 ORCID 使用 API 進行記錄。
有關分組的更多信息 ORCID 記錄,請參閱我們的 支持文章.
ORCID 允許添加多種類型的作品。 以下是當前支持的工作類型列表,與 CASRAI 輸出標準基本一致。
相關报告
工作類型 | 使用 |
書 | 由單一作者撰寫或基於研究或學術發現共同撰寫的書籍,這些書籍通常來自同行評審的資助。 |
書章 | 由單個作者或合作撰寫的文本,基於某個領域的研究或學術發現和專業知識。 |
書評 | 對小說或非小說作品的批判性評論,突出對藝術、領域或學科的貢獻。 |
字典條目 | 新詞的條目、現有詞的新含義、拼寫和連字符在較長時期內的變化以及語法變化。 |
論文 | 論文提出了研究產生的原始觀點:對博士學位的要求。 這僅適用於 API v2.x |
學位論文 | 一篇通常基於原創研究的論文,證明候選人對自己的學科和學術方法的掌握。 這僅適用於 API v3.0+ |
百科全書條目 | 在參考書或綱要中創作的條目,側重於特定領域或所有知識分支。 |
編輯過的書 | 由單一作者編輯或合作編輯的書籍,用於傳播通常由同行評審資金產生的研究或學術發現。 |
雜誌文章 | 同行評審出版物中傳播原創研究和學術成果的文章。 |
期刊問題 | 旨在促進智力辯論和探究的期刊出版物。 |
雜誌文章 | 定期出版的專題出版物中的文章。 |
手冊 | 為教學目的製作的課程和作業材料。 |
在線資源 | 只能通過傳統技術方法在網絡上訪問的信息 |
通訊文章 | 針對研究人員、決策者、專業人士和公眾的出版物中報導研究項目或研究主席或研究中心活動的文章。 |
報紙文章 | 每日、每週或每月出版物中的文章,報導針對公眾的新聞和社會問題。 |
預印本 | 在正式同行評審和出版之前公開的論文版本。 這僅適用於 API v3.0+ |
report | 傳播研究合同的結果和可交付成果的報告。 |
檢討 | 對他人工作的正式評估。 這僅適用於 API v3.0+ |
研究工具 | 從研究中確定的一系列觀察、測量或事實。 |
受監督的學生出版 | 與論文導師共同發表或由論文導師監督的研究成果文章。 |
test | 評估包括為一般大學選擇、特定課程選擇或其他評估目的而設計的測試。 |
翻譯 | 識別對原始版本的修改的書籍和文章的翻譯,例如新的或修訂的序言。 |
網站 | 網絡上的獨立位置,其中提供了有關特定主題的多種類型的信息。 |
工作文件 | 未經審查但可以共享以徵求意見的文章的初步版本。 |
研討會
工作類型 | 使用 |
會議摘要 | 指定長度的文本,說明將在提議的會議文件中討論的問題。 |
會議論文 | 單獨或合作撰寫的論文,在學術會議上發表,並在會議錄中發表(不是在學術期刊上)。 |
會議海報 | 在會議環境中展示的海報,並通過引人注目的圖形以有效的方式傳達研究亮點。 |
知識產權
工作類型 | 使用 |
洩露 | 將發明確立為現有技術從而防止他人為同一發明或概念申請專利的出版物。 |
許可證 | 簽署協議以利用某個 IP,例如流程、產品、數據或軟件。 |
專利 | 一種知識產權保護形式,根據法律規定發明人和受讓人在有限的時間內使用和利用其發明、產品或工藝的專有權。 |
註冊版權 | 根據促進藝術、文學、音樂、戲劇和其他創造性作品的創作和獲取的法律體系註冊的權利所有權。 |
商標 | 產品或服務的名稱、單詞、短語、徽標、符號、設計、圖像等標記,表明來源並提供控制標識符使用的權利。 |
其他
工作類型 | 使用 |
註解 | 註釋包含關於另一個資源的註釋或描述。 這僅適用於 API v3.0+ |
藝術表演 | 信息記錄的集合,這些記錄結合起來代表了由個人的研究或學術活動產生的或與之相關的藝術或表演成果的完整和最新歷史。 |
數據管理計劃 | 一份正式聲明,描述如何在整個研究項目中管理和記錄研究數據,以及有關隨後將數據存儲在數據存儲庫中以進行長期管理和保存的條款。 這僅適用於 API v3.0+ |
數據集 | 從研究中確定的一系列結構化觀察、測量或事實,可以存儲在數據庫介質中。 |
發明 | 研究產生的實用和原創成果。 |
演講稿 | 向聽眾提供的與研究相關的信息性演講。 |
物理對象 | 用於研究目的的標本、樣本或其他實物; 無生命的三維物體或物質。 這僅適用於 API v3.0+ |
研究技術 | 應用於確定為研究一部分的特定任務的實用方法或技能。 |
軟體 | 用於操作計算機或其他技術設備的程序。 |
分拆公司 | 由研究組織設立的公司,目的是將研究項目的結果和發現用於商業用途。 |
標準和政策 | 用作判斷基礎的規則或原則的發展。 |
技術標準 | 源自可能開發新協議、方法或材料的研究項目的技術標準(工業或其他)。 |
other | 任何其他類型的工作。 |
我們引入了一個新的系統生成字段,該字段以規範化格式表示外部標識符(DOI、PMCID、PMID、ArXiv、Bibcode、ISSN 和 ISBN),用於匹配和分組。 規範化是根據標識符類型的規則完成的,可能包括將所有字母字符設置為小寫,或轉換空格、破折號、句點和其他可以視為等效的字符。 它還根據需要添加標準前綴和後綴。 例如, https://doi.org/10.1/123, 10.1/123和 https://dx.doi.org/10.1/123 都將出現在此字段中 https://doi.org/10.1/123. 現有標識符值未修改。
- 首先,
- 額外
作品 API 2.0 的角色
以下是使用 API 2.0 支持的貢獻者角色列表。- 作者
- 受讓人
- 編輯
- 主席或翻譯
- 共同調查員
- 共同發明人
- 研究生
- 其他發明人
- 首席研究員
- 博士後研究員
- 技術支持人員
作品 API 3.0 的角色
使用 API 3.0,您可以添加上述角色以及其他 CRedIT 角色。 CRediT 分類法包括 14種對學術工作的貢獻類型, 以及如何分配這些角色的指南。 下面是包含 UI 值和元數據值的完整列表。 元數據值是根據 NISO 實施建議的 URL 'CRediT 應該在 JATS xml v1.2 中編碼,通過此鏈接描述: https://jats4r.org/credit-taxonomy“。 通過 API 添加角色時,僅接受 URL。示例工作貢獻者元數據:
https://orcid.org/0000-0001-5109-3700 0000-0001-5109-3700 orcid.org Laure L. Haak first author
資助角色
- 領導
- 共同領導
- 支持
- 其他貢獻
ORCID 提供免費的文本引用字段,以便研究人員可以輕鬆地以文本格式輸入信息。 然而,我們強烈鼓勵所有 API 用戶在 BibTeX 中添加引文,這是機器可讀的。 儘管這種古老的格式早於互聯網,但可以通過集成和作者將其轉換為所需的格式。 大多數參考文獻管理器和發布平台都支持它
有關 BibTeX 的更多信息,請參閱 https://www.bibtex.org.
出版商使用 Crossref 進行 DOI 註冊的任何作者都可以從 Crossref 自動更新集成中受益。
發布者需要包含經過身份驗證的 ORCID 在 DOI 註冊時發送到 Crossref 的元數據中作者的 ID。
然後,Crossref 將通過向作者發出通知來請求作者的許可 ORCID 收件箱更新他們的 ORCID 記錄本出版物和任何出版商的任何新出版物。
有關更多信息,請參閱: https://www.crossref.org/community/orcid/
中的每一項 ORCID iD 分配了一個唯一標識它的放置代碼。 讀取整個記錄或部分時,可以找到放置代碼作為項目的屬性。 什麼時候 調用記錄上的特定項目,放置代碼用於識別項目。 放置代碼在它們所指的項目類型中是唯一的。 使用這個例子,只有一個工作在 ORCID 註冊表將有放置代碼 733535,但 733535 也可用作資金項目或關鍵字的放置代碼
作為一個好處 ORCID 會員資格,組織可以詢問 ORCID 支持額外的PID類型 ORCID 註冊表。 例如,成員可以要求我們添加對他們用於識別地質數據庫中的樣本或數據集的 PID 的支持。 這使得樣本和收集它們的人之間建立了聯繫。 而且,因為我們添加的所有新 PID 類型必須至少是可解析的,最好是 FAIR,所以這些鏈接是明確的、隨著時間的推移持續存在且可操作的 - 使研究人員、成員組織和更廣泛的社區受益。
添加您的PID!
作為一個社區組織,我們希望確保 ORCID 支持我們會員使用的PID。 我們保持一個完整的 註冊表中支持的現有標識符列表 並邀請 ORCID 會員使用 注冊表格 請求額外的PID。 我們的目標是盡快回复您的請求。
ORCID 有一個單獨的部分 ORCID record 記錄有關資格、認證、證書和徽章的信息。
每個資格項目將始終包含:
- 資格稱號
- 提供者的組織 ID(例如 ROR ID)
- 將其添加到 ORCID 記錄
- 誰添加了資格(來源)
它們可能包含:
- 有效期,包括資格到期的結束日期
- 資格永久 ID,標識獲得的資格類型。
- 資格 URL,其中包含對獲得的資格類型的可讀描述。
- 資格持久 ID。這應該連結到資格證書的線上版本。這可以是現有的唯一 ID 或簡單的 URI。
身份驗證和 OAuth
任何擁有公共或成員 API 憑證的人都可以收到 /讀公開 訪問令牌。 要獲得令牌,您可以調用 ORCID API 令牌端點。
此過程通常稱為客戶端憑據 OAuth 流程,或 2 步 OAuth。
獲取訪問令牌以讀取沙箱上的公共數據的示例調用 - 用您的憑據替換佔位符(確保刪除括號。
URL=https://sandbox.orcid.org/oauth/token
HEADER: Accept: application/json
METHOD: POST
DATA:
client_id=[Your public API client ID]
client_secret=[Your public API secret]
grant_type=client_credentials
scope=/read-public
然後,您將返回一個類似於以下內容的訪問令牌。 返回的令牌是長期存在的(大約 20 年不會過期),並且可以多次使用來檢索公共數據 ORCID 紀錄。
{"access_token":"4bed1e13-7792-4129-9f07-aaf7b88ba88f","token_type":"bearer",
"refresh_token":"2d76d8d0-6fd6-426b-a017-61e0ceda0ad2","expires_in":631138518,
"scope":"/read-public","orcid":null}
注意: 具有 /authenticate 範圍的所有令牌現在也包含 /read-public 範圍。 如果僅使用 /authenticate 範圍,則可以使用存儲的訪問令牌讀取公共數據,而無需再次獲取訪問令牌。
使用會員 API 的整合商可以使用 /讀公開 閱讀範圍 ORCID 記錄總結。
要獲得/讀取限制的訪問權限,您必須徵求研究人員的許可。 您可以使用 OAuth 來執行此操作。 具體來說, ”三足OAuth“。
有關更多信息,請參見我們的 API 教程:讀取數據 ORCID 記錄
ORCID 集成使用“3 legged OAuth”來驗證用戶並請求與他們的記錄交互的權限。 任何集成都可以使用公共 API 請求讀取權限。 ORCID 會員可以使用會員 API 請求更新權限。 它是這樣工作的:
- 您創建了一個特殊鏈接
- 單擊時,用戶將被發送到 ORCID
- ORCID 要求用戶登錄
- ORCID 要求用戶授予您的應用程序權限
- ORCID 使用授權碼將用戶發送回您的系統
- 您的系統將該代碼交換為訪問令牌
定制的授權 URL 包括您的客戶信息,以及指定您希望訪問的他們記錄的特定區域的“範圍”。 登錄後,用戶授權與您的系統連接,並與授權代碼一起返回到您的登錄頁面。 然後使用此代碼獲取他們的 ORCID iD 以及對請求的範圍有效的訪問令牌。
您可以透過指定 API 憑證的用戶端 ID 和關聯的登入頁面(重定向 URI)來建立授權連結。您可以透過設定來選擇請求哪些權限 範圍參數.
下面的示例請求讀取限制訪問數據的權限 ORCID 沙盒測試服務器。 在現實世界中,您會在您的網站上顯示此鏈接,或者在要求用戶進行身份驗證和授權時將其包含在電子郵件中。 但是,出於測試目的,您可以簡單地將其粘貼到您的網絡瀏覽器中。 用您的客戶信息替換括號中的數據,並確保刪除方括號!
https://sandbox.orcid.org/oauth/authorize?client_id=[Your client ID]&response_type=code&scope=/read-limited&redirect_uri=[Your landing page]
一個用戶點擊了鏈接,登錄於 ORCID 並授予權限,他們將被重定向回您的網站,如下所示:
https://[Your landing page]?code=Q70Y3A
您應該立即交換授權碼 ORCID iD 和訪問令牌。 授權碼在使用時過期。 請求看起來像這樣 不能在網絡瀏覽器中製作,它必須由您的服務器製作。
URL=https://sandbox.orcid.org/oauth/token
HEADER: Accept: application/json
HEADER: Content-Type: application/x-www-form-urlencoded
METHOD: POST
DATA:
client_id=[Your client ID]
client_secret=[Your client secret]
grant_type=authorization_code
code=Six-digit code
redirect_uri=[Your landing page]
ORCID 然後將返回研究人員的認證 ORCID iD 和一個 JSON 格式的訪問令牌:
{"access_token":"f5af9f51-07e6-4332-8f1a-c0c11c1e3728","token_type":"bearer",
"refresh_token":"f725f747-3a65-49f6-a231-3e8944ce464d","expires_in":631138518,
"scope":"/read-limited","name":"Sofia Garcia","orcid":"0000-0001-2345-6789"}
默認情況下,訪問令牌是長期存在的,並在發行後 20 年到期。 令牌在到期前可以多次使用。
使用訪問令牌
三足訪問令牌鏈接到特定的 ORCID 記錄。 要使用它們,您可以將它們包含在您為讀取或更新該記錄而發出的 API 請求中。
當請求與某個人交互的權限時 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 內部使用。
如果您擔心多個用戶在同一台機器上並且不在會話之間退出,您可以強制他們在 OAuth 過程中重新進行身份驗證。 只需包括 prompt=login
在 OAuth 請求中。 您還可以以秒為單位設置 max_age,以強制用戶在會話超過一定長度時重新進行身份驗證。 查看我們的 OpenID Connect 文檔 閲讀更多的細節。
用戶 可以隨時自行更改顯示語言。 可以使用以下語言設置:
語言 | 推薦碼 |
阿拉伯語 | ar |
切什蒂納(捷克語) | cs |
English | en |
西班牙語(西班牙) | es |
法語(法國) | fr |
德語(德國) | de |
義大利文(義大利文) | it |
日本語(日語) | ja |
한국어(韓語) | ko |
波蘭語(波蘭語) | pl |
Português(葡萄牙語) | pt |
Русский(俄語) | ru |
Türkçe(土耳其語) | tr |
簡體中文(簡體中文) | zh_CN的 |
繁體中文(繁體中文) | zh_TW的 |
可以使用任何或所有參數:
參數 | 場 | 筆記 |
姓 | 給定的名稱 | 名字 字段將填寫在 登記表 如果指定的電子郵件地址或 ORCID iD 與活躍的不匹配 ORCID 記錄。 |
姓氏 | 姓 | 姓 字段將填寫在 登記表 如果指定的電子郵件地址或 ORCID iD 與活躍的不匹配 ORCID 記錄。 |
電子郵件 | 電郵 | 電子郵件/ORCID iD 字段將填寫在 登錄表格 如果在我們的系統中找到指定的電子郵件地址並且無效 ORCID iD 是指定的。 電子郵件 字段將填寫在 登記表 如果在我們的系統中找到指定的電子郵件地址並且無效 ORCID iD 已指定。電子郵件地址應為 網址編碼,包括將“@”更改為“%40”。如果您知道用戶的 ORCID iD 和電子郵件地址,我們建議 僅由 提供 ORCID iD 在 orcid 參數中。 |
蘭花 | ORCID iD | 電子郵件/ORCID iD 字段將填寫在 登錄表格 如果指定 ORCID iD 在我們的系統中找到。 登記表 否則將顯示如果指定 ORCID iD 在我們的系統中找不到。 ORCID iD 必須在 16 位格式 iD 的URI. |
帶有這些參數的示例 URL 是
https://sandbox.orcid.org/oauth/authorize?client_id=APP-NPXKK6HFN6TJ4YYIn&response_type=coden&scope=/authenticaten&redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplaygroundn&family_names=Finn&given_names=Huckleberry&email=huckle%40mailinator.com
隱式 OAuth 是 OAuth 的輕量級版本,旨在供沒有或不想使用服務器端組件的系統使用。 隱式 OAuth 可以完全在瀏覽器中單獨使用 javascript 實現。 它適用於會員和非會員,工作方式如下:
- 您創建了一個特殊鏈接
- 單擊時,用戶將被發送到 ORCID
- ORCID 要求用戶簽署我
- ORCID 要求用戶授予您的應用程序權限
- ORCID 將用戶發送回您的系統 ORCID iD、存取令牌和 ID 令牌。
- 您的系統提取並存儲經過身份驗證的 ORCID iD 從響應。
出於安全原因,在使用隱式 OAuth 時, ORCID 不會返回具有更新權限的訪問令牌。
隱式流
隱式流程的設計使得客戶端不需要使用他們的秘密密鑰來啟動 ORCID 登錄。通過將客戶端限製到其註冊的 redirect_url 來強制執行安全性。 這種較低的安全級別意味著 ORCID 使用隱式流時僅支持 /authenticate 和 openid 範圍。 代幣也是短暫的,只有 10 分鐘的壽命。 建議將此流程用於無法訪問後端服務器的客戶端應用程序,例如電話應用程序或單頁 javascript web 應用程序。
https://localhost/#access_token=24c11342-f5da-4cf9-94a4-f8a72a30da00&token_type=bearer&expires_in=599&tokenVersion=1&persistent=false&id_token=eyJraWQiOiJxYS1vcmNpZC1vcmctcjlhZmw3cWY2aG2c5bmdzenU1bnQ3Z3pmMGVhNmkiLCJhbGciOiJSUzI1NiJ9.eyJhdF9oYXNoIjoiMW52bXZBbVdwaVd0Z3ZKZW1DQmVYUSIsImF1ZCI6IkFQUC02TEtJSjNJNUIxQzRZSVFQIiwic3ViIjoiMDAwMC0wMDAyLTUwNjItMjIwOSIsImF1dGhfdGltZSI6MTUwNTk4Nzg2MiwiaXNzIjoiaHR0cHM6XC9cL29yY2lkLm9yZyIsIm5hbWUiOiJNciBDcmVkaXQgTmFtZSIsImV4cCI6MTUwNTk4ODQ2MywiZ2l2ZW5fbmFtZSI6IlRvbSIsImlhdCI6MTUwNTk4Nzg2Mywibm9uY2UiOiJ3aGF0ZXZlciIsImZhbWlseV9uYW1lIjoiRGVtIiwianRpIjoiY2U0YzlmNWUtNTBkNC00ZjhiLTliYzItMmViMTI0ZDVkNmNhIn0.hhhts2-4-ibjXPW6wEsFRaNqV_A-vTz2JFloYn7mS1jzQt3xuHiSaSIiXg3rpnt1RojF_yhcvE9Xe4SOtYimxxVycpjcm8yT_-7lUSrc46UCt9qW6gV7L7KQyKDjNl23wVwIifpRD2JSnx6WbuC0GhAxB5-2ynj6EbeEEcYjAy2tNwG-wcVlnfJLyddYDe8AI_RFhq7HrY4OByA91hiYvHzZ8VzoRW1s4CTCFurA7DoyQfCbeSxdfBuDQbjAzXuZB5-jD1k3WnjqVHrof1LHEPTFV4GQV-pDRmkUwspsPYxsJyKpKWSG_ONk57E_Ba--RqEcE1ZNNDUYHXAtiRnM3w
請參閱我們的 技術文檔 獲取更多訊息
什麼是重定向 URI,它們是如何使用的?
我們的 OAuth 身份驗證服務使用重定向 URI 作為安全措施。 ORCID 只會將身份驗證用戶發送到請求身份驗證的客戶端註冊的 URI。 這可以防止服務相互模仿。
請注意 僅 HTTPS URI 在生產中被接受。 您可以使用 HTTP URI 進行測試,但您需要註冊 HTTPS URI 當您申請生產成員 API 憑證時。
我們如何匹配重定向 URI?
- 您必須將子域註冊為單獨的 URI. https://anythingelse.thirdparty.com 將不起作用。
- 鼓勵完全註冊所有重定向 URI,包括路徑, 是大多數第三方所做的,也是最安全的選擇。
- 如果客戶端應用程序註冊的重定向 uri 只是主機名,則可以使用該主機上的任何重定向 uri. 因此,例如,如果註冊了以下重定向 uri: https://thirdparty.com 那麼以下所有 redirect_uris 都將起作用:
- https://thirdparty.com/oauth/callback1
- https://thirdparty.com/callback2
- https://thirdparty.com/anything-else-as-long-as-the-host-is-the-same
但是,https://anythingelse.thirdparty.com 不管用。 您 必須(MUST) 將子域註冊為單獨的 URI。
如果我的重定向 URI 不正確會怎樣?
發送到驗證的用戶 ORCID 使用不正確的重定向 URI 將看到類似於此的錯誤消息:
管理成員的重定向 URI
如果您使用會員 API 並需要對重定向 URI 進行任何更改,請聯繫我們的參與團隊
管理公共客戶端的重定向 URI
如果您使用的是公共 API,那麼您將需要按照以下步驟更新與您的關聯的重定向 URI 列表 ORCID 公共 API 客戶端 ID。 您可以按照以下步驟執行此操作:
- 登錄到您的 ORCID 記錄
- 點擊右上角你的名字
- 選擇開發者工具
- 點擊客戶名稱旁邊的編輯鉛筆
- 編輯現有的重定向 URI 或單擊“添加另一個重定向 URI”編輯現有的
- 完成更改後,您需要單擊保存圖標
僅 HTTPS URI 在生產中被接受。 您可以使用 http URI 進行測試,但在申請生產成員 API 憑證時需要註冊 HTTPS URI。
OpenID Connect 1.0 是 OAuth 2.0 協議之上的一個簡單的身份層。 它補充了現有的 OAuth 身份驗證流程,並以良好描述的方式向客戶端提供有關用戶的信息。
OpenID 連接是實現 OAuth 和共享有關已驗證用戶的信息的標準化方法。 現在可以配置要使用的服務 ORCID 與其他符合標準的 OpenID 連線提供者一起「開箱即用」。 OpenID connect 還提供可共享的 ID 令牌,這些令牌是簽名對象,可以證明使用者已通過身份驗證 ORCID 在特定時間。 用戶界面元素可以使用這些令牌來維護用戶會話。
ORCID 支持 Basic OpenID Provider 一致性配置文件,它是 OAuth 授權代碼流的擴展。 ORCID 還支持“/authenticate”和“openid”範圍的隱式令牌流。
這意味著 ORCID:
- 將簽署的 id 令牌嵌入令牌回應中,以取得使用「openid」範圍產生的授權代碼
- 使用“token”或“token id_token” response_types 和“openid”範圍時支持隱式流。
- 支持包含“openid”範圍的授權請求的“prompt”、“nonce”和“max_age”參數。
- 支持 Openid Connect 發現和 userinfo 端點
- 支持集成商使用成員 API 進行包含“openid”範圍的授權請求的“amr”字段。 這可用於發現用戶是否使用兩因素身份驗證進行身份驗證。
啟動 OpenID Connect 身份驗證的工作方式與常規 OAuth 身份驗證相同。 所需要的只是客戶端請求“openid”範圍如果您使用/authenticate 範圍,請將其替換為openid,因為authenticate 和openid 具有相同的授權,只能使用一個或另一個。 如果您正在使用任何其他範圍,請將 openid 添加到請求的範圍列表中。 當包含 openid 範圍時,註冊表將在令牌響應中返回一個 id_token 並授予客戶端訪問該用戶的用戶信息端點的權限。
請注意,“openid”範圍不像其他範圍那樣以“/”開頭 ORCID API 範圍。 這是因為“openid”範圍不是由 ORCID,而是由 OpenID Connect 規範定義。
請參閱我們的 技術文檔 獲取更多訊息
符合 我們致力於研究人員控制他們的 ORCID 記錄,記錄持有者可以選擇隨時撤銷任何訪問令牌,方法是從權限中刪除它 可信組織n 在他們的受信任方頁面下列出。
截至 2018 年,研究人員只能授予持續 20 年的長期訪問令牌,除非用戶撤銷許可。
ORCID 提供了一個簡單的 Java 腳本小部件 可用於獲取經過身份驗證的 ORCID 使用 OAuth 和 OpenID Connect 的 ID。
請注意,該小部件使用隱式 OAuth,因此不會收集任何寫入權限。 這意味著它不適合希望更新記錄的成員集成。 請參閱我們的教程 添加和更新數據 ORCID 紀錄。
ORCID API
公共客戶憑據授予個人而非組織。 憑證不能從一個人轉移到另一個人,但如果收到各方的同意並且該組織是 API 的活躍成員,則它們可以轉換為成員 API 憑證 ORCID.
將用戶端 ID 移至會員 API 不會變更用戶端 ID,只會變更用戶端金鑰,且您將保留具有唯讀權限的已連線 iD 的數量。
將公共 API 客戶端轉換為成員 API 客戶端時 公共客戶服務條款 不再適用,並由會員協議的條款取代。
對於轉移,我們需要:
- 確認要轉換的公共 API 用戶端 ID。
- 該組織的主要聯絡人和目前公共 API 用戶端 ID 的記錄持有者同意服務條款的變更。 (記錄持有者必須是會員組織的員工、承包商或高級職員)我們將保存雙方同意的記錄。
- 遷移發生的日期/時間。作為此遷移的一部分,我們將更新客戶端 ID 並透過加密電子郵件向您發送新的客戶端金鑰。請注意,一旦我們更新客戶端,您的整合將無法運作,直到您更新客戶端金鑰。這就是為什麼我們需要確定執行此操作的日期和時間,並防止給用戶帶來不便。
要完成轉換,您需要更新:
- 舊客戶端密碼到新客戶端密碼。
- API主機來自 pub.orcid.org 至 api.orcid.org.
使用轉換後的成員 API 客戶端 ID,您可以更新範圍以添加 成員 API 範圍. 這將需要用戶授權,並且將生成新的訪問令牌以包含新的範圍/權限。
請注意,我們無法將成員 API 客戶端憑據轉換為公共 API 憑據。
此示例調用檢索完整的摘要 ORCID 使用沙盒服務器上的成員 API 以 XML 格式記錄。 您需要訪問令牌才能向公共或成員 API 發出 API 請求。
Method: GET
Accept: application/vnd.orcid+xml
Authorization type and Access token: Bearer [Stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/record
API 將返回 200 OK 消息,表示請求已成功接收,以及完整的摘要信息 ORCID 記錄,包括單個項目的摘要
<?xml version="1.0" encoding-"UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789"
xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">
[...]
</record:record>
每個項目(工作、資金、就業等)都有一個 放代碼. 如果需要,這可用於獲取項目的完整詳細信息。
ORCID 記錄被分成單獨的部分,使閱讀記錄更快、更一致。 您可以先調用一個部分以接收其摘要,然後使用單個項目的放置代碼進行調用以接收有關該項目的可靠信息。
您可以使用 API 閱讀的摘要部分的表格如下所示。
端點 | 產品描述 |
/記錄 | 完整的摘要視圖 ORCID 記錄 |
/人 | 傳記部分 ORCID 記錄,包括通過下面的 /researcher-urls |
/概括 | 已驗證和自斷言項目的摘要視圖 ORCID 記錄(僅適用於會員 API) |
/地址 | 研究人員所在國家或地區 |
/電子郵件 | 與記錄關聯的電子郵件地址 |
/外部標識符 | 其他系統中鏈接的外部標識符 |
/關鍵詞 | 與研究人員及其工作相關的關鍵詞 |
/其他名稱 | 研究人員知道的其他名字 |
/個人資料 | 個人詳細信息:研究人員姓名、信用(出版)姓名和傳記 |
/研究人員網址 | 鏈接到研究人員的個人或個人資料頁面 |
/活動 | 活動部分摘要 ORCID 記錄,包括通過下面的 /works。 |
/教育 | 教育機構 |
/就業 | 就業關係 |
/資金 | 資助活動摘要 |
/同行評審 | 同行評審活動總結 |
/作品 | 研究工作總結 |
/研究資源 | 研究資源總結 |
/服務 | 服務概要 |
/資格 | 資質概要 |
/會員 | 會員概要 |
/區別 | 區別總結 |
/邀請職位 | 受邀職位摘要 |
此示例調用檢索完整的摘要 ORCID 使用沙盒服務器上的成員 API 以 XML 格式記錄。 您需要訪問令牌才能向公共或成員 API 發出 API 請求。
Method: GET Accept: application/vnd.orcid+xml
Authorization type and Access token:
Bearer [Stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/record
API 將返回 200 OK 消息,表示請求已成功接收,以及完整的摘要信息 ORCID 記錄,包括個別項目的摘要。
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">
[...]
</record:record>
每個項目(工作、資金、就業等)都有一個 放代碼。 如果需要,這可用於獲取該項目的完整詳細信息。
在您可以將項目添加到 ORCID 記錄您需要將數據格式化為 ORCID 架構。 格式化您的數據 ORCID XML 或 JSON 中的消息模式。
我們的 GitHub 存儲庫包含在創建新項目時有助於格式化的資源 ORCID 記錄,並在閱讀現有項目時 ORCID 記錄:
請注意,不同版本的 API 具有不同的消息格式。 版本 2.0 和 2.1 模式和示例也可用.
通過閱讀填充良好的記錄的元數據,可以輕鬆找到更多示例。
較早的版本 ORCID API 有額外的範圍。 這些範圍在 2.0 API 中被淘汰。 我們鼓勵所有集成僅使用推薦的範圍。 作為參考,下面列出了較早的作用域以及應該使用的當前作用域
- /orcid-profile/讀取限制 改用 /讀限制
- /orcid-works/讀取限制 改用 /讀限制
- /orcid-bio/讀取限制d 改用 /讀限制
- /orcid-works/創建 改用 /活動/更新
- /orcid-works/更新 改用 /活動/更新
- /從屬關係/創建 改用 /活動/更新
- /從屬關係/更新 改用 /活動/更新
- /資助/創建 改用 /活動/更新
- /funding/update 改為使用 /activities/update
- /orcid-bio/更新 改用 /人/更新
- /orcid-bio/外部標識符/創建 改用 /人/更新
刷新令牌用於生成額外的訪問令牌。 在交換授權代碼作為訪問令牌的一部分時,刷新令牌與訪問令牌一起返回 三足OAuth流程,只要訪問令牌保持活動狀態就可以使用它。
新訪問令牌可以與原始訪問令牌具有相同的到期時間和範圍,或者可以指定為具有更短的生命週期以及來自原始訪問令牌的較小範圍子集。 可以生成新的訪問令牌以替換原始令牌或生成新的訪問令牌以用作附加令牌。 您還可以使用刷新令牌調用使原始訪問和刷新令牌以及用戶授予的任何權限完全過期。
我們建議在以下情況下使用刷新令牌:
- 替換可能已被洩露的訪問令牌(一定要在之後撤銷原始訪問令牌)
- 給予第三方也是您的一部分 ORCID 整合更有限的訪問和/或在有限的時間內訪問。
請參考我們的 技術文檔 關於如何從刷新令牌創建新的訪問令牌。
有兩種不同的更新範圍 - 一種用於傳記詳細信息,另一種用於活動。
範圍 | 產品描述 | API端點 |
/人/更新 | 個人資料-左欄 ORCID 記錄用戶界面。 | /地址 /外部標識符 /關鍵詞 /其他名稱 /研究人員網址 |
/活動/更新 | 研究活動數據-右欄 ORCID 記錄用戶界面。 | /區別 /區別 /教育 /教育 /就業 /就業 /資金 /資金 /邀請位置 /邀請職位 /會員 /會員 /同行評審 /同行評審 /資格 /資格 /研究資源 /研究資源 /服務 /服務 /工作 /作品 |
使用您的客戶端 ID、機密以及活動令牌或其關聯的刷新令牌來撤銷令牌對。 您可以撤銷在兩條腿和一條腿上創建的令牌對 三足OAuth流程. 如果您有多組令牌,例如針對不同的範圍,則只會撤銷指定的訪問令牌和相應的刷新令牌。
我們建議在以下情況下撤銷令牌:
- 在關係終止後撤銷發給第三方供應商的代幣;
- 在用戶斷開連接時撤銷令牌 ORCID iD 來自您的系統;
- 允許用戶從您的系統內撤銷令牌。
我們建議使用 刷新令牌 限制現有訪問令牌的範圍或持續時間,或者在令牌已被洩露時更新令牌。
撤銷 API 調用
https://sandbox.orcid.org/oauth/revoke (or https://orcid.org/oauth/revoke)
METHOD: POST
HEADER: accept:application/json
CONTENT-TYPE: application/x-www-form-urlencoded
DATA:
client_id=[Your client ID]
client_secret=[Your client secret]
token=[access token or refresh token for token pair to be revoked]
上的所有項目(除了傳記文本) ORCID 記錄有一個 放代碼:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0"> [...]
</record:record>
此放置代碼可用於調用 API 以檢索項目的完整數據。 可以使用以下項目查詢 放代碼:
端點 | 產品描述 |
/地址/[放置代碼] | 個別國家或地區 |
/傳 | 傳記字段:只有研究人員可以編輯的自由文本區域 |
/教育/[輸入代碼] | 個人教育隸屬項目 |
/email/[輸入代碼] | 與記錄關聯的個人電子郵件地址 |
/就業/[放代碼] | 個人僱傭關係項目 |
/外部標識符/[放置代碼] | 另一個系統中的單獨鏈接的外部標識符 |
/funding/[放置代碼] | 個人資助活動 |
/keywords/[輸入代碼] | 與研究人員及其工作相關的單個關鍵字 |
/other-names/[輸入代碼] | 研究人員知道的個人附加名稱 |
/peer-review/[放置代碼] | 個人同行評審活動 |
/researcher-urls/[放置代碼] | 指向研究人員個人或個人資料頁面的個人外部鏈接 |
/work/[放置代碼] | 個人研究工作 |
/works/[放代碼1],[放代碼2],[放代碼3] | 批量個人研究作品(最多 100 個) |
使用部分端點和放置代碼,您可以使用相同的訪問令牌調用 API 以完整獲取該特定項目。 此示例調用使用沙盒服務器上的成員 API 以 XML 格式檢索全部資金項目 4413。
Method: GET Accept: application/vnd.orcid+xml Authorization type and Access token: Bearer [stored access token]URI: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/funding/4413
API 將返回 200 OK 消息以指示消息已成功接收並返回資助項目的完整 XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<funding:funding put-code="4413" path="/0000-0002-9227-8514/funding/4413" visibility="public" [...] >
[...]
</funding:funding>
您可以檢查 物品來源 如果您想知道誰添加了它,請在閱讀時。
ORCID 成員可以更新他們之前添加到 ORCID 記錄。 一次只能更新一個項目,並且只能使用最初創建它的客戶端憑據進行更新。
為方便更新,請確保您 存儲放置代碼和訪問令牌 創建項目時。
格式化更新的項目 in ORCID 消息模式 包含更改的信息並包括存儲的 放代碼.
<?xml version="1.0" encoding="UTF-8"?> <employment:employment put-code="739288" [...]> [...] </employment:employment>
調用 API:
Method: PUT Content-type: application/vnd.orcid+xml or application/vnd.orcid+jsonnAuthorization type and Access token: Bearer [stored access token]Data: link to file or text of affiliation to update URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288
API 將返回 200 OK 消息以指示該項目已正確更新。 如果返回不同的消息,請查看我們的故障排除頁面。
可見性指示項目的隱私設置,基於用戶設置的可見性首選項。 如果在通過 API 發布信息時包含可見性標記,它將被忽略。 相反,信息將根據用戶在其帳戶首選項中設置的默認可見性首選項發布。
任何人都可以通過 API 讀取公共項目,並顯示在研究人員的公共記錄中,可信方項目僅通過 API 返回給具有讀取限制訪問權限的客戶; 他們不在研究人員的公共記錄中。 私有項目僅對研究人員和項目來源可見——通過 API 返回的唯一私有項目是那些通過您的集成添加到記錄中的項目 有關可見性設置的更多信息 ORCID 註冊表.
項目(作品、就業、資金、同行評審等)可以添加到 ORCID 記錄使用 ORCID 會員API。 為此,您必須首先 使用 OAuth 獲得研究人員的許可 格式化項目元數據 使用 ORCID 消息架構。
一旦你格式化了數據並收集了 ORCID iD 和訪問令牌,您使用 HTTP POST 發出 API 請求,指定 相關終點.
Method: POST
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]data: link to file or text of single employment item to add
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment
下面的調用添加了一個新的 僱用 與沙盒測試服務器上的記錄的隸屬關係:
<?xml version="1.0" encoding="UTF-8"?>
<employment:employment [...]>
[...]
</employment:employment>
API 將返回一條 201 消息以指示該項目已正確發布,以及該項目 放代碼。 您的客戶將被列為 物品來源.
細味觀察 故障排除 頁面,如果返回不同的消息。 您將需要保存 存儲放置代碼和訪問令牌 進行任何更新或刪除項目。
ORCID 搜索 API 使用 SOLR 語法。 支持 SOLR 3.6 中可用的所有查詢語法,包括帶有 Solr 擴展的 Lucene (默認)、DisMax 和擴展 Dismax。
您需要一個“/read-public”訪問令牌才能使用它。 獲得搜索令牌後,構建基本搜索 URL:
憑證類型: | 公開API | 會員API |
資源網址: | 沙箱:https://pub.sandbox.orcid.org 製作:https://pub.orcid.org | 沙箱:https://api.sandbox.orcid.org 製作:https://api.orcid.org |
API版本: | v3.0 | |
搜索端點 | /search/?=[查詢] |
在沙箱公共 API 上使用令牌搜尋「orcid」的呼叫範例,結果以 XML 格式傳回:
Method: GET Content-type: application/vnd.orcid+xmlnAuthorization type and Access token: Bearer [stored access token]URL: https://pub.sandbox.orcid.org/v3.0/search/?q=orcid
結果會指定找到的結果數(num-found)並默認顯示前1000條結果:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<search:search num-found="385" xmlns:search="https://www.orcid.org/ns/search" xmlns:common="https://www.orcid.org/ns/common">
<search:result>
<common:orcid-identifier>
<common:uri>https://sandbox.orcid.org/0000-0001-2345-6789</common:uri>
<common:path>/0000-0001-2345-6789</common:path>
<common:host>sandbox.orcid.org</common:host>
</common:orcid-identifier>
</search:result>
[...]
</search:search>
沙盒公共 API 上的示例基本搜索,結果以 json 格式返回:
Method: GET
Content-type: application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=newman
搜索只返回個人 ORCID 保存與搜索匹配的公共數據的記錄的 ID。 要獲得有關結果的更多信息,請致電閱讀 ORCID 直接記錄。
有關更多信息,請參見 搜索 API 教程.
如果您添加了需要刪除的數據,例如,如果它已關聯錯誤 ORCID iD,然後您可以發出 HTTP DELETE 請求,指定 相關終點, 隨著 ORCID ID, 存儲訪問令牌和存儲放置代碼. 一次只能刪除一項,您只能刪除客戶添加的項目。 即使用戶已撤銷權限,您也可以刪除項目。
此示例調用從記錄中刪除帶有放置代碼“739288”的就業項目”
Method: DELETE
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288
ORCID 搜索 API 使用 SOLR 語法。 支持 SOLR 3.6 中可用的所有查詢語法,包括帶有 Solr 擴展的 Lucene (默認)、DisMax 和擴展 Dismax。
當您需要搜索特定部分時,您可以使用字段搜索 ORCID 記錄。 API 搜索中識別的當前字段列表及其對應的記錄結構元素如下:
搜索領域 | 產品描述 |
傳記資料 | |
姓 | 用戶的給定(名字)名稱。 |
姓 | 用戶的家族 (sur) 名稱。 |
信用名 | 上的“公開名稱” ORCID 用戶界面,通常出現在用戶發布的名稱上 |
其他名稱 | 用戶可能在出版物中出現的替代名稱。 |
電子郵件 | 用戶的電子郵件地址。 |
關鍵詞 | 與用戶關聯的任何關鍵字。 |
外部 ID 參考 | 來自其他系統的標識符添加到用戶的 ORCID 使用 API 記錄。 |
隸屬關係數據 | |
隸屬關係組織名稱 | 用戶記錄中教育或就業項目中任何組織的名稱。 |
網格組織 ID | 網格標識 用戶記錄活動部分中的任何組織。 通常,這將與教育或就業項目相關聯。 |
組織編號 | 識別號 用戶記錄活動部分中的任何組織。 通常,這將與教育或就業項目相關聯。 |
Ringgold-組織 ID | 金幣ID* 使用者記錄的活動部分中的任何組織。 一般來說,這與教育或就業項目有關。 |
資金數據 | |
資金頭銜 | 用戶記錄中任何資金項目的標題。 |
Fundref-org-id | 交叉引用資助者註冊 ID 用戶記錄的活動部分中的任何組織。 通常這將與資助項目相關聯,但也可能與從屬關係相關聯。 |
授權號 | 用戶記錄中任何資助項目的授權編號(標識符)。 |
研究活動數據 | |
職稱 | 用戶記錄中任何作品的標題。 |
數字對象 ID | doi 類型的工作外部標識符 |
做自己 | 類型為 doi 且外部標識符關係設置為 self 的工作外部標識符 |
[外部標識符類型]* | 具有給定類型的工作外部標識符 |
[外部標識符類型]*-self | 具有給定類型且外部標識符關係設置為 self 的工作外部標識符 |
[外部標識符類型]*-part-of | 具有給定類型且外部標識符關係設置為部分的工作外部標識符 |
[外部標識符類型]*-version-of | 具有給定類型且外部標識符關係設置為 version-of 的工作外部標識符 * 有關外部標識符的完整列表,請參閱 標識符列表。 某些標識符可能需要“-self”、“-part-of”或“-version-of”才能傳回結果 |
ORCID 記錄數據 | |
蘭花 | 16 位數字 ORCID 用戶標識符,格式為 0000-0001-2345-6789。 |
個人資料提交日期 | 創建記錄的日期和時間。 |
個人資料上次修改日期 | 上次修改記錄的日期和時間。 |
所有資料 | |
文本 | 以上所有字段。 這也是 Lucene 語法查詢的默認字段。 |
請參閱我們的 搜索 API 教程 獲取更多訊息
*儘管 Ringgold 識別碼仍然存在於 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我們不再接收註冊機構使用的 RINGGOLD 組織識別碼資料庫的更新,也無法處理或使用該日期之後建立的 RINGGOLD ID。 看看我們的 常見問題 更多信息
在實際情況下,API 交互由您的系統使用 PHP、Java 或 Ruby on Rails 等編程語言完成。 對於練習和測試,您可以與 ORCID 使用一系列能夠發出和接收 HTTP 請求的工具的 API。 大多數桌面 HTTP 工具都在命令行中運行; 對於喜歡圖形界面的人來說,基於網絡的工具是一個有用的選擇。
XML/XSD 驗證
有許多工具可以為您驗證 XML; 採用一個是個好主意。 對於許多 API 調用,您將使用 XML 格式的信息。 尤其是在與 ORCID API 消息,重要的是您使用的 XML 對 XSD 有效。 (見我們的 GitHub 上的文檔 為了 ORCID 消息模式 XSD。)
ORCID 沙盒測試服務器
沙盒測試服務器 是副本 ORCID 註冊軟件,只包含測試數據。 它旨在提供一個嘗試事物的地方,而不會影響任何實際 ORCID iD,尤其是當您使用 ORCID API 並且需要一個地方來測試你的工作。 您可以在沙盒上創建用戶帳戶並測試 API 調用,而無需擔心影響生產數據或不小心向研究人員發送垃圾郵件。
你甚至不需要成為 ORCID 成員在沙箱中試用成員 API。 歡迎所有人申請沙盒成員 API 憑證並試用成員 API 可用的全部功能。
站點和 API 不會像生產服務器那樣可靠。 我們對沙箱上的數據不做任何保證; 它們沒有備份,可能會被刪除。 沙箱還可能包含一些尚未出現在生產服務器上的實驗性功能,因此您可以在它們出現在註冊表中之前進行嘗試。 了解更多 關於沙盒測試服務器或 請求客戶端憑據.
HTTP 工具
有許多工具可用於運行 HTTP 請求。 我們使用的一些:
- 捲曲
- 郵遞員
- wget的
- 投擲
- 谷歌 OAuth 2.0 遊樂場
- 昂首闊步: 成員 API(沙盒), 公共 API(沙盒)
高級會員可以針對任何 ORCID 記錄在註冊表中。 步驟是:
對網址進行編碼
URL 編碼您想要的 URL ORCID 更新用戶記錄時調用。 例如以下網址:
https://nowhere2.com/0000-0002-7465-2162/updated
成為
https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
建立網址
構建完整的 URL ORCID 以 URL 開頭的 API 調用 ORCID 記錄然後新增‚√∫/webhook‚√π 和您要呼叫的 URL。所以它應該看起來像 https://api.sandbox.orcid.org/{ORCID}/webhook/{url-remoded-webhook-url}
例如,使用上面的 webhook URL 和 ORCID iD 0000-0002-7465-2162,完整網址為:
https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
註冊網絡鉤子
使用您的 webhooks、訪問令牌針對用戶的註冊您的 webhook ORCID 記錄。 您需要使用 HTTP PUT 請求,但不應在請求正文中包含任何內容。
URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdatedn HEADER: Accept: application/json HEADER: Authorization: Bearer [Your access token]n HEADER: Content-Length: 0n METHOD: PUT
響應應該是 201,但如果回調已經存在,那麼響應將是 204。
HTTP/1.1 201nServer: nginx/1.1.19nConnection: keep-alive Location: https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Frequestb.in%2Fz57lzcz5
取消註冊 webhook 的 URL 與註冊的 URL 相同。 但是,您需要使用 HTTP DELETE 方法。
URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
HEADER: Authorization: Bearer [Your access token]
HEADER: Content-Length: 0
METHOD: DELETE
回應應該是 204 No Content
.
HTTP/1.1 204 No Content
Server: Apache-Coyote/1.1
Date: Fri, 05 Apr 2013 12:49:17 GMT
ORCID 當記錄更新時,Registry 將執行以下 HTTP 調用。 該請求使用 HTTP POST 方法,但請求正文為空。
curl -v -X POST https://nowhere2.com/0000-0002-7253-3645/updated
您的服務器應使用標準 HTTP 響應代碼進行響應。 因此,如果調用成功,您應該返回 204 No Content。
HTTP/1.1 204 No Content
任何 2xx 響應代碼都表示調用成功。 如果您返回的代碼不是 2xx,我們將在五分鐘後重試呼叫。
在實際情況下,API 交互由您的系統使用 PHP、Java 或 Ruby on Rails 等編程語言完成。 但是,對於練習和測試,您可以與 ORCID API 使用一系列能夠發出和接收 HTTP 請求的工具。 大多數桌面 HTTP 工具(例如 捲曲) 在命令行中運行; 對於喜歡圖形界面的人來說,基於網絡的工具是一個有用的選擇。
一種流行的工具是 Google 的 OAuth 2.0 Playground,一款由 Google 開發和維護的基於網絡的免費工具。
請參閱我們的 API 實務教學:https://info.orcid.org/hands-on-with-the-orcid-api/
注意: ORCID 不維護 OAuth 2.0 Playground——這個工具是由谷歌創建的,谷歌專門維護其代碼。 雖然我們會定期更新此文檔,但有時可能會出現一些不准確之處,因為我們可能無法立即了解 OAuth 2.0 Playground 的更改。
對於我們的 API 2.0 及以上版本,限制是:
- 請求一秒鐘 - 24
- 爆發 – 40
請求一秒鐘 - 一秒鐘可以發出的請求數。
突發 – 我們允許在拒絕之前排隊的請求數。 隊列中的請求被減慢到每秒請求的速率。 如果超過突發,您將收到 503 響應。
如果您遇到限制問題,請務必聯繫您的參與團隊負責人尋求支持。
研究員控制是核心 ORCID 原理 所以電子郵件地址註冊並添加到 ORCID 默認情況下,記錄設置為僅對記錄持有者可見。 未經驗證的電子郵件不會顯示在記錄的公共視圖中,只有經過驗證的電子郵件地址才會出現在 API 結果中。
一旦研究人員驗證了他們的電子郵件地址,他們必須選擇使其對所有人(即公開)或受信任方(即有限訪問)可見,以便第三方組織讀取該電子郵件地址。
如果研究人員將他們的電子郵件地址設置為受信任方,如果研究人員已授予您,它將與記錄一起返回 讀限制訪問。 有關更多信息,請參閱 ORCID 可見性設置.
API 3.0 是默認 API 版本,我們建議您在構建新集成時使用此版本。 在可預見的未來,我們將繼續支持 API 2.0 和 2.1,並將在關閉這些版本之前至少提前 12 個月發出通知。
在從 API 1.2 過渡到 API 2 的過程中,我們學到了很多東西。這次我們讓升級變得更容易管理。 API 3.0 添加了新功能,同時僅在絕對必要時修改現有功能。 這意味著集成商應該能夠毫不費力地切換到新的 API。 這也意味著,雖然我們建議您盡快開始計劃升級,以便您的組織和研究人員可以從新功能中受益,但您在決定何時更新到 3.0 方面有很大的靈活性。
我們的 API 發行說明中列出了潛在的重大更改 這裡 這裡. 可選/必填字段有一些變化,JSON 枚舉略有修改,我們還對 XML 模式進行了小幅重構,添加了一些新字段以包含新功能所需的元數據。
請參閱 ORCID 面向發布者的支持供應商的系統頁面 獲取最新信息
任何高級會員都可以獲得“/webhook”訪問令牌。 單個令牌可用於為多個記錄註冊 webhook。 要獲得令牌,您可以調用 ORCID API 令牌端點。
此過程通常稱為客戶端憑據 OAuth 流程,或 2 步 OAuth。
下面是獲取訪問令牌的示例調用 - 用您的憑據替換佔位符(確保刪除括號。)
curl -i -L -H "Accept: application/json"
-d "client_id=(your client ID)"
-d "client_secret=(your client secret)"
-d "scope=/webhook"
-d "grant_type=client_credentials"
"https://sandbox.orcid.org/oauth/token"
然後,您將收到類似於以下內容的訪問令牌。
{"access_token":"5eb23750-1e19-47a3-b6f6-26635c34e8ee",
"token_type":"bearer",
"refresh_token":"c7d3d5fd-e4c0-4825-89f2-7cfb4a1cf01e",
"expires_in":631138518,
"scope":"/webhook"}
隨著我們繼續開發我們的產品,有許多功能僅適用於 API 3.0,這是我們最新的默認 API 版本。
下表提供了每個功能的簡短說明。 如果您對任何功能或升級到 3.0 有任何疑問,請聯繫您的參與主管或聯盟主管。
能夠讀取和寫入所有隸屬關係類型(以前版本的 API 不提供會員、服務、受邀職位、榮譽和資格) |
能夠閱讀和編寫研究資源。 |
能夠讀寫關係類型為“資助者”的工作標識符。 這用於將 Grant 或 Proposal ID 鏈接到工作元數據。 |
能夠讀寫關係類型為“版本”的工作標識符。 這用於將其他版本的作品鏈接在一起。 一個示例用例是鏈接預印本和已發表的文章。 |
能夠在作品元數據中讀取和寫入 CRediT 角色。 |
能夠讀取額外的源字段 常見:斷言來源客戶端ID 常見:斷言來源名稱 對於添加的從屬關係 ORCID 通過搜索和鏈接嚮導添加成員門戶和作品。 |
能夠讀寫以下工作類型的作品: 註解 數據管理計劃 學位論文 預印本 物理對象 檢討 |
能夠讀取和寫入附屬機構的外部 ID。 |
必須提供組織 ID 才能將附屬機構和資金添加到 ORCID 紀錄。 |
形式化標識符——我們引入了一個新的系統生成字段,它以規範化的格式表示外部標識符(DOI、PMCID、PMID、ArXiv、Bibcode、ISSN 和 ISBN),以便進行匹配和分組。 規範化是根據標識符類型的規則完成的,可能包括將所有字母字符設置為小寫,或轉換空格、破折號、句點和其他可以視為等效的字符。 它還根據需要添加標準前綴和後綴。 例如, https://doi.org/10.1/123, 10.1/123和 https://dx.doi.org/10.1/123 都將出現在此字段中 https://doi.org/10.1/123. 現有標識符值未修改。 |
可以找到更詳細的信息 這裡.
其他
他們收到通知 ORCID 收件箱. 每當數據發生變化時 ORCID 記錄,用戶會收到通知,其中包含有關更改的基本信息,包括執行更新的客戶端名稱、更改日期以及更改的項目 ORCID 已更新的記錄。 查看我們的 用戶知識庫,了解有關通知的更多信息.
ORCID 沙箱上的記錄也有 功能收件箱. 我們建議您定期查看測試的收件箱 ORCID 在規劃系統如何安排數據更新時記錄。
API 用戶的更新和其他公告通過 ORCID API用戶組. 您還可以通過以下方式訂閱一般消息和更新 ORCID 部落格.
ORCID 會員還可獲得 ORCID 包含此信息的會員通訊。 最後,任何技術聯繫人 ORCID 具有活動的定制集成的成員還將收到有關任何重要更新的電子郵件消息 ORCID 註冊表。 如果您想被列為貴組織的技術聯繫人,請 聯繫我們 (contact us).
ORCID 致力於公開透明。 這意味著我們的 產品路線圖 任何人都可以查看,就像 目前正在開發的工作.
產品路線圖是 ORCID 產品開發過程。 需求從團隊管理的 trello 板,通過產品路線圖 trello 板,再到 Current Development trello 板,在那裡它們被實施並轉移到我們的生產系統。
該委員會包含計劃實施的明確定義的要求 在某一點,以及計劃在近期實施的優先需求列表。
需求從何而來?
需求是從許多來源收集的 ORCID 職員。 它們可能源自成員請求、聯盟反饋、用戶測試、戰略項目和錯誤報告等。 此外,所有 ORCID 團隊生成自己的內部需求,例如網站更改、基礎設施升級和操作系統更新。 每張卡片都標有產生需求的團隊——通信、戰略、技術、參與或運營。
路線圖上的事情怎麼做?
ORCID 旨在實現平衡的產品開發週期,並定期召開跨團隊會議來討論近期和長期的優先事項。 我們盡最大努力同等地解決錯誤、新功能、技術債務、網站更新和戰略項目。
我如何為路線圖做出貢獻?
我們歡迎有關如何改進的建議 ORCID 註冊表。 請將任何反饋發送至 我們的團隊.
此外, ORCID 是一個開源項目,我們歡迎對我們的源代碼以及所有 我們的存儲庫.
預印本是由作者上傳到公共服務器的完整科學手稿。 預印本包含完整的數據和方法; 通常是將同一份手稿提交給期刊。 經過簡短的質量控制檢查以確保作品具有科學性,作者的手稿會在一天左右的時間內未經同行評審就張貼在網上,全世界任何人都可以免費查看。 根據反饋和/或新數據,可以提交預印本的新版本; 然而,先前的預印本也被保留。 預印本服務器允許科學家直接控制他們的工作向全球科學界的傳播。 在大多數情況下,作為預印本發布的相同作品也會提交給期刊進行同行評審。 因此,預印本(快速,但未通過同行評審驗證)和期刊出版(緩慢,但使用同行評審提供驗證)作為科學研究的交流系統並行工作。
注意:此內容和視頻最初出現在 ASAPBio 網站 感謝 ASAPBio 在 CC-BY 許可下提供它!
會員通訊每月發送自 ORCID 之前包含指向存儲所有會員報告的 Google 雲端硬盤文件夾的鏈接。 該報告現已被替換為可供所有成員使用的新報告 會員門戶.
之前的報導:
- 具有主動集成功能的高級會員 接收指向文件夾的唯一鏈接,該文件夾包含單獨的自定義報告以及上個月每個集成的數據。
- 尚未主動集成的高級會員 收到一個文件夾的唯一鏈接,其中包含包含其機構的電子郵件統計信息的自定義報告,以及一個包含一般報告和所有活躍會員集成的聚合數據的文件夾的鏈接。
- 基本會員 收到一個文件夾鏈接,其中包含每年兩次發布的一般報告,其中包含前半年所有活躍會員集成的匯總數據; 上半年報告發佈於 七月 (XNUMX-XNUMX月數據),下半年報告發布 一月 (次年XNUMX月至XNUMX月)。
如果你是一個 ORCID 會員,目前未收到每月的會員通訊,請聯繫 [email protected]
具有主動集成功能的高級會員
Google Drive 文件夾包含向您頒發的每個生產客戶端 iD 的成員報告。 文件名包括客戶端的顯示名稱 iD 以及報告日期; 請按修改日期排序以查找最新的報告。 還有一個 raw_data 文件夾,其中包含用於生成報告的數據,如果需要,可用於其他分析。
尚未主動集成的高級會員
Google 雲端硬盤文件夾包含僅包含電子郵件統計數據的會員報告,以及指向一般月度報告的 Google 雲端硬盤文件夾的鏈接,其中包含當前和往年所有活躍會員集成的匯總數據。 這些報告沒有原始數據。
電子郵件域計數
本節提供了 ORCID iDs 當前在所有時間段內註冊了您所在機構的電子郵件域。 為了生成這些計數,我們會搜索與我們為您的組織存檔的網站 URL 相匹配的域(例如:如果您的網站 URL 是 www.universitycollege.edu,我們會搜索以@universitycollege 結尾的電子郵件)。 如果我們沒有存檔的網站 URL,您會在本節中看到“√∫未提供電子郵件域”√π。 如果我們沒有得到您的電子郵件域非常正確,或者如果您想添加其他域,請 聯繫我們 (contact us).
- 註冊到您的電子郵件域的記錄¬¨‚獨特的計數 ORCID 包含貴機構電子郵件域中的地址的 iD
- 註冊到您的電子郵件域並與您的客戶 ID 關聯的記錄¬¨‚獨特的計數 ORCID 包含您機構電子郵件域中的地址並將您的機構作為可信方的 ID(即:您的機構具有有效訪問令牌的記錄)
創建和聲明的記錄
(注意:大多數客戶的報告中不會包含此部分)
如果您有一個機構客戶用於通過 API 代表研究人員創建記錄,您將收到一個名為“註冊統計”的部分。 這包括有關您創建的記錄數和已聲明的記錄數的信息(raw_data 文件包含有關用於生成這些數字的特定記錄的更多信息)。
用戶
報告的這一部分包含使用您的集成來連接他們的研究人員的總數 ORCID iD 在報告當月發送到您的系統。 此外,它還提供了註冊新研究的研究人員總數 ORCID iD 作為一部分 iD 連接過程。
標記為“總集成事件”的圖表顯示了上個月按天使用您的集成的研究人員數量
最新活動
報告還包含 活動 信息,研究人員在連接他們的信息時完成的動作 ORCID 在報告當月在您的系統中進行記錄。 每個事件代表用戶授予的任何訪問權限或他們在 ORCID 站點(例如登錄或授予讀取限制訪問權限)。 大多數研究人員都會有不止一個與他們相關的事件。
如果一個事件後面有一個‚√∫√π,這意味著研究人員授予了一個長壽的(P持久性)令牌,與一小時後過期的短期令牌相比。 自 2018 年 XNUMX 月以來,僅支持長壽命代幣 ORCID 登記處; 您的集成系統或用戶可以隨時選擇撤銷令牌。
按國家/地區劃分的用戶
報告的最後部分包含有關使用您的整合的研究人員的信息,按他們訪問您的整合的國家/地區細分。這些資料源自研究人員的 IP 位址或其地理 ID(由 Google 根據研究人員的 IP 位址自行決定)。
抽樣
因為很多研究人員都使用 ORCID Registry,對整組研究人員數據運行報告是不可行的。 相反,此處提供的數字是使用採樣和非採樣集的趨勢生成的。 源自抽樣數據的報告部分用星號表示,抽樣大小和空間在分析數據選項卡上指定。 報告的 Google Analytics(分析)部分中的數字可能與您保留的任何本地統計數據不完全匹配,並且報告各部分之間的計數可能存在細微差異。
Integration Analytics 下面列出的採樣參數適用於標有星號的所有部分。 分析數據捕獲的會話百分比為(樣本大小)/(樣本空間)* 100%。 有關採樣的更多信息,請訪問 谷歌開發人員.
空報告
報告的用戶和事件部分僅包含過去一個月的數據。 如果過去一個月沒有研究人員使用過您的集成,則不會返回任何數據。
問題
如果您對會員報告有任何疑問,請 聯繫我們 (contact us).
ORCID Registry 旨在讓用戶使用 OAuth 向組織提供他們的 ID,以確保正確的 iD 為每位研究人員收集。 我們不鼓勵組織添加 ORCID 基於按姓名搜索研究人員的系統 ID。 但是,了解您組織中有多少研究人員可能會有所幫助 ORCID iD,可以通過 API 完成。 下面給出了按組織搜索的建議。
有關搜索的介紹、如何獲取訪問令牌、如何理解您的搜索結果以及其他可搜索字段的詳細信息,請參閱我們的 搜索註冊表 API 教程
按名稱和 DOI 搜索
當檢查一個人是否有 ORCID 記錄,我們建議通過他們的姓名和他們最近的一部或多部作品的 DOI 進行搜索。 這應該只生成您正在尋找的研究人員的記錄,而不是其他同名的記錄。
搜索名稱為“Laurel Haak”和 DOI 10.1087/20120404 或 DOI 10.6084/M9.FIGSHARE.1115124 的所有記錄的示例調用:
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search?q=family-name:Haak+AND+given-names:Laurel+AND+digital-object-ids:%2210.1087/20120404%22+OR+digital-object-ids:%2210.6084/M9.FIGSHARE.1115124’%22
按隸屬關係搜索
可以使用從屬關係名稱或組織的唯一 ROR ID 或 GRID ID 來搜尋從屬關係欄位。 (您可以在以下位置找到組織的 GRID ID: GRID 或您的 ROR ID ROR註冊)
按組織名稱搜索
Method: GET Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:"University+of+Johannesburg"
或者完全匹配
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:(%22Boston%20University%22)
按網格 ID 搜索
用於搜尋 GRID ID grid.5509.9(坦佩雷大學)的所有記錄的呼叫範例:
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=grid-org-id:grid.5509.9
按 ROR ID 搜索
使用 ROR ID 搜索所有記錄的示例調用 04fa4r544 (ORCID):
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=ror-org-id:"https://ror.org/04fa4r544"
按電子郵件域搜索
您可以使用 API 通過電子郵件域搜索研究人員。 請記住,大約 97% 的電子郵件地址在 ORCID 是私有的,並且在此搜索中將不會返回具有私有或受信任訪問電子郵件地址的任何記錄。
用於搜尋具有 @orcid.org 電子郵件地址的所有記錄的呼叫範例:
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=email:*@orcid.org
以 CSV 格式返回的搜索結果
搜索結果也可以 CSV 格式返回。 作為調用的一部分,您可以從以下可用字段列表中指定輸出列:
蘭花
電子郵件
給定的名稱
姓
姓氏
信用名
其他名字
當前機構-隸屬關係-名稱
過去機構名稱
使用您的憑據,您需要將標頭指定為 '文本/csv'. 作為搜索調用的一部分,您還需要將輸出中所需的字段添加到查詢中。
僅使用瀏覽器進行搜索
您也可以使用瀏覽器完成搜索。 URL 的構造方式相同,但您不需要使用任何 API 憑據。 請注意,這只能使用公共 API 完成。
下面是一個使用公共 API 搜索的示例調用,按組織名稱搜索 ORCID,名字,姓氏,當前機構隸屬關係名稱和過去機構隸屬關係名稱作為所需的輸出。
https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:ORCID&fl=orcid,given-names,family-name,current-institution-affiliation-name,past-institution-affiliation-name
下面是使用公共 API 搜索組織名稱的不同變體的另一個示例調用。
https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:("University of Plymouth" OR "Plymouth University")
eduPerson 架構添加了 eduPersonOrcid 在其屬性 2016年XNUMX月更新.
按照 eduPerson 規範:
RFC4512 definition
( 1.3.6.1.4.1.5923.1.1.1.16
NAME 'eduPersonOrcid'
DESC 'ORCID researcher identifiers belonging to the principal'
EQUALITY caseIgnoreMatch
SYNTAX '1.3.6.1.4.1.1466.115.121.1.15' )
請注意,此字段的格式為 ORCID-iD 的首選 URI 表示即, https://orcid.org/0000-0001-5727-2427.
有關格式的更多信息 ORCID iD 可以發現 結構 ORCID 識別碼.
如果您認為報告中顯示的數據不准確,請 聯繫我們 (contact us) 盡可能詳細,我們的參與團隊將進行調查。
如果您的組織是 ORCID 會員,那麼您需要聯繫 ORCID 您所在組織的聯繫人將能夠為您提供訪問 ORCID 會員門戶。 如果您無法識別您的組織 ORCID 請聯繫您的聯盟負責人或您的參與團隊代表。
我們喜歡來自社區的反饋,因此如果您對會員報告有任何反饋,請通過以下方式與我們聯繫 https://support.orcid.org/hc/en-us/requests/new
用於生成成員和集成報告的數據每天更新。