APIチュートリアル：検索 ORCID レジストリ

このチュートリアルでは、検索方法について説明します。 ORCID を使用したレジストリ ORCID パブリックAPIとメンバーAPI。 これらの方法はどちらも、クライアントの資格情報を使用して取得したアクセストークンを必要とします。

ORCID APIは、のサブセットの検索をサポートします ORCID 一般的なSolrクエリ構文を使用したメタデータ。 のみに注意してください ORCID iDisが検索結果に返されました。 特定のデータからのデータの取得に関する情報 ORCID iD で見つけることができます からデータを読み取る ORCID 記録.

API検索はあなたの使用に適していないかもしれません。 これらの代替案を検討することをお勧めします。

• 研究者を探す ORCID iD？ 手動で入力することはお勧めしません ORCID システムまたはプロセスへのiD。 認証済みのものを収集することをお勧めします ORCID 研究者からのiD。
• ORCID リリースします 年次公開データファイル —内のすべての公開データのスナップショット ORCID その時点でのレジストリ—レジストリ内の大規模な公開データの検索を実行するためにも使用できます。 プレミアム ORCID メンバーは、を使用してオンデマンドでデータファイルにアクセスすることもできます。 パブリックデータ同期.
• 所属機関の研究者を多数見つけるための具体的な手順については、 見つけるためのヒント ORCID あなたの機関の記録保持者

検索トークンを取得する

APIクレデンシャルを持っている人は誰でも検索できます ORCID レジストリ。 メンバーAPIには / read-public API呼び出しを行うためにトークンにアクセスします。 トークンを取得するには、に電話をかけます ORCID XNUMX本足のOAuth認証を使用するAPI（つまり、APIへの直接呼び出し）。 呼び出しは、パブリックAPIクレデンシャルとメンバーAPIクレデンシャルで同じです。

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

{"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}

基本的なキーワードベースの検索

検索は、サンドボックステストレジストリまたはライブプロダクションレジストリで実行できます。 検索APIエンドポイントは、HTTPリクエストのGETを受け入れます。 必要な入力は、Solr検索エンジンに渡されるクエリ文字列のみです。 

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

 <?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> 

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、given-names、family-names、credit-names、other-names、email、および機関（標準の検索構文を使用する場合）。 結果は、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形式で返すこともできます。 呼び出しの一部として、以下の使用可能なフィールドのリストから出力列を指定できます。

•  orcid
•  email
•  名
•  苗字
•  与えられた家族の名前
•  クレジット名
•  ほかの名前
•  現在の機関-所属-名前
•  過去の機関-所属-名前 

クレデンシャルを使用して、ヘッダーを 'に指定する必要がありますtext / csv '。 検索呼び出しの一部として、出力に必要なフィールドもクエリに追加する必要があります。  

リングゴールドを検索するメンバーの呼び出しの例 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で返すことができます。 content-typeで。

APIは、複数のキーワード、正確なフレーズ、およびその他のブール検索機能を使用したブール検索もサポートしています。 キーワードは角かっこを使用して組み合わせる必要があり、大文字の「AND」または「OR」—小文字の「and」および「or」は検索の一部として扱われます。

XNUMXつのキーワード（johnson、cardiology、およびhouston）に一致するレコードのサンドボックスパブリックAPIでのブール検索の例：

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

キーワード「johnson」とキーワード「caltech」またはフレーズ「CaliforniaInstituteof Technology」に一致するレコードのサンドボックスパブリックAPIでのブール検索の例と、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は、「Roland James」などのファミリ名「James」のレコードを検索しますが、「James」などの名のレコードは検索しません。 「ジェームズ・ジョンソン」として。

複数のフィールド：値のペアを提供できます。 照合は生の文字列ではなくサブ文字列トークンに基づいているため、クエリ文字列other-names：carberryはJ.CarberryとJSCarberryの両方に一致します。

検索結果のページ付け

APIは、パブリックAPIとメンバーAPIの両方で、デフォルトで1000の結果（または行）を返します。 特定の数を一度に表示したり、最初の1000件を超えて取得したりするには、開始点と結果の数のパラメーターを追加します。 一度に返すことができる結果の最大数も1000です。

サンドボックスパブリックAPIで、キーワード「」に一致する1000番目のXNUMX件の結果を検索する例orcid"

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

サンドボックスパブリックAPIで、「johnson」、「cardiology」、「houston」という用語を使用した検索でアイテム2〜4を検索する例：

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

パブリックAPIを使用したクエリの例

例1

すべての家族名を検索 ORCID 「Sanchez」という名前のレコード

例2

すべての検索可能なフィールドをすべて検索します ORCID 「英語」という単語の記録

例3

PubMedでの作業に関連する寄稿者を検索します ID 2485-7732

例4

家系の名前が「Einstein」でキーワードが「Relativity」のレコードを検索します。 家族名とキーワードの両方を含むレコードのみが返されます。

例5

家系の名前がテイラーで、名前がマイケルのレコードを検索します。

例6

すべての名前と家族名を検索する ORCID 「レイモンド」のレコードですが、家系の名前を後押しします。 「レイモンド」を含む名と「レイモンド」を含む家族名のレコードが返されますが、家族名のレコードはリストの一番上に表示され、関連性スコアが高くなります。

例7

すべての名前と家族名を検索する ORCID 「レイモンド」のレコードですが、家系の名前を後押しします。 「レイモンド」を含む名と「レイモンド」を含む家族名のレコードが返されますが、家族名のレコードはリストの一番上に表示され、関連性スコアが高くなります。 ORCID ID https://sandbox.orcid.org / 0000-0002-0879-455Xおよびhttps：// sandbox。orcid.org / 0000-0001-6238-4490は結果から除外されます。

例8

正確なDOI10.1087 / 20120404がselfに設定されているレコードを検索します

例9

自己または一部に設定された10.1087を含むDOIを持つレコードを検索します

例10

PubMed Identifier27281629がselfに設定されているレコードを検索します

例11

自己または一部に設定された1234を含むISBN識別子を使用してレコードを検索します

例12

@が付いたメールアドレスですべてのレコードを検索しますorcid.orgドメイン

例13

1年2017月XNUMX日から今日までに変更されたレコードを検索する

例14

正確な名前が「ボストン大学」または「BU」である組織に関連するレコードを検索します

例15

リングゴールドと提携しているレコードを検索する ID 1438（カリフォルニア大学バークレー校）CSV形式

例16

GRIDに関連するレコードを検索する ID 拡張検索を使用したgrid.5509.9（タンペレ大学）