このチュートリアルでは、検索方法について説明します。 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の検索制限
パブリックAPIは10,000件の結果に制限されていることに注意してください。 (メンバーAPIトークンを使用して)メンバーAPIを使用しても、結果の数は制限されません。
検証済みの情報をユーザーに接続することで、ユーザーの生活を楽にすることができます ORCID 記録。 また、学術コミュニケーションへの信頼を築くのに役立ち、そのデータを最新の状態に保つことで、ユーザーのレポートの負担を軽減し、データ品質を向上させることができます。
ORCID 研究機関向け
研究者の永続的な識別子としての使用に加えて、 ORCID は、所属機関の名前が研究システム全体でどのように使用されるかを管理するのに役立ちます。 他の永続的な識別子と組み合わせて ORCID 教育機関とのスタッフ、教職員、および学生の所属を正式に主張することができます。 使用することもできます ORCID 研究活動に関するリアルタイムの通知を受信し、フォームを自動更新し、卒業生のキャリアを追跡するためのAPI。
ORCID 資金提供団体向け
埋め込むことで ORCID 資金調達ワークフローのiDを使用すると、助成対象者と資金調達プログラムを確実に接続でき、全員の時間を節約し、情報の手動入力によって発生するエラーを減らすことができます。 使用する ORCID あなたのシステムでは、個人とあなたが彼らに与える助成金との間のつながりを主張することによって、信頼できる研究情報インフラストラクチャを構築する上であなたの役割を果たすことができます。
ORCID 出版社向け
研究者は、学術出版社や研究出版社が行うすべての中心です。 正確な著者とレビューアの情報は、索引付け、検索と発見、出版物の追跡、資金提供とリソース使用の帰属、およびピアレビューのサポートに不可欠です。
ORCID 情報ハブとして機能し、作成者とレビュー担当者が投稿に確実に接続し、投稿者からの情報を共有できるようにします ORCID パブリッシング システムとのやり取りを記録します。 書籍、ジャーナル、データセット、構成、プレゼンテーション、コード、またはその他のさまざまな作品の出版プロセス中に、すべての著者と査読者の iD を収集することで、情報を簡単に共有でき、研究者が共有に同意できるようになります。研究者の時間と労力を節約し、エラーのリスクを軽減し、重要なことに、研究者が行っている重要な仕事に値するクレジットを取得できるようにします。
研究者にサインインを依頼すると、認証済みIDを収集します ORCID iD。 このプロセスは「OAuth」または「SSO」と呼ばれるテクノロジーを使用しており、ワークフローに組み込む必要があります。
APIチュートリアルを参照してください '認証を取得する ORCID iD' 詳細については。
検索トークンを取得する
APIクレデンシャルを持っている人は誰でも検索できます ORCID レジストリ。 メンバーAPIには / read-public API呼び出しを行うためにトークンにアクセスします。 トークンを取得するには、に電話をかけます ORCID XNUMX本足のOAuth認証を使用するAPI(つまり、APIへの直接呼び出し)。 呼び出しは、パブリックAPIクレデンシャルとメンバーAPIクレデンシャルで同じです。
パブリックまたはメンバーAPIクレデンシャルを持っている人は誰でも受け取ることができます / read-public アクセストークン。 トークンを取得するには、に電話をかけます 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エンドポイントは、HTTPリクエストのGETを受け入れます。 必要な入力は、Solr検索エンジンに渡されるクエリ文字列のみです。
ORCID 検索APIはSOLR構文を使用します。 SOLR3.6で使用可能なすべてのクエリ構文がサポートされています、Solr拡張機能を備えたLuceneを含む (デフォルト)、DisMax、およびExtendedDismax。
使用するには、「/ read-public」アクセストークンが必要です。 検索トークンを取得したら、基本検索URLを作成します。
クレデンシャルタイプ: | パブリックAPI | メンバーAPI |
リソースURL: | サンドボックス:https://pub.sandbox。orcid.ORG 制作:https:// pub。orcid.ORG | サンドボックス:https://api.sandbox。orcid.ORG 制作:https:// api。orcid.ORG |
APIバージョン: | v3.0 | |
検索エンドポイント | / search /?= [クエリ] |
「orcid」とサンドボックスパブリックAPIのトークンを使用して、結果を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、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
- 名
- 苗字
- 与えられた家族の名前
- クレジット名
- ほかの名前
- 現在の機関-所属-名前
- 過去の機関-所属-名前
クレデンシャルを使用して、ヘッダーを 'に指定する必要があります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の両方に一致します。
ORCID 検索APIはSOLR構文を使用します。 SOLR3.6で使用可能なすべてのクエリ構文がサポートされています、Solr拡張機能を備えたLuceneを含む (デフォルト)、DisMax、およびExtendedDismax。
の特定のセクションを検索する必要がある場合は、フィールド検索を使用できます。 ORCID 記録。 API検索で認識されるフィールドの現在のリストと、対応するレコード構造要素は次のとおりです。
検索フィールド | 説明 |
経歴データ | |
名前 | ユーザーの指定された(名)名。 |
苗字 | ユーザーの家族(sur)名。 |
クレジット名 | の「公開名」 ORCID ユーザーインターフェイス、ユーザーが出版物に通常表示する名前 |
他の名前 | ユーザーが出版物に表示した可能性のある別名。 |
ユーザーの電子メール アドレス。 | |
キーワード | ユーザーに関連付けられているキーワード。 |
外部 ID 参照 | ユーザーに追加された他のシステムからの識別子 ORCID APIを使用して記録します。 |
所属データ | |
所属組織名 | ユーザーの記録にある教育または雇用項目に含まれる組織の名前。 |
リングゴールド組織ID | リングゴールドID ユーザーの記録の活動セクションにある組織の通常、これは教育または雇用項目に関連付けられます。 |
グリッド組織 ID | グリッドID ユーザーの記録の活動セクションにある組織の通常、これは教育または雇用項目に関連付けられます。 |
r-org-id | ROR ID ユーザーの記録の活動セクションにある組織の通常、これは教育または雇用項目に関連付けられます。 |
資金調達データ | |
資金提供-タイトル | ユーザーのレコードにあるファンディング アイテムのタイトル。 |
Fundref-org-id | CrossrefFunderレジストリID ユーザーの記録の活動セクションにある任意の組織の。 通常、これは資金調達項目に関連付けられますが、所属に関連付けられる場合もあります。 |
付与番号 | ユーザーの記録にある資金調達項目の付与番号(識別子)。 |
研究活動データ | |
仕事のタイトル | ユーザーの記録にある作品のタイトル。 |
デジタルオブジェクトID | タイプdoiの作業外部識別子 |
ドイセルフ | タイプdoiおよび外部ID関係がselfに設定された作業外部ID |
[外部識別子タイプ] * | 指定されたタイプの作業外部識別子 |
[外部識別子タイプ] *-自己 | 指定されたタイプと外部識別子の関係がselfに設定された作業外部識別子 |
[外部識別子タイプ] *-part-of | 指定されたタイプと外部識別子の関係がpart-ofに設定された作業外部識別子 |
[外部識別子タイプ] *-バージョン-of | 指定されたタイプと外部識別子の関係がversion-ofに設定された作業外部識別子 |
*外部識別子の完全なリストについては、 識別子リスト。 一部の識別子では、結果を返すために「-self」、「-part-of」、または「-version-of」が必要になる場合があります。 | |
ORCID 記録データ | |
orcid | 16桁 ORCID 0000-0001-2345-6789形式のユーザーの識別子。 |
プロファイル-提出-日付 | レコードが作成された日時。 |
プロファイル-最終変更日 | レコードが最後に変更された日時。 |
すべてのデータ | |
テキスト | 上記のすべてのフィールド。 これは、Lucene構文クエリのデフォルトフィールドでもあります。 |
取り付けガイドを参照してください。 検索APIチュートリアル をご覧ください。
検索結果のページ付け
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を使用したクエリの例
パブリックAPIの検索制限
パブリックAPIは10,000件の結果に制限されていることに注意してください。 (メンバーAPIトークンを使用して)メンバーAPIを使用しても、結果の数は制限されません。
例1
すべての家族名を検索 ORCID 「Sanchez」という名前のレコード
構文: | ルセン |
ページング: | 行5〜10のみ |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=family-name:Sanchez&start=4&rows=6 |
例2
すべての検索可能なフィールドをすべて検索します ORCID 「英語」という単語の記録
構文: | ルセン |
ページング: | 最初の10行のみ |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=text:English&start=0&rows=10 |
例3
PubMedでの作業に関連する寄稿者を検索します ID 2485-7732
構文: | ルセン |
ページング: | すべての記録 |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=pmid:24857732 |
例4
家系の名前が「Einstein」でキーワードが「Relativity」のレコードを検索します。 家族名とキーワードの両方を含むレコードのみが返されます。
構文: | ルセン |
ページング: | 最初の10行のみ |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=family-name:Einstein+AND+keyword:Relativity&start=0&rows=10 |
例5
家系の名前がテイラーで、名前がマイケルのレコードを検索します。
構文: | ルセン |
ページング: | すべての結果 |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=family-name:Taylor+AND+given-names:Michael |
例6
すべての名前と家族名を検索する ORCID 「レイモンド」のレコードですが、家系の名前を後押しします。 「レイモンド」を含む名と「レイモンド」を含む家族名のレコードが返されますが、家族名のレコードはリストの一番上に表示され、関連性スコアが高くなります。
構文: | 拡張DisMax |
ページング: | 最初の10行のみ |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?defType=edismax&q=Raymond&qf=given-names^1.0%20family-name^3.0&start=0&rows=10 |
例7
すべての名前と家族名を検索する ORCID 「レイモンド」のレコードですが、家系の名前を後押しします。 「レイモンド」を含む名と「レイモンド」を含む家族名のレコードが返されますが、家族名のレコードはリストの一番上に表示され、関連性スコアが高くなります。 ORCID ID https://sandbox.orcid.org / 0000-0002-0879-455Xおよびhttps:// sandbox。orcid.org / 0000-0001-6238-4490は結果から除外されます。
構文: | 拡張DisMax |
ページング: | 最初の10行のみ |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?defType=edismax&q=Raymond+-orcid:(0000-0002-0879-455X+0000-0001-6238-4490)&qf=given-names^1.0+family-name^3.0&start=0&rows=10 |
例8
正確なDOI10.1087 / 20120404がselfに設定されているレコードを検索します
ページング: | デフォルト |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=doi-self:%2210.1087/20120404%22 |
例9
自己または一部に設定された10.1087を含むDOIを持つレコードを検索します
ページング: | デフォルト |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=digital-object-ids:10.1087 |
例10
PubMed Identifier27281629がselfに設定されているレコードを検索します
ページング: | デフォルト |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=pmid-self:27281629 |
例11
自己または一部に設定された1234を含むISBN識別子を使用してレコードを検索します
ページング: | デフォルト |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=isbn:1234 |
例12
@が付いたメールアドレスですべてのレコードを検索しますorcid.orgドメイン
ページング: | デフォルト 注:ほとんど ORCID レコードにはプライベートとしてマークされた電子メールアドレスがあり、プライベート情報は検索結果に返されません。 |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=email:*@orcid.org |
例13
1年2017月XNUMX日から今日までに変更されたレコードを検索する
ページング: | 最初の10件の結果 |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=profile-last-modified-date:%5B2017-01-01T00:00:00Z%20TO%20NOW%5D&start=1&rows=10 |
例14
正確な名前が「ボストン大学」または「BU」である組織に関連するレコードを検索します
ページング: | デフォルト |
URL: | https://pub.sandbox.orcid.org/v3.0/search/?q=affiliation-org-name:(%22Boston%20University%22+OR+BU) |
例15
リングゴールドと提携しているレコードを検索する ID 1438(カリフォルニア大学バークレー校)CSV形式
ページング: | デフォルト |
URL: | https://pub.sandbox.orcid.org/v3.0/csv-search/?q=ringgold-org-id:1438 |
例16
GRIDに関連するレコードを検索する ID 拡張検索を使用したgrid.5509.9(タンペレ大学)
ページング: | デフォルト |
URL: | https://pub.sandbox.orcid.org/v3.0/expanded-search/?q=grid-org-id:grid.5509.9 |