API 教程：搜索 ORCID 註冊處

本教程介紹瞭如何搜索 ORCID 註冊表使用 ORCID 公共和成員 API。 這兩種方法都需要使用您的客戶端憑據檢索訪問令牌。

ORCID API 支持搜索 ORCID 元數據使用流行的 Solr 查詢語法。 請注意，只有 ORCID iDis 在搜索結果中返回。 有關從特定位置檢索數據的信息 ORCID iD 可以發現 從一個讀取數據 ORCID 記錄.

API 搜索可能不適合您使用。 您可能希望考慮以下替代方案：

• 尋找研究人員 ORCID ID？ 我們不建議手動輸入任何 ORCID iD 進入您的系統或流程。 我們建議您收集經過身份驗證的 ORCID 來自您的研究人員的 ID。
• ORCID 發布一個 年度公共數據文件 — 中所有公共數據的快照 ORCID 那個時間點的註冊表——也可用於對註冊表中的大型公共數據進行搜索。 優質的 ORCID 成員還可以使用 公共數據同步.
• 有關查找大量貴機構研究人員的具體說明，請參閱我們的 尋找技巧 ORCID 您所在機構的記錄保持者

a

我為什麼要更新 ORCID 記錄？

您可以通過將經過驗證的信息連接到他們的 ORCID 記錄。 您還將幫助建立對學術交流的信任，並且通過使數據保持最新，您可以減輕用戶的報告負擔並提高數據質量。

ORCID 研究機構

除了用作研究人員的持久標識符之外， ORCID 可以幫助您控制您的機構名稱在研究系統中的使用方式。 結合其他持久標識符 ORCID 使您能夠權威地聲明您的教職員工和學生與您所在機構的關係。 你也可以使用 ORCID 用於接收有關研究活動的實時通知、自動更新表格以及關注校友職業的 API。

ORCID 資助機構

通過嵌入 ORCID iDs 在您的資助工作流程中，您可以可靠地連接您的受助人和資助計劃 - 並節省每個人的時間並減少因手動鍵入信息而導致的錯誤。 使用 ORCID 在您的系統中，您可以通過斷言個人與您授予他們的贈款之間的聯繫，在構建值得信賴的研究信息基礎設施方面發揮自己的作用。

ORCID 對於出版商

研究人員是學術和研究出版商所做一切的核心。 準確的作者和審稿人信息對於索引、搜索和發現、出版物跟踪、資金和資源使用歸屬以及支持同行評審至關重要。

ORCID 充當信息中心，使您的作者和審稿人能夠可靠地連接到他們的貢獻，並共享來自他們的信息 ORCID 在他們與您的發布系統交互時進行記錄。 在出版過程中為所有作者和審稿人收集 iD——無論是書籍、期刊、數據集、作文、演示文稿、代碼還是各種其他作品——允許輕鬆共享信息，確保研究人員可以同意共享，節省了研究人員的時間和麻煩，降低了出錯的風險，而且至關重要的是，使研究人員能夠獲得他們所做的重要工作應得的榮譽。

您覺得此常見問題解答有幫助嗎？

1

0

永久鏈接

a

如何收集經過身份驗證的 ID？

整合 ORCID 進入您的系統允許您的組織收集經過身份驗證的 ORCID iD 並將它們新增至您自己的資料。同時，研究人員向組織提供讀寫其資料的權限。 ORCID 記錄。 

為了使這項工作發揮作用，組織 必須（MUST） 獲得 認證 ORCID 身份證 使用 ORCID OAuth API。這意味著它們包括一個 ORCID 系統內的品牌按鈕或鏈接，點擊後會要求用戶登錄 ORCID 記錄。

登入後，系統將要求使用者授權存取系統，並要求其提供資訊 ORCID iD

用戶的 ORCID iD 並在上面寫上名字 ORCID 記錄（取決於可見性設定）將作為此過程的一部分傳回給組織。然後系統可以向系統請求附加數據 ORCID API。

上述用於收集經過驗證的 API 的工作流程在以下兩個版本中均可使用 ORCID的公共和成員 API。前者可供非商業服務免費使用。

您覺得此常見問題解答有幫助嗎？

5

0

永久鏈接

獲取搜索令牌

任何擁有 API 憑證的人都可以搜索 ORCID 註冊表。 成員 API 需要一個 /讀公開 訪問令牌以進行 API 調用。 要獲取令牌，請調用 ORCID API 使用兩條腿的 OAuth 授權（即直接調用 API）。 公共和成員 API 憑證的調用是相同的。

a

如何獲得“/read-public”訪問令牌？

任何擁有公共或成員 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 記錄總結。

您覺得此常見問題解答有幫助嗎？

4

35

永久鏈接

基於關鍵字的基本搜索

可以在沙盒測試註冊表或實時生產註冊表上執行搜索。 搜索 API 端點接受 HTTP 請求的 GET。 唯一需要的輸入是傳遞給 Solr 搜索引擎的查詢字符串。 

a

我該如何使用 ORCID 搜索 API？

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 教程.

您覺得此常見問題解答有幫助嗎？

1

3

永久鏈接

擴展搜索

除基本搜索外，擴展搜索終點 擴展搜索 可用。使用此端點會傳回以下資訊：使用標準搜尋語法時，orcid-id、名字、姓氏、信用名、其他姓名、電子郵件和機構。結果可以 XML 或 JSON 形式傳回。

在沙箱公共 API 上搜索術語“jones”的示例

URL: https://pub.sandbox.orcid.org/v3.0/expanded-search/?q=spaceman

    <expanded-search:expanded-result>
        <expanded-search:orcid-id>0000-0002-2436-0000</expanded-search:orcid-id>
        <expanded-search:given-names>Dave Theodore</expanded-search:given-names>
        <expanded-search:family-names>Spaceman</expanded-search:family-names>
        <expanded-search:other-name>D Spaceman</expanded-search:other-name>
        <expanded-search:other-name>D T Spaceman</expanded-search:other-name>
        <expanded-search:institution-name>The University of The Moon</expanded-search:institution-name>
        <expanded-search:institution-name>Saturn Institute</expanded-search:institution-name>
    </expanded-search:expanded-result>

以 CSV 格式返回的搜索結果

搜索結果也可以 CSV 格式返回。 作為調用的一部分，您可以從以下可用字段列表中指定輸出列：

•  蘭花
•  電子郵件
•  給定的名稱
•  姓
•  姓氏
•  信用名
•  其他名字
•  當前機構-隸屬關係-名稱
•  過去機構名稱 

使用您的憑據，您需要將標頭指定為 '文本/csv'. 作為搜索調用的一部分，您還需要將輸出中所需的字段添加到查詢中。  

呼叫會員搜尋 Ringgold ID* 的範例，其所需的輸出包括 ORCID，姓名和隸屬關係。 

Method: GET
  Content-type: text/csv
  Authorization type: Bearer
  Access token: [Stored access token]
  URL:  https://api.orcid.org/v3.0/csv-search/?q=ringgold-org-id:385488&fl=orcid,given-names,family-name,current-institution-affiliation-name,'

您也可以使用瀏覽器完成搜索。 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”)

格式化搜索查詢

默認行為是對所有可用索引字段進行自由格式、不受限制的搜索。 因此，對“newman”的基本搜索將找到發布名稱為 Newman、給定名稱 Newman 或與標題中帶有“newman”的作品相關聯的研究人員等。可以根據指定的內容以 json 或 xml 形式返回搜索在內容類型中。

API 還支持使用多個關鍵字、精確短語和其他布爾搜索功能的布爾搜索。 必須使用方括號和大寫的“AND”或“OR”組合關鍵字——小寫的“and”和“or”被視為搜索的一部分。

在沙箱公共 API 上搜索匹配三個關鍵字（johnson、cardiology 和 houston）的記錄的示例布爾搜索：

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+AND+cardiology+AND+houston

在沙箱公共 API 上搜索匹配關鍵字“johnson”和關鍵字“caltech”或短語“California Institute of Technology”的記錄的布爾搜索示例，結果以 XML 格式返回：

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+AND+(caltech+OR+"California+Institute+of+Technology")

按字段搜索特定元素

當您需要搜索特定部分時，您可以使用字段搜索 ORCID 記錄。

字段搜索的基本語法是field:value，所以查詢字符串family-name:james 會找到姓為“James”的記錄，例如“Roland James”，但不會找到名字為“James”的記錄，例如作為“詹姆斯約翰遜”。

可以提供多個字段：值對。 匹配基於子字符串標記而不是原始字符串，因此查詢字符串 other-names:carberry 將匹配 J. Carberry 和 JS Carberry。

a

哪些字段 ORCID 搜索 API 支持？

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。 看看我們的 常見問題 更多信息

您覺得此常見問題解答有幫助嗎？

1

1

永久鏈接

搜索結果分頁

默認情況下，API 在公共 API 和成員 API 上返回 1000 個結果（或行）。 要一次顯示一定數量的結果，或檢索過去的前 1000 個結果，請為起點和結果數量添加參數。 一次可以返回的最大結果數也是1000。

在沙盒公共 API 上搜尋與關鍵字「orcid」相符的第二個 1000 個結果的範例：

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=orcid&start=1000&rows=1000

在沙盒公共 API 上搜索第 2 項到第 4 項的示例，搜索條件為“johnson”、“cardiology”和“houston”：

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+cardiology+houston&start=2&rows=3

使用公共 API 的示例查詢

例如1

搜索所有姓氏 ORCID “桑切斯”這個名字的記錄

例如2

搜索所有的所有可搜索字段 ORCID “英語”一詞的記錄

例如3

搜尋與 PubMed ID 2485-7732 工作相關的貢獻者

例如4

搜索姓氏“Einstein”和關鍵字“Relativity”的記錄。 只返回同時包含姓氏和關鍵字的記錄。

例如5

搜索姓氏 Taylor 和名字 Michael 的記錄。

例如6

搜索所有人的名字和姓氏 ORCID “雷蒙德”的記錄，但提升了姓氏。 名字包含“Raymond”的記錄和姓包含“Raymond”的記錄將被返回，但那些具有姓氏的記錄將出現在列表的頂部，並具有更高的相關性分數。

例如7

搜索所有人的名字和姓氏 ORCID “雷蒙德”的記錄，但提升了姓氏。 名字中包含“Raymond”的記錄和姓包含“Raymond”的記錄將被返回，但那些具有姓氏的記錄將出現在列表的頂部，並且具有更高的相關性得分。 ORCID ID https://sandbox.orcid.org/0000-0002-0879-455X 和 https://sandbox.orcid.org/0000-0001-6238-4490 將從結果中排除。

例如8

搜索將 DOI 10.1087/20120404 設置為 self 的記錄

例如9

搜索包含 10.1087 設置為 self 或 part-of 的 DOI 的記錄

例如10

搜索將 PubMed 標識符 27281629 設置為 self 的記錄

例如11

搜索帶有 ISBN 標識符的記錄，包括設置為 self 或 part-of 的 1234

例如12

搜尋電子郵件地址具有 @orcid.org 網域的所有記錄

例如13

搜索在 1 年 2017 月 XNUMX 日和今天之間修改的記錄

例如14

搜索與具有確切名稱“Boston University”或“BU”的組織有關的記錄

例如15

搜尋與 Ringgold ID* 1438（加州大學柏克萊分校）相關的 CSV 格式的記錄

例如16

使用擴展搜尋搜尋與 GRID ID grid.5509.9（坦佩雷大學）相關的記錄

* 儘管 Ringgold 識別碼仍然存在於 ORCID 截至 1 年 2023 月 XNUMX 日， ORCID 我們不再接收註冊機構使用的 RINGGOLD 組織識別碼資料庫的更新，也無法處理或使用該日期之後建立的 RINGGOLD ID。 看看我們的 常見問題 更多信息