ORCID システムがに接続できるようにするいくつかのAPIを提供します ORCID レジストリ(読み取りと書き込みを含む) ORCID 記録。 一部のAPI関数は誰でも自由に利用できます(パブリックAPI)。 その他は ORCID メンバー組織(メンバーおよびプレミアムメンバーAPI)。
サンドボックステストサーバーで誰でも自由にAPIをテストできます そして私達は使用するすべての組織を奨励します ORCID –会員および非会員–私たちに参加する APIユーザーグループ、ここで質問をしたり、新しい技術開発について学ぶことができます。
ここで FAQ を検索します。
基本原則
アイテム(仕事、雇用、資金調達、ピアレビューなど)をに追加することができます ORCID 手動で録音するか、 ORCID メンバーAPI。記録を更新したいと考えている個人の方は、こちらをチェックしてください。 これに関するヘルプセクションはこちらです。 にアイテムを追加しようとしているメンバーの場合は、 ORCID 記録するには、次のものが必要になります。
- 研究者の許可
- メンバーAPIクレデンシャル
- そしてどちらか:
- と統合するベンダーシステム ORCID メンバーAPI
- と統合する独自のシステム ORCID メンバーAPI
API を使用してアイテムをレコードに追加するメンバー向けの完全なガイドについては、以下の API チュートリアル リンクをご覧ください。
ソーシャルコンポーネントをサポートするために、次のツールキットを提供しています。 アウトリーチリソース 統合をサポートするキャンペーンの開発を支援し、研究者とコミュニケーションをとるには、次のようにします。
- この試験は ORCID です。
- システムがiDを収集する理由と、システムがレコードの更新などのタスクを実行する方法。
- 研究者が作成することで利益を得る理由 ORCID iD そして彼らのiDをあなたのシステムに接続します。
- 認定条件 ORCID より広いグローバルな研究コミュニティに利益をもたらします。
コミュニティからのフィードバックに基づいて、このリソースの「ライブラリ」を継続的に構築していきます。 見たいものがありましたら、お気軽にお問い合わせください。
統合 ORCID システムに組み込むと、組織は認証された情報を収集できるようになります。 ORCID iD を取得して自分のデータに追加します。同時に、研究者は組織に対して、組織のデータへの読み取りと書き込みの許可を与えます。 ORCID 記録。
これを機能させるには、組織が MUST 入手する 認証された ORCID iD ORCID OAuth API。これは、以下が含まれていることを意味します。 ORCID システム内のブランドのボタンまたはリンク。クリックすると、ユーザーにサインインするように求められます。 ORCID 記録。
サインインすると、ユーザーはシステムへのアクセスを承認するよう求められ、 ORCID iD
ユーザーの ORCID iD そしてその上に名前が ORCID レコード (表示設定に応じて) は、このプロセスの一環として組織に返されます。その後、システムは追加のデータを要求できます。 ORCID APIです。
認証済み API を収集するための上記のワークフローは、両方の環境で利用できます。 ORCIDのパブリック API とメンバー API。前者は非営利サービスで無料で利用できます。
ユーザーのデータを追加または更新する許可を取得するプロセス ORCID レコードは、説明されているようにOAuthを使用します 3 Legged OAuth に関するよくある質問。 のみ ORCID メンバーは Member API を使用して更新権限を要求できます。 簡単に言えば、次のように機能します。
- ローカルシステムは特別なリンクを作成します
- クリックすると、ユーザーはに送信されます ORCID、サインインして許可を与える
- ORCID 「認証コード」を使用してユーザーをシステムに送り返します
- システムはそのコードを「アクセストークン」と交換します
- アクセストークンを使用すると、ユーザーのレコードを更新できます
ORCID は、個人が研究、学術、イノベーション活動に従事する際に使用できる一意の永続的な識別子を提供することにより、研究者、その貢献、およびその所属の間の透明で信頼できるつながりを実現するよう努めています。正しいことを確認する ORCID iD 適切な研究者と関連付けることは、研究者の信頼性を構築するための重要なステップです。 ORCID データセットとより広範な学術コミュニケーションのエコシステム。このため、 ORCID 手動による収集または入力は許可されません。 ORCID 収集可能なワークフロー内の ID ORCID 記録保持者自身から直接取得した ID。
研究者は簡単かつ安全に成果を共有できます。 ORCID iD と対話するシステム。これは、iD が自分の所有物であることを証明します。 ORCID iD.これらのシステムは、研究者の活動に関する情報を他のシステムと共有できるため、研究者の活動に関する検証済みで信頼できる一連のアサーションが作成されます。その結果、幅広い学術情報ワークフローにわたって、適切な人物が適切な活動に関連付けられることになります。
詳細については、以下を参照してください。 https://info.orcid.org/collecting-and-sharing-orcid-ids/
検証済みの情報をユーザーに接続することで、ユーザーの生活を楽にすることができます ORCID 記録。 また、学術コミュニケーションへの信頼を築くのに役立ち、そのデータを最新の状態に保つことで、ユーザーのレポートの負担を軽減し、データ品質を向上させることができます。
ORCID 研究機関向け
研究者の永続的な識別子としての使用に加えて、 ORCID は、所属機関の名前が研究システム全体でどのように使用されるかを管理するのに役立ちます。 他の永続的な識別子と組み合わせて ORCID 教育機関とのスタッフ、教職員、および学生の所属を正式に主張することができます。 使用することもできます ORCID 研究活動に関するリアルタイムの通知を受信し、フォームを自動更新し、卒業生のキャリアを追跡するためのAPI。
ORCID 資金提供団体向け
埋め込むことで ORCID 資金調達ワークフローのiDを使用すると、助成対象者と資金調達プログラムを確実に接続でき、全員の時間を節約し、情報の手動入力によって発生するエラーを減らすことができます。 使用する ORCID あなたのシステムでは、個人とあなたが彼らに与える助成金との間のつながりを主張することによって、信頼できる研究情報インフラストラクチャを構築する上であなたの役割を果たすことができます。
ORCID 出版社向け
研究者は、学術出版社や研究出版社が行うすべての中心です。 正確な著者とレビューアの情報は、索引付け、検索と発見、出版物の追跡、資金提供とリソース使用の帰属、およびピアレビューのサポートに不可欠です。
ORCID 情報ハブとして機能し、作成者とレビュー担当者が投稿に確実に接続し、投稿者からの情報を共有できるようにします ORCID パブリッシング システムとのやり取りを記録します。 書籍、ジャーナル、データセット、構成、プレゼンテーション、コード、またはその他のさまざまな作品の出版プロセス中に、すべての著者と査読者の iD を収集することで、情報を簡単に共有でき、研究者が共有に同意できるようになります。研究者の時間と労力を節約し、エラーのリスクを軽減し、重要なことに、研究者が行っている重要な仕事に値するクレジットを取得できるようにします。
会員組織の要請 ORCID 本番(ライブ)サーバーのメンバーAPIクレデンシャルは、 プロダクションメンバーAPIクライアントアプリケーションフォーム。 本番メンバーAPIクレデンシャルを発行する前に、 ORCID エンゲージメントチーム/コンソーシアムリーダーは、 ORCID サンドボックス。これにより、お客様が構築した優れた統合を確認し、ワークフローの改善を提案できるほか、すべての統合がベスト プラクティスとリリースの最小要件を満たしているかどうかを確認できます。
システムのデモを提供するには、 ORCID そのサンドボックス ORCID チームはプレビューできます。 作業中のサンドボックス統合を共有する方法はいくつかあります。
- 推奨: ライブデモ: ライブデモンストレーションをスケジュールするには、お問い合わせください統合のデモを行うために、画面を共有できる会議ソフトウェアを提供します。
- テストサイト: 開発サイトが公開されている場合は、 URLを送ってください システムにアクセスするためのテストクレデンシャル(必要な場合)およびシステムの使用方法を説明する手順 ORCID 特徴。 使用されているAPIバージョン、システムに保存されているデータなど、ユーザー側からは見えないものを確認するための追加のドキュメントを提供します。
- スクリーンキャストまたはスクリーンショット:記録またはスクリーンショットのセットを送信します ユーザーがアクセスを拒否したり、ID を切断した場合に何が起こるかなど、各ステップで統合がどのように機能するかを明確に説明し、実演する説明を添えてください。使用されている API バージョンやデータの保存方法など、ユーザー側からは確認できない事項を確認するための追加ドキュメントを必ず提供してください。
統合
会員組織の要請 ORCID 本番(ライブ)サーバーのメンバーAPIクレデンシャルは、 プロダクションメンバーAPIクライアントアプリケーションフォームリストに載っていないベンダーシステムを使用している場合は、 ORCID 認定サービスプロバイダー統合には、次のことを保証するためのレビュープロセスが必要です。 統合の最小要件とベストプラクティス 満たされています。
認定されていないサービスプロバイダーに連絡して、最低基準を満たしていることの証拠を直接入手することができます。この証拠を ORCID エンゲージメント チームまたはコンソーシアム リーダー。
この証拠を共有する方法はいくつかあります。
- スクリーンキャストまたはスクリーンショット: ユーザーがアクセスを拒否したり、iD を切断した場合に何が起こるかなど、各ステップで統合がどのように機能するかを明確に説明および実証する録画またはスクリーンショットのセットを送信してください。使用されている API バージョンやデータの保存方法など、ユーザー側からは確認できない事項を確認するための追加ドキュメントを必ず提供してください。
- 公開されている統合ドキュメント: 各ステップで統合がどのように機能するかを明確に説明した、公開されている最新のリンクを送信してください。オプション 1 と同様に、使用されている 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 です。
- システムがiDを収集する理由と、システムがレコードの更新などのタスクを実行する方法。
- 研究者が作成することで利益を得る理由 ORCID iD そして彼らのiDをあなたのシステムに接続します。
- 認定条件 ORCID より広いグローバルな研究コミュニティに利益をもたらします。
コミュニティからのフィードバックに基づいて、このリソースの「ライブラリ」を継続的に構築していきます。 見たいものがありましたら、お気軽にお問い合わせください。
また、ご購読はいつでも停止することが可能です サンドボックスメンバーAPIクレデンシャルをリクエストする アプリケーションを構築してテストします。これらの資格情報により、サンドボックスプレミアムメンバーAPIを呼び出して読み取り、書き込み、更新を行うことができます。 ORCID 記録。 サンドボックステスト環境へのアクセスは、あなたがそうでなくても、誰でも自由に利用できます。 ORCID メンバー組織。
注意: を使用している場合 ORCID すでにサポートしている認定サービスプロバイダーシステム ORCIDサンドボックスAPIの認証情報を登録する必要はありません。 ORCID サンドボックス環境内での統合機能。
サンドボックスを使用すると、ライブ(本番)のデータに影響を与えることを心配することなく、テストユーザーアカウントを作成して統合を開発できます。 ORCID レジストリ。 サンドボックスは本番環境と同じように動作します ORCID とのレジストリ いくつかの例外.
テストアカウントの作成
テストするために ORCID への情報の読み取りや追加などの API および API 呼び出し ORCID 記録するには、テストも作成する必要があります ORCID サンドボックスに記録します。 これは、本番環境と同様に、ユーザーインターフェイスを介して実行できます。 ORCID レジストリ。 に移動 https://sandbox.orcid.org/register アカウントに登録します。
Mailinatorのメールアドレス
サンドボックスサーバーは、 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 桁の PUT コードをシステム内のアイテムと一緒に保存します。これにより、読み取り、更新、または削除する必要があるアイテムを識別できます。
- 対話が期待どおりに進まない場合は、エラーメッセージとサポート連絡先を提供します。
開発者は、パブリックAPIをテストすることをお勧めします。 サンドボックス テスト サーバー 製品版を使用する前に。 以下は、サンドボックス環境と本番環境の両方でパブリック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、そしてそれは彼らに表示されます 信頼できる組織リスト。 組織またはサービスの名前(ジャーナル名など)を使用することをお勧めします。
- アプリケーションURL: ユーザーがアプリケーションの詳細を知るためにアクセスできる Web サイト。 これは彼らの記事にも表示されます 信頼できる組織リスト.
- アプリケーションの説明:開発中のアプリケーションとユーザーの使用方法に関する情報 ORCID iD。 これは、OAuth画面でユーザーに表示されます。

追加 URIをリダイレクトする
ユーザーがアプリケーションを承認すると、指定したURIに返されます。 これらのURIを事前に提供する必要があります。そうしないと、統合ユーザーでエラーが発生します。
- 表示されたボックスにリダイレクト URI を入力します
- 複数のリダイレクト URI を入力する必要がある場合は、「別のリダイレクト URI を追加」をクリックします。
※
- のみ HTTPS URI 本番環境で受け入れられます
- 登録されたドメイン MUST サブドメインを含め、使用されているドメインと完全に一致する
- 可能な場合は、すべてのリダイレクト URI を完全に登録します。 これは最も安全なオプションであり、推奨されます。 リダイレクト URI の詳細については、「 リダイレクト URI に関するよくある質問
アプリケーションを保存する
アプリケーション フォームに記入し、リダイレクト URI を追加したら、アプリケーションを保存できます。
- 「アプリケーションを保存し、クライアントIDとシークレットを生成する」をクリックします。
開発者ツールのページに戻ります。このページには、パブリック API クライアントの認証情報が含まれています。

資格情報を更新する
アプリケーション情報の変更は非常に簡単です。
- 関連情報を編集し、「アプリケーションを保存」をクリックします。
クレデンシャルを使用する
クレデンシャルを取得したので、次は ORCID パブリックAPI!
あなたが ORCID メンバー 将来インチ
すべてのメンバー統合が満たすことが期待される多くの要件があります。 ザ・ ORCID チームは、統合レビュープロセスの一環として、これらの要件が満たされていることを確認します。
- OAuth 認証する ORCID iD(ユーザーが検索または入力することを許可しない ORCID iD。)
- に従ってOAuth認証画面を表示します ガイドライン
- 含む ORCID ブランドのボタンまたはリンク iDの認証を開始するためにあなたのサイトで。
- サイトのリダイレクトURIなどにHTTPSを使用する ORCID API呼び出し
- トークン交換で返されたすべてのデータを、ユーザーのデータと一緒に受け入れてシステムに保存します
- 適切に使用する スコープ と リクエストメソッド (たとえば、新しい情報を追加するためのPOST呼び出し、および既存の情報を更新するためのPUT呼び出し)
- 認証済みを公開表示 ORCID iD。 iDは次のように表示する必要があります 商標および iD ガイドラインを表示します。
- しないでください ユーザーに、アイテムの表示設定を変更するよう要求します。 ORCID 統合を使用するために記録します。
あなたは記入する必要があります クライアントアプリケーションを登録するためのフォーム。 以下は、要求されたフィールドの概要です。
組織名: きみの ORCID 会員組織名
資格情報の主な連絡先メールアドレス: このメールアドレスは、暗号化されたメールで認証情報をお送りしたり、統合に関して質問やエラーが発生した場合にご連絡するために使用します。
パスワード用の予備メールアドレス: 暗号化されたメールパスワードを送信できるメール アドレス。
顧客の名前: これはあなたになります ORCID メンバー組織名。統合が 1 つ以上ある場合は、名前にアプリケーションが追加されます。
アプリケーションのホームページの URL: ユーザー内の信頼できる組織のリストにリンクとして表示されます ORCID 信頼できるパーティのページ。 これは、組織またはアプリケーションのメインページに戻るリンクである必要があります。
クライアントアプリケーションの簡単な説明: このテキストは、認証画面で疑問符アイコンとともに統合ユーザーに表示されます。統合の簡単な説明が必要です。
URIのリダイレクト: ユーザーがアプリケーションを承認すると、指定したURIに返されます。 これらのURIを事前に提供する必要があります。そうしないと、統合ユーザーでエラーが発生します。
- HTTPSURIのみが受け入れられます。
- 登録されたドメインは、サブドメインを含め、使用されているドメインと完全に一致する必要があります。
- 可能な場合は、すべてのリダイレクト URI を完全に登録します。
- 5つ以上のリダイレクトURIが必要ですか? の注記にこれを示してください ORCID スタッフ。
の注意事項 ORCID スタッフ:このフィールドを使用して ORCID スタッフはあなたのリクエストや統合について何か追加の情報を知ることができます
検索とリンクウィザード アイテム(主に機能)をにインポートするために使用できる統合です ORCID レジストリ。 インテグレータとの間でテストを受ける必要があります ORCID それらが実動レジストリー環境にリリースされる前に。
以下の質問への回答によっては、統合が検索とリンクの候補として適切である可能性があります。検索とリンクのウィザードの開発を開始する前に、これについてさらに話し合うためにお問い合わせください。
- ウィザードの対象読者は何ですか? たとえば、国、懲戒、またはグローバルレベルでの著者、レビューア、または助成金申請者
- 予想されるオーディエンスはおおよそどのくらいですか?
- それは、既存のウィザードによって現在十分にサービスされていない人口にサービスを提供しますか? たとえば、特定の言語や分野での研究貢献、または新しいタイプの研究貢献
- ウィザードが優れたユーザーエクスペリエンスを提供することをどのように保証しますか?
- どのようなユーザーサポートを提供しますか?
- ありますか、またはありますか ORCID プロダクトマネージャーなど、組織の担当者をウィザードに指名しますか?
- どのようにそれを保証しますか ORCID iDは認証されていますか?
- あなたは-またはあなたは-摂取して表示しますか ORCID プラットフォーム上のiD?
- プラットフォーム検索はiDによって有効になっていますか?
私たちを参照してください 検索とリンクのワークフロー のガイドをご参照ください。
会員組織の要請 ORCID 本番(ライブ)サーバーのメンバーAPIクレデンシャルは、 プロダクションメンバーAPIクライアントアプリケーションフォーム。 本番メンバーAPIクレデンシャルを発行する前に、 ORCID エンゲージメントチーム/コンソーシアムリーダーは、 ORCID サンドボックス。これにより、お客様が構築した優れた統合を確認し、ワークフローの改善を提案できるほか、すべての統合がベスト プラクティスとリリースの最小要件を満たしているかどうかを確認できます。
システムのデモを提供するには、 ORCID そのサンドボックス ORCID チームはプレビューできます。 作業中のサンドボックス統合を共有する方法はいくつかあります。
- 推奨: ライブデモ: ライブデモンストレーションをスケジュールするには、お問い合わせください統合のデモを行うために、画面を共有できる会議ソフトウェアを提供します。
- テストサイト: 開発サイトが公開されている場合は、 URLを送ってください システムにアクセスするためのテストクレデンシャル(必要な場合)およびシステムの使用方法を説明する手順 ORCID 特徴。 使用されているAPIバージョン、システムに保存されているデータなど、ユーザー側からは見えないものを確認するための追加のドキュメントを提供します。
- スクリーンキャストまたはスクリーンショット:記録またはスクリーンショットのセットを送信します ユーザーがアクセスを拒否したり、ID を切断した場合に何が起こるかなど、各ステップで統合がどのように機能するかを明確に説明し、実演する説明を添えてください。使用されている API バージョンやデータの保存方法など、ユーザー側からは確認できない事項を確認するための追加ドキュメントを必ず提供してください。
Webhookを使用すると、プレミアムメンバーは「視聴」できます ORCID 記録し、変更があれば通知されます。
APIとプレミアムメンバークライアントのクレデンシャルを使用して、プレミアムメンバーは認証された各のコールバックURLを登録できます ORCID iD 彼らが追跡したいこと。 NS ORCID レコード所有者は、URLを登録するための特定の許可を組織に付与する必要はありませんが、実際のデータ交換は、によって設定されたプライバシーレベルに基づいています。 ORCID iD 保有者。
これで ORCID に変更があった場合、リクエストを送信して、指定されたURLに通知します ORCID 記録。
ORCID さまざまな種類の研究成果をサポートしています。以下は現在サポートされている研究タイプのリストです。可能な限り、 COAR(オープンアクセスリポジトリ連合) 制御された語彙に加えて、API で引き続きサポートされている従来の作業タイプも多数あります。
一部の作業タイプは、最新の API バージョンでのみサポートされていることにご注意ください。
学術出版物
(書籍、雑誌記事、会議成果物、プレプリント、ワーキングペーパー)
ユーザーインターフェースに表示される内容 | インテグレーター向けAPI作業タイプ | COAR リソース タイプ | 説明 |
本 | 本 | 本 | 1 巻または指定された有限巻数で完結する非逐次刊行物。 |
本の章 | 本の章 | 書籍内の定義された章またはセクション。通常は別個のタイトルまたは番号が付けられます。 | |
会議資料 | 会議資料 | 会議資料 | 会議の議事録内で公開される論文。通常は、独自の研究結果を報告する研究論文の実現です。 |
会議出力 | 会議出力 | 会議出力 | 会議に提供された、他のより具体的な作業タイプではカバーされていないあらゆる種類のデジタル リソース。たとえば、会議レポート、会議の講義、要約、デモンストレーション、ワークショップなど。 API 3.0以降でのみ利用可能 |
会議プレゼンテーション | 会議プレゼンテーション | カンファレンスプレゼンテーション | 会議、シンポジウム、セミナー、講義、ワークショップ、その他の集まりで聴衆が投影して視聴できるように、アイデアや研究結果を伝えるために設計された、テキスト、表、または図を含むスライドのセット。 API 3.0以降でのみ利用可能 |
会議ポスター | 会議ポスター | 会議ポスター | 会議議事録内で公開される展示ポスター。通常、説明図や表を含むテキストを含み、通常は研究結果を報告したり仮説を提案したりして、会議、セミナー、シンポジウム、ワークショップなどのイベントに提出され、発表されます。 |
会議議事録 | 会議議事録 | 会議議事録 | 会議議事録は、会議の公式記録です。会議で行われたプレゼンテーションに対応する文書のコレクションです。追加のコンテンツが含まれる場合もあります。 API 3.0以降でのみ利用可能 |
雑誌の記事 | 雑誌の記事 | 雑誌の記事 | 通常は、独自の研究成果を報告する研究論文をジャーナルに掲載したもの。 |
プレプリント | プレプリント | プレプリント | プレプリントは、査読を受けていない科学論文であり、ジャーナルにまだ受け入れられておらず、通常は著者によって公開サーバー/リポジトリに提出されます。 |
論文または学位論文 | 論文-論文 | 論文 | 学生が執筆した書籍で、学位取得の要件を満たすために高等教育機関での研究課程の修了試験用に提出された研究成果の正式なプレゼンテーションが含まれています。論文とも呼ばれます。 API 3.0以降でのみ利用可能 |
ワーキングペーパー | ワーキングペーパー | ワーキングペーパー | 公にまたは同僚グループ間で回覧されるワーキングペーパーまたはディスカッションペーパー。経済学などの特定の分野では、ワーキングペーパーがシリーズで発行されます。 |
その他の学術出版物 | 他の | 上記に含まれないその他の学術出版物。 |
レビューと編集
(注釈、転写、レビュー、編集)
ユーザーインターフェースに表示される内容 | インテグレーター向けAPI作業タイプ | COAR リソース タイプ | 説明 |
アノテーション | 注釈 | 法的な注釈という意味での注釈は、裁判所または仲裁裁判所によって下された判決に対する法的に説明的なコメントです。 API 3.0以降でのみ利用可能 | |
書評 | 書評 | 書評 | 書籍またはその他のモノグラフ作品の内容、範囲、品質に関する書面によるレビューと批評的分析。 |
ジャーナルの発行号または版 | ジャーナル号 | ジャーナル | ジャーナルとは、ある主題に関する独自の研究や最新の動向を広めることを目的とした定期刊行物です。 |
レビュー | レビュー | レビュー | 他の人が出版した作品のレビュー。 API 3.0以降でのみ利用可能 |
転写 | 転記 | 転写 | 法廷手続きやスピーチ、インタビュー、放送、録音などで話された言葉の書面による記録。 API 3.0以降でのみ利用可能 |
インタビュー | 翻訳 | 新規または改訂された序文など、元の版への変更を識別する本および記事の翻訳。 | |
その他のレビューまたは編集出力 | 他の | 上記に含まれないその他のレビューまたは編集出力。 |
普及
(ブログ投稿、メディア記事、スピーチ、ポッドキャスト)
ユーザーインターフェースに表示される内容 | インテグレーター向けAPI作業タイプ | COAR リソース タイプ | 説明 |
ブログ投稿 | ブログ投稿 | ブログ投稿 | ブログで公開された文章またはその他のコンテンツ。 API 3.0以降でのみ利用可能 |
辞書のエントリ | 辞書エントリ | 新しい単語の入力、既存の単語の新しい意味、長期間にわたるスペルとハイフネーションの変更、および文法の変更。 | |
百科事典のエントリ | 百科事典のエントリ | 特定のドメインまたは知識のすべての分野に焦点を当てた参考書または大要の作成されたエントリ。 | |
雑誌の記事 | 雑誌の記事 | 雑誌の記事 | 大衆向けの定期刊行物には、通常、さまざまなトピックに関する記事が掲載され、さまざまな著者によって非学術的なスタイルで執筆されています。また、一般消費者向けの出版物とは異なり、業界出版物は、特定の分野や業界で働く人々向けに特定のトピックを扱っています。 |
新聞記事 | 新聞記事 | 新聞記事 | 一般向け新聞またはその他の一般ニュース定期刊行物に掲載されるニュース項目で構成される作品で、特定の分野における現在およびタイムリーな関心事に関する情報が含まれています。 |
レポート | レポート | レポート | 報告書とは、研究結果、進行中の研究、政策の展開や出来事、その他の技術的発見について個別に公開された記録であり、通常は報告書番号が付けられ、資金提供機関によって割り当てられた助成金番号が付けられることもあります。また、委員会や法人の活動、政府機関の議事録、または機関による調査の公式記録で、公開されているか非公開であるかにかかわらず、通常はアーカイブ化されるか、自発的または命令により上位機関に提出されます。より一般的な意味では、特定のイベントまたは現象に関連する事実または情報の正式な説明であり、定期的に提供されることもあります。 |
トーク、インタビュー、ポッドキャスト、スピーチ | 演説 | 一般の方への口頭による情報プレゼンテーション。講演、インタビュー、ポッドキャストなどが含まれます。 | |
ウェブサイト | ウェブサイト | ウェブサイト | 共通の Uniform Resource Locator (URL) を基準としてアドレス指定された、テキスト、画像、ビデオ、その他のデジタル資産を含む関連 Web ページのコレクション。Web サイトは、少なくとも 1 つの Web サーバーでホストされ、インターネットやプライベート ローカル エリア ネットワークなどのネットワーク経由でアクセスできます。 |
その他の普及成果 | 他の | 上記に含まれないその他の配信出力。 |
クリエイティブ
(デザイン、画像、ビデオ、音楽、サウンド、インタラクティブメディア)
ユーザーインターフェースに表示される内容 | インテグレーター向けAPI作業タイプ | 説明 | |
芸術的な成果またはパフォーマンス | 芸術的パフォーマンス | 個人の研究または学術活動に起因する、または関連する芸術的またはパフォーマンスの成果の完全かつ最新の履歴を組み合わせて表す情報記録のコレクション。 | |
設計 | デザイン | 設計 | 建物や製品など、何かがどのように作られるか、どのように機能し、どのように見えるかを示す計画、図面、または図面のセット。 API 3.0以降でのみ利用可能 |
画像 | 画像 | 画像 | テキスト以外の視覚的表現、静止画像。テキスト以外の視覚的表現、あらゆる種類の動画および静止画像を含みます。 API 3.0以降でのみ利用可能 |
インタラクティブリソース | オンラインリソース | インタラクティブリソース | 理解、実行、または体験するためにユーザーとの対話を必要とするリソース。例としては、Web ページ上のフォーム、アプレット、マルチメディア学習オブジェクト、チャット サービス、仮想現実環境などがあります。 |
動画またはビデオ | 動画 | 動画 | コンピュータ プログラムによって動的に生成されるか、または連続して表示されると動きの印象を与える一連の録画済み静止画像から形成される、動く表示。 API 3.0以降でのみ利用可能 |
楽曲 | 音楽作曲 | 楽曲 | 楽曲とは、オリジナルの楽曲、楽曲の構造、または新しい楽曲を作成するプロセスを指します。 API 3.0以降でのみ利用可能 |
音 | 音 | 音 | 主に聞くことを目的としたリソース。例としては、音楽再生ファイル形式、オーディオ コンパクト ディスク、録音された音声やサウンドなどがあります。 API 3.0以降でのみ利用可能 |
その他の創作作品 | 他の | 上記に含まれないその他のクリエイティブな成果物。 |
データとプロセス
(データセット、ソフトウェア、計画、研究ツール)
ユーザーインターフェースに表示される内容 | インテグレーター向けAPI作業タイプ | COAR リソース タイプ | 説明 |
地図資料 | 地図資料 | 地図資料 | 地球全体または一部、あるいは天体をあらゆるスケールで表現した資料。地図作成資料には、2 次元および 3 次元の地図や計画 (架空の場所の地図を含む)、航空図、航海図、天体図、地図帳、地球儀、ブロック図、断面図、地図作成目的の航空写真、鳥瞰図 (地図ビュー) などが含まれます。 API 3.0以降でのみ利用可能 |
臨床試験 | 臨床研究 | 臨床試験 | 生物医学的または健康関連の結果に対する介入または曝露を評価するための調査研究の結果を報告する作品。臨床研究には、介入研究 (臨床試験) と観察研究という 2 つの主な種類があります。臨床研究のほとんどは人間に関するものですが、この出版タイプは、人間に関する要件を満たす臨床獣医学の記事に使用される場合があります。 API 3.0以降でのみ利用可能 |
データセット | データセット | データセット | 定義された構造でエンコードされた関連する事実とデータのコレクション。 |
データ管理計画 | データ管理計画 | データ管理計画 | 研究プロジェクト全体を通じて研究データがどのように管理され、文書化されるか、また、長期管理および保存のためにその後データをデータ リポジトリに預ける条件を説明する正式な声明。 API 3.0以降でのみ利用可能 |
物理的なオブジェクト | 物理オブジェクト | 物理サンプル | 物理的サンプルには、生物標本、岩石または鉱物標本、土壌または堆積物のコア、植物および種子、水質サンプル、考古学的遺物、または DNA および人間の組織サンプルが含まれます。サンプルは分析に使用されることがあり、このプロセスで破棄される可能性がありますが、標本は継続的に研究できる保存された厳選されたオブジェクトです。 API 3.0以降でのみ利用可能 |
研究プロトコルまたは手法 | 研究技術 | 研究プロトコル | 研究の一環として特定された特定のタスクに適用される実用的な方法またはスキル。 |
調査ツール | リサーチツール | 調査から特定された一連の観察、測定、または事実。 | |
ソフトウェア | ソフトウェア | ソフトウェア | ソース コード (テキスト) またはコンパイルされた形式のコンピュータ プログラム。 |
その他のデータまたはプロセス出力 | 他の | 上記に含まれないその他のデータまたはプロセス出力。 |
法務および知的財産
(特許、商標、著作権、その他の法的事項)
UI ラベル | インテグレーター向けAPI作業タイプ | COAR リソース タイプ | 説明 |
発明 | 発明 | 研究から生まれる実用的で独創的な成果。 | |
ライセンス | ライセンス | プロセス、製品、データ、ソフトウェアなどのIPの一部を悪用する契約に署名しました。 | |
特許 | 特許 | 特許 | 特許または特許出願。 |
登録された著作権 | 登録済み-著作権 | 芸術、文学、音楽、演劇、その他の創造的な作品の作成とアクセスの両方を促進するための法体系に基づく権利の登録所有権。 | |
標準またはポリシー | 標準とポリシー | 判断の基礎として使用される規則または原則の開発。 | |
商標 | 商標 | 商標 | ある企業の商品やサービスを他の企業の商品やサービスと区別するために使用される標識。商標は、単語や単語の組み合わせ(名前やスローガンなど)、ロゴ、図や画像、文字、数字、音、まれに匂いや動画、またはそれらの組み合わせで構成される場合があります。 |
その他の法的またはIP出力 | 他の | 上記に含まれないその他の法的または IP 出力。 |
指導と監督
(学生との取り組み)
ユーザーインターフェースに表示される内容 | インテグレーター向けAPI作業タイプ | COAR リソース タイプ | 説明 |
読書 | 講義-スピーチ | 読書 | 大学や短大の教師などが、特定の主題に関する情報を提示したり、人々に教えたりすることを目的とした口頭プレゼンテーション/講演の書き起こし。 |
教材 | 学習オブジェクト | 学習オブジェクト | 教育と学習を強化するために再利用できるデジタル リソース。 API 3.0以降でのみ利用可能 |
指導を受けた学生の出版 | 監督-学生-出版 | 論文指導教官と共同で発表された、または指導教官によって監督された研究結果に関する記事。 | |
その他の教育または監督の成果 | 他の | 上記に含まれないその他の教育および監督の成果。 |
レガシーワークタイプ
以下は、API で引き続きサポートされているものの、ユーザーが手動で作品を追加するときに選択できなくなった作品タイプのリストです。可能な場合は、代わりに使用することを推奨する作品タイプをリストしています。
仕事の種類 | 該当する場合は、推奨される作業タイプ | |
会議-要約 | 会議出力 | |
開示 | ||
編集された本 | 本 | |
マニュアル | 学習オブジェクト | |
ニュースレター-記事 | 雑誌記事または新聞記事 | |
スピンオフ会社 | ||
技術基準 | レポート | |
test | 学習オブジェクト |
すべてのアフィリエーションセクションは、APIで同じメタデータのセットを使用します。
- 組織名:* 最高レベルの組織の名前 (例: 「ボストン大学医学部」ではなく「ボストン大学」)。
- 組織都市:* 組織の拠点となる都市。
- 組織地域: 組織の拠点となる地域。
- 組織国* 組織の国。 これには、 3166文字のISO2Alpha-XNUMX国コード.
- 組織 ID (ROR、GRID、Ringgold** または LEI):* 組織とそのソースの一意の識別子。部門や部署ではなく、所属内で親組織 ID を使用することをお勧めします。
- 役割/役職: 保持されている役職、または授与された、または授与される予定の学位。
- 部門: 親組織の細分化。
- URL: 所属に関するリソースへのURL
- 開始日: 研究者と組織の関係が始まった日付(年、月、日まで指定できます)。
- 終了日: 研究者と組織の関係が終了した日付(年、月、日まで指定可能)
- 所属を説明する外部永続識別子: 実際の所属アサーションの一意の識別子
*必須フィールドを示します。
**Ringgold 識別子は依然として存在しますが、 ORCID 1 年 2023 月 XNUMX 日時点のレジストリ、 ORCID レジストリで使用される RINGGOLD 組織識別子データベースの更新を受信できなくなり、その日以降に作成された RINGGOLD ID を処理または使用することもできなくなります。 私たちのを参照してください よくある質問 詳細はこちら
の伝記の部分の下にいくつかのセクションがあります ORCID 記録:
としても知られている: これには、短縮名、255 つまたは複数の名のイニシャルを含むバリエーション、ミドル ネーム、旧名または別名、または異なる文字セットの名前を含めることができます。 各名前は XNUMX つの項目として追加する必要があります。 これは XNUMX 文字までの自由なテキスト フィールドです。
ウェブサイト: このセクションには、説明(オプション)とWebサイトのURL(必須)が含まれています
国: の国セクション ORCID レコードを使用すると、研究者とメンバー組織は、研究を行う国、または研究のトピックである国を3166つ以上追加できます。 国リストの項目は、国および地域コードの国際規格であるISOXNUMXから供給されています。
外部識別子(その他のID): このセクションは、メンバー組織のみが追加できます。 多くの組織が研究者のために他の外部識別子、たとえばScopus Author IDを収集していますが、それらの識別子の発行者のみがそれらを正式に主張できることに注意してください。 したがって、組織では、システムが作成し、研究者を識別するために使用する識別子のみを追加することを強くお勧めします。 このセクションには、XNUMXつのコンポーネントが含まれています(*は必須フィールドを示します)。
- IDタイプ*
- ID値*
- ID関係*
- IDURL
- 題名:* 作品のタイトル
- 字幕: 作品の字幕
- 翻訳されたタイトル: 作品が別の言語で表示されるタイトル、翻訳されたタイトルの言語が属性として記録されます
- ジャーナルタイトル: ジャーナル記事のジャーナルや本の章の本など、作品が属するより大きなコレクションの名前。 これはジャーナルタイトルとラベル付けされていますが、他の作品に使用できます
- 簡単な説明:作品の簡単な説明または要約
- 引用タイプ: 引用が提供される形式。このフィールドは、APA、BIBTEX、CHICAGO、HARVARD、IEEE、MLA、RIS、UNSPECIFIED、VANCOUVERの値を含むリストから選択されます。
- 引用値: 引用内容
- 仕事の種類: 作品のオブジェクトの種類。 このフィールドは、から選択する必要があります サポートされている作業タイプ
- 出版日: 作品が公開された日付。 最も早い発行日を使用することをお勧めします
- 外部IDタイプ:* 識別子のタイプ。 このフィールドは、から選択する必要があります サポートされている作業識別子
- 外部ID値:* 識別子自体
- External-id-url: 識別子が解決されるURL
- 外部ID関係:* 追加される作業にのみ適用される識別子は、自己としてマークされます。 この作品が属するより大きなコレクションに適用される識別子は、Part-ofに設定されます。 作品の代替バージョンに適用される識別子は、version-ofに設定されます。 作業の資金提供に適用される識別子は、によって資金提供されるように設定されます。
- Work-url: 作品にリンクするURL
- 仕事の貢献者: 作品を作成した個人に関する情報
- 言語コード:前のフィールドでの作業を説明するために使用される言語
- 国: 作品が出版された、またはその他の方法で関連付けられた国
* 必須フィールドを示します
使い捨て試薬から専用施設を備えた国際的な共同研究まで、多くの種類の研究リソースがあります。 ORCID ドメイン固有の詳細について他の場所にリンクできる高レベルモデルをサポートします。
XNUMXつの高レベルのリソースタイプがあります。
リソースタイプ | 定義 | 例 |
インフラ | 研究を行うために使用される施設、建物、またはその他の物理的空間 | 中性子破砕源、動物施設、データ飛び地、遺跡、望遠鏡アレイ。 船、飛行機、農場、研究所 |
収集 | 研究目的で使用されるオブジェクトまたはオブジェクトのグループ。 有形またはデジタルにすることができます | 海洋ミッション、フィールドキャンペーン、共同データセットまたはリソース、珍しい本のコレクション。 博物館コレクション、生物標本コレクション |
機器 | 研究目的で使用されるハードウェア | 顕微鏡、コンピューター、ガラス製品、サンプル、材料 |
サービス | 研究目的で使用されるサービス | プロテオミクス分析、コンピューティングサービス、データ分析、ロジスティックサポート、法律サービス、コピーエディティング、専門家またはスタッフのアドバイス |
リソースタイプに加えて、内の研究リソースアイテム ORCID レコードには次の情報が含まれています。 *必要なアイテムを示します
- 提案/登録タイトル:* これは、「中性子ビーム賞」や「ビーム時間と計算リソース」などの研究リソースの主な表示フィールドです。
- 提案/登録ID:* これは、リソースを使用するための提案または要求の公開識別子(DOI、PURLなど)です。 理想的には、この識別子は永続的であり、アワードデータベースやリソースユーザーログなど、提案またはリクエストに関する情報を含む公開ランディングページに解決される必要があります。
- 提案ホスト:* これは、リソースの提案または要求を受信して処理する組織です。 プロポーザルホストはリソースホストと同じである可能性があります
- 提案ホスト組織iD * これは、提案またはリクエストのプロセスを管理する組織の公開識別子 (ROR、GRID、Open Funder ID、LEI のいずれか) です。
- リソース:* (最大100)
- リソース名:* –例:「中性子核破砕源」
- リソースID:* –受け入れ可能なPIDタイプ(RRID、DOI、URIなど)の拡張可能なリストから
- リソースタイプ:* –「インフラストラクチャ」、「コレクション」、「機器」、または「サービス」のいずれか
- リソースホスト:* これは、国立研究所、政府機関、研究大学など、リソースを管理または運用する組織です。
- リソースホスト組織ID:* これは、リソースをホストする組織の公開識別子 (ROR、GRID、Ringgold**、Open Funder ID、LEI のいずれか) です。
- 提案URL: 提案へのリンク
- 提案開始日: アクセスが開始された日付
- 提案終了日: アクセスが終了した、または終了する日付
* 必須フィールドを示します
**Ringgold 識別子は依然として存在しますが、 ORCID 1 年 2023 月 XNUMX 日時点のレジストリ、 ORCID レジストリで使用される RINGGOLD 組織識別子データベースの更新を受信できなくなり、その日以降に作成された RINGGOLD ID を処理または使用することもできなくなります。 私たちのを参照してください よくある質問 詳細はこちら
- 役割:* レビュープロセスにおける個人の役割。議長、編集者、メンバー、主催者、レビュー担当者から選択できます。
- グループ識別子:* 集約目的で使用されるグループID。ジャーナル記事の場合、デフォルトの識別子はeISSNで、ISSNデータベースとの統合により自動的に入力されます。ISSN以外の識別子を割り当てる必要がある場合は、 前に作成します。
- 招集組織*: レビューを組織した組織–ジャーナル発行者、会議主催者、資金提供機関、教員など
- 組織ID: 招集組織の永続的な識別子。 現在、ROR、Ringgold**、GRID、LEI、または Crossref Funder Registry 識別子をサポートしています。 注: これは必須フィールドではありませんが、利用可能な場合はこのデータを投稿することをお勧めします。
- レビューデータ:* このデータはレビュー活動を参照しており、レビューされたものではありません
- 種類: レビュー活動の種類:レビューまたは評価
- 日付:レビューが完了した日付。 これは、広範(2008)または具体的(2010-12-10)の場合があります。
- レビュー識別子:ユニークな、できれば解決可能な 識別子 レビュー自体のソースによって提供されます。 レビューが公開されていない限り、レビューの対象にまでさかのぼることができる識別可能なデータが含まれていないことをお勧めします。
- レビューURL: オンラインでのレビューまたはレビュー記録の表現へのリンク
- レビュー対象に関する情報: レビューアがレビューしたものは何でも
- 件名タイプ: レビューされたアイテムのタイプ(ジャーナル記事、会議論文など)
- これには、 仕事の種類のリストと助成金の種類のリスト (「助成金」、「契約」、「賞」、「給与-賞」)AND研究-「リソース提案」および「未定義」
- 件名: レビューされたアイテムの名前
- サブジェクト外部識別子: レビューの主題の一意の識別子(例:記事DOI)
- サブジェクトコンテナ名: レビュー対象が含まれるオブジェクトの名前。たとえば、論文がレビューされた会議
- 件名URL: レビューされた件名のURL
- 件名タイプ: レビューされたアイテムのタイプ(ジャーナル記事、会議論文など)
* 必須フィールドを示します
**Ringgold 識別子は依然として存在しますが、 ORCID 1 年 2023 月 XNUMX 日時点のレジストリ、 ORCID レジストリで使用される RINGGOLD 組織識別子データベースの更新を受信できなくなり、その日以降に作成された RINGGOLD ID を処理または使用することもできなくなります。 私たちのを参照してください よくある質問 詳細はこちら
- 資金調達の種類:* 授与される資金の種類。このフィールドは、次の値を含むリストから選択されます:賞、契約、助成金、給与-賞
- 資金提供のタイトル:* 資金提供項目のタイトル
- サブタイトル:資金調達項目のサブタイトル
- 翻訳されたタイトル: 資金提供のタイトルは別の言語で表示され、翻訳されたタイトルの言語は属性として記録されます
- 説明:資金提供されたプロジェクトの説明または短い要約。
- 金額: 賞の価値
- 一意の資金調達識別子: * システムが認識している限り、これらをいくつでも追加してください。グループ化に役立ちます。 ORCID レコード。
- 資金調達識別子タイプ:grant-number、DOI、URI、またはproposal-idを使用する
- 識別子の値
- 識別子のURL(オプション)
- 関係:自己/一部
これは、資金調達アイテムと識別子の関係を示すためのものです。 たとえば、資金調達項目がマルチパート助成金のXNUMXつのフェーズ用であり、識別子がマルチパート助成金用である場合、関係は「一部」になります。 識別子が個々のフェーズ用である場合、関係は「自己」になります。
- 資金提供機関(組織):* 助成金を授与した組織に関する情報
- 代理店の名前
- 住所(市と国)
- 組織ID: サポートされている識別子は、ROR、Fundref、Ringgold** 識別子です。
- 開始日: 資金提供が始まった日付
- 終了日: 資金提供が終了した日付
- 寄稿者情報: 資金提供を受けた個人に関する情報
- ORCID iD: この ORCID iD 資金提供プロジェクトへの各協力者のこれには認証済みのみを含める必要があります ORCID iD
- 役割: 研究者による貢献の性質
* 必須フィールドを示します
**Ringgold 識別子は依然として存在しますが、 ORCID 1 年 2023 月 XNUMX 日時点のレジストリ、 ORCID レジストリで使用される RINGGOLD 組織識別子データベースの更新を受信できなくなり、その日以降に作成された RINGGOLD ID を処理または使用することもできなくなります。 私たちのを参照してください よくある質問 詳細はこちら
すべてのアフィリエーションセクションは、APIで同じメタデータのセットを使用します。
- 組織名:* 最高レベルの組織の名前(例:「ボストン大学医学部」ではなく「ボストン大学」)。
- 組織都市:* 組織の拠点となる都市。
- 組織地域: 組織の拠点となる地域。
- 組織国* 組織の国。 これには、 3166文字のISO2Alpha-XNUMX国コード.
- 組織 ID (ROR、GRID、Ringgold** または LEI):* 組織とそのソースの一意の識別子。部門や部署ではなく、所属内で親組織 ID を使用することをお勧めします。
- 役割/役職: 保持されている役職、または授与された、または授与される予定の学位。
- 部門: 親組織の細分化。
- URL: 所属に関するリソースへのURL
- 開始日: 研究者と組織の関係が始まった日付(年、月、日まで指定できます)。
- 終了日: 研究者と組織の関係が終了した日付(年、月、日まで指定可能)
- 所属を説明する外部永続識別子: 実際の所属アサーションの一意の識別子
*必須フィールドを示します。
**Ringgold 識別子は依然として存在しますが、 ORCID 1 年 2023 月 XNUMX 日時点のレジストリ、 ORCID レジストリで使用される RINGGOLD 組織識別子データベースの更新を受信できなくなり、その日以降に作成された RINGGOLD ID を処理または使用することもできなくなります。 私たちのを参照してください よくある質問 詳細はこちら
すべてのアフィリエーションセクションは、APIで同じメタデータのセットを使用します。
- 組織名:* 最高レベルの組織の名前(例:「ボストン大学医学部」ではなく「ボストン大学」)。
- 組織都市:* 組織の拠点となる都市。
- 組織地域: 組織の拠点となる地域。
- 組織国* 組織の国。 これには、 3166文字のISO2Alpha-XNUMX国コード.
- 組織 ID (ROR、GRID、RInggold** または LEI):* 組織とそのソースの一意の識別子。部門や部署ではなく、所属内で親組織 ID を使用することをお勧めします。
- 役割/役職: 保持されている役職、または授与された、または授与される予定の学位。
- 部門: 親組織の細分化。
- URL: 所属に関するリソースへのURL
- 開始日: 研究者と組織の関係が始まった日付(年、月、日まで指定できます)。
- 終了日: 研究者と組織の関係が終了した日付(年、月、日まで指定可能)
- 所属を説明する外部永続識別子: 実際の所属アサーションの一意の識別子
*必須フィールドを示します。
**Ringgold 識別子は依然として存在しますが、 ORCID 1 年 2023 月 XNUMX 日時点のレジストリ、 ORCID レジストリで使用される RINGGOLD 組織識別子データベースの更新を受信できなくなり、その日以降に作成された RINGGOLD ID を処理または使用することもできなくなります。 私たちのを参照してください よくある質問 詳細はこちら
すべてのアフィリエーションセクションは、APIで同じメタデータのセットを使用します。
- 組織名:* 最高レベルの組織の名前(例:「ボストン大学医学部」ではなく「ボストン大学」)。
- 組織都市:* 組織の拠点となる都市。
- 組織地域: 組織の拠点となる地域。
- 組織国* 組織の国。 これには、 3166文字のISO2Alpha-XNUMX国コード.
- 組織 ID (ROR、Ringgold**、GRID、または LEI):* 組織とそのソースの一意の識別子。部門や部署ではなく、所属内で親組織 ID を使用することをお勧めします。
- 役割/役職: 保持されている役職、または授与された、または授与される予定の学位。
- 部門: 親組織の細分化。
- URL: 所属に関するリソースへのURL
- 開始日: 研究者と組織の関係が始まった日付(年、月、日まで指定できます)。
- 終了日: 研究者と組織の関係が終了した日付(年、月、日まで指定可能)
- 所属を説明する外部永続識別子: 実際の所属アサーションの一意の識別子
*必須フィールドを示します。
**Ringgold 識別子は依然として存在しますが、 ORCID 1 年 2023 月 XNUMX 日時点のレジストリ、 ORCID レジストリで使用される RINGGOLD 組織識別子データベースの更新を受信できなくなり、その日以降に作成された RINGGOLD ID を処理または使用することもできなくなります。 私たちのを参照してください よくある質問 詳細はこちら
An ORCID 記録には、研究者の仕事、所属、資金提供、査読などに関する情報が含まれる場合があります。
上のアイテム ORCID レコードは次のように分類できます アサーション 接続する ORCID 活動または所属のiD保有者. これらのアサーションは、 ORCID 記録を所有する研究者による記録、または研究者がそうすることを許可したシステムによる記録。 アサーションを追加したエンティティを ORCID 記録する source.
例


透明性と開放性の原則に従い、アサーションのソース、つまり誰がその情報をレコードに追加しているかを確認できることが重要であると考えています。 これが私たちのやり方です:
- 研究者(または彼らの委任された 信頼できる個人)レコードにアサーションを追加し、 ORCID その人をソースとして自動的に記録します
- 研究者によって承認されたシステムがレコードにアサーションを追加すると、 ORCID システム所有者を自動的に記録します( ORCID メンバー) をソースとして使用します。
ソース名をユーザーインターフェイスに表示し、APIで(一意の識別子を使用して)使用できるようにします。
ただし、調査情報のワークフローはこれよりも複雑になる可能性があり、アサーションの実際のソースは、あるシステムが人または別のシステムに代わってアイテムを追加することによって意図せずに隠される可能性があります。 透明性を確保するために、誰が人とアイテムを結び付けたのか、誰がアイテムをレコードに追加したのかを区別する必要があります。 上記のように、アイテムをに追加する人は誰でも ORCID レコードは source; 間の接続を作成する人 ORCID iD そしてアイテムは アサーションの起源。
例:
- 研究者はデータを自分の ORCID 検索およびリンクウィザードなどのシステムからの記録。 研究者は彼らをつなぐ主張をしている iD アイテムと一緒に、彼らは アサーションの起源; システムがアサーションをに追加するエンティティである間 ORCID 記録— source
- 研究者はシステムAと対話します( アサーションオリジ)、システムBが提供するサービスを使用して更新します ORCID 記録、システムBを source

私たちは、コミュニティがアサーションの起源に関する情報を保存および共有するための措置を講じることを奨励します。これにより、誰もがソースを見ることで利益を得ることができます。
詳細については、以下を参照してください。
で働く ORCID それらの識別子とそれらの識別子、作品との関係の両方に基づいてグループ化されます。 関係には次の XNUMX 種類があります。
- 自己:識別子はその作品のみを参照し、同じ識別子を持つ他の作品とグループ化できます
- の一部:作品はこの識別子の一部であり、他の作品とグループ化することはできません
- のバージョン:これらの識別子は作品の代替バージョンに適用され、自己およびバージョンの識別子とグループ化できます
- によって資金を供給:これらの識別子は、作業の資金に適用されます。 これらの識別子は、作業のグループ化には使用されません。
当社の API は、XSD でこれをサポートしています。各アイテムには、グループ内でのランクを示す表示インデックス属性があります。最も高い表示インデックスは、研究者が選択した優先アイテムです。API 経由で追加されたアイテムで、研究者によってランク付けされていないアイテムには表示インデックス 1 が付けられ、研究者によって変更されるまで、グループ内のデフォルトの優先ソースとして使用されます。表示インデックスは、アイテムを読み込むときの作業順序も決定します。 ORCID API を使用して記録します。
のグループ化に関する詳細については ORCID 記録、私たちを参照してください サポート記事.
私たちを参照してください サポートされている識別子のリスト V3.0 API 用。 リクエストに応じて新しいタイプを追加することもあります ORCID レジストリにアイテムを追加するときにそれらを使用したいメンバー。
ORCID の使用をサポートします ROR識別子, グリッド識別子 と CrossrefFunderレジストリ の組織を明確にするための識別子 ORCID レコード。
詳細については、を参照してください。 組織識別子の操作
Ringgold の識別子は依然として存在しますが、 ORCID 1 年 2023 月 XNUMX 日時点のレジストリ、 ORCID レジストリで使用される RINGGOLD 組織識別子データベースの更新を受信できなくなり、その日以降に作成された RINGGOLD ID を処理または使用することもできなくなります。 私たちのを参照してください よくある質問 詳細は
マッチングとグループ化の目的で、外部識別子(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。 既存の識別子の値は変更されません。
- 名
- NEW
Works API2.0の役割
以下は、API2.0を使用してサポートされているコントリビューターロールのリストです。- 著者
- 譲受人
- エディタ
- 椅子または翻訳者
- 共同研究者
- 共同発明者
- 大学院生
- 他の発明者
- プリンシパルインベスティゲーター
- ポスドク研究員
- 支援スタッフ
Works API3.0の役割
API 3.0 では、上記のロールに加えて CRedIT ロールを追加できます。 CRediT 分類は以下で構成されます。 学術研究への14の貢献タイプ、 これらの役割を割り当てる方法に関するガイドラインとともに。 以下は、UI値とメタデータ値を含む完全なリストです。 メタデータ値は、NISO実装の推奨事項に従ったURLです。CRediTは、次のリンクで説明されているJATS xmlv1.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.
出版社がDOI登録にCrossrefを使用している作成者は、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 資格、認定、証明書、バッジに関する情報を記録するために記録します。
各資格項目には常に次のものが含まれます。
- 資格タイトル
- プロバイダーの組織ID(例:ROR ID)
- 追加された日付 ORCID 記録
- 資格を追加したのは誰か(ソース)
それらには以下が含まれる場合があります。
- 資格の有効期限が切れた場合の終了日を含む有効日
- 取得した資格のタイプを識別する資格永続ID。
- 取得した資格のタイプの人間が読める形式の説明を含む資格URL。
- 資格の永続 ID。資格証明書のオンライン バージョンにリンクする必要があります。これは、既存の一意の ID または単なる URI にすることができます。
認証とOAuth
パブリックまたはメンバー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 を使用するインテグレーターは、 / read-public 読む範囲 ORCID 記録の概要。
/読み取り制限付きアクセスを取得するには、研究者に許可を求める必要があります。 これは OAuth を使用して行います。 具体的には、 "3本足のOAuth"
詳細については、 APIチュートリアル:データを読み取る ORCID 記録
ORCID 統合では、「3レッグOAuth」を使用してユーザーを認証し、ユーザーのレコードを操作するためのアクセス許可を要求します。 どの統合でも、パブリックAPIを使用して読み取り権限を要求できます。 ORCID メンバーは、メンバーAPIを使用して更新権限を要求できます。 それはこのように動作します:
- 特別なリンクを作成します
- クリックすると、ユーザーはに送信されます ORCID
- ORCID ユーザーにサインインするように求めます
- ORCID アプリケーションに権限を付与するようにユーザーに要求します
- ORCID 認証コードを使用してユーザーをシステムに送り返します
- システムはそのコードをアクセストークンと交換します
カスタマイズされた認証URLには、クライアント情報と、アクセスするレコードの特定の領域を指定する「スコープ」が含まれます。 サインインした後、ユーザーはシステムとの接続を承認し、承認コードとともにランディングページに戻ります。 次に、このコードを使用して、 ORCID iD 要求されたスコープに有効なアクセストークンとともに。
API認証情報のクライアントIDと関連するランディングページ(リダイレクトURI)を指定して認証リンクを作成します。設定によって要求する権限を選択します。 スコープパラメータ.
以下の例では、アクセスが制限されたデータを読み取る許可を要求しています。 ORCID サンドボックステストサーバー。 現実の世界では、このリンクをWebサイトに表示するか、ユーザーに認証と承認を求めるときに電子メールに含めます。 ただし、テストの目的で、Webブラウザに貼り付けるだけで済みます。 角かっこで囲まれたデータをクライアント情報に置き換え、角かっこを必ず削除してください。
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 とアクセストークン。 認証コードは使用時に期限切れになります。 リクエストは次のようになり、 Webブラウザでは作成できません、サーバーで作成する必要があります。
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年で有効期限が切れます。 トークンは、有効期限が切れる前に複数回使用できます。
アクセストークンを使用する
3本足のアクセストークンは特定のものにリンクされています ORCID 記録。 それらを使用するには、そのレコードを読み取ったり更新したりするために作成するAPIリクエストにそれらを含めます。
と対話する許可を要求するとき ORCID ユーザーのレコードでは、XNUMX つ以上の「スコープ」を指定します。 各スコープでは、レコードの読み取りや特定のセクションの更新など、特定の操作を行うことができます。
3脚 ユーザーからの許可の取得に関与するXNUMX人のアクターを指します。 ORCID、システムとユーザー自身。
/認証する 
このスコープは、 ORCID iD 記録上の公開情報のみを読んでください。 他のすべての3脚スコープには認証権限が含まれているため、他のアクセスを要求する場合は、このスコープを省略できます。 このスコープは、メンバーAPIまたはパブリックAPIで使用できます。
/ read-limited(メンバーAPIのみ) 
このスコープは、公開されている可視性のアイテムを読み取るためのアクセス権を取得するために使用されます。 ORCID 記録。 このスコープは、メンバーAPIでのみ使用できます。
/ Activities / update(メンバーAPIのみ) 
このスコープは、所属、資金、作品、専門活動、研究リソース、査読セクションの項目を書き込み、更新、削除するために使用されます。 ORCID 記録。 このスコープは、メンバーAPIでのみ使用できます。
/ person / update(メンバーAPIのみ) 
このスコープは、レコードの他の名前、キーワード、国、研究者のURL、Webサイト、および個人の外部識別子セクションの項目を書き込み、更新、および削除するために使用されます。 このスコープは、メンバーAPIでのみ使用できます。
オープンID
このスコープは、id_tokenが必要な場合にOpenIDインテグレーターによって使用されます。 openidスコープが含まれている場合、レジストリはトークン応答内にid_tokenを返し、そのユーザーのユーザー情報エンドポイントにアクセスするためのアクセス許可をクライアントに付与します。 このスコープは、パブリックAPIとメンバーAPIで利用できます。
'openid'スコープは他のように '/'で始まらないことに注意してください ORCID APIスコープ。 これは、「openid」スコープがによって定義されていないためです。 ORCID、ただし、代わりにOpenIDConnect仕様で定義されています。 ご覧ください OpenIDドキュメント をご覧ください。
複数のスコープ
scope = / read-limited%20 / Activities / update%20 / person / updateのように、認証URLのスコープをそれぞれの間にエンコードされたスペースでリストすることにより、XNUMX回の対話で複数のスコープを要求できます。
完全なアクセス
レコードを読み取って編集するためのフルアクセスが必要な場合は、認証URLに/ read-limited、/ activitys / update、および/ person / updateの20つのスコープを含めます。 URLでは、scope = / read-limited%20 / Activities / update%XNUMX / person / updateとして表示されます。
2本足(クライアントクレデンシャル)スコープ
一部のアクティビティでは、ユーザーに許可を求める必要はありません。 XNUMX つのレッグ OAuth スコープが、 ORCID APIであり、研究者が許可を与える必要はありません。 これらのスコープを持つトークンは20年間有効であり、再利用できます
/ read-public
このスコープは、単一の公開情報を読み取るために使用されます ORCID iD、検索 ORCID レコードを表示したり、概要情報を読み取ったりできます (メンバー API のみ)。このスコープは、メンバー API またはパブリック API で使用できます。
/ webhook
このスコープにより、クライアントアプリケーションはWebhookを ORCID レコード、レコードが更新されたときに通知を受信するため。 このスコープはプレミアムで利用可能です ORCID メンバーのみ。
複数のユーザーが同じマシン上にいて、セッション間でサインアウトしないことが懸念される場合は、OAuthプロセス中にユーザーに再認証を強制することができます。 単に含める prompt=login
OAuthリクエストで。 また、max_ageを秒単位で設定して、セッションが特定の長さを超えている場合にユーザーに再認証を強制することもできます。 私たちを参照してください OpenIDConnectのドキュメント のガイドをご参照ください。
ユーザー いつでも自分で表示言語を変更できます。 次の言語設定が利用可能です。
言語 | Code |
عربى (アラビア語) | ar |
čeština(チェコ) | cs |
英語 | en |
日本語Español(スペイン語) | es |
フランス語(フランス語) | fr |
ドイツ語(ドイツ語) | de |
イタリア語(イタリア語) | it |
日本語(日本語) | ja |
한국어(韓国語) | ko |
ポルスキ(ポーランド語) | pl |
ポルトガル語(ポルトガル語) | pt |
Русский(ロシア語) | ru |
Türkçe(トルコ語) | tr |
简体中文(簡体字中国語) | zh_CNに |
繁體中文(繁体字中国語) | zh_TW |
パラメータのいずれかまたはすべてを使用できます。
フィールド | Notes | |
名前 | 名 | この ファーストネーム フィールドはに入力されます 登録用紙 指定されたメールアドレスまたは ORCID iD アクティブなものと一致しません ORCID 記録。 |
家族の名前 | 苗字 | この 苗字 フィールドはに入力されます 登録用紙 指定されたメールアドレスまたは ORCID iD アクティブなものと一致しません ORCID 記録。 |
メール | この Eメール/ORCID iD フィールドはに入力されます サインインフォーム 指定されたメールアドレスがシステムに見つかり、有効でない場合 ORCID iD が指定されています。 email フィールドはに入力されます 登録用紙 指定されたメールアドレスがシステムに見つかり、有効でない場合 ORCID iD メールアドレスは次のようになります。 URLエンコード、「@」を「%40」に変更することを含みます。ユーザーの ORCID iD とメールアドレス、私たちはお勧めします の 提供する ORCID iD orcid パラメータ内。 | |
オーキッド | ORCID iD | この Eメール/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認証URLが要求するのと同じスコープでアクティブなアクセストークンがすでに存在し、ユーザーがサインインしている場合 ORCID 記録すると、認証を再度付与するように求められることはありません。 代わりに、リダイレクトURIに直接移動します。 ユーザーが接続するたびに認証を付与するようにユーザーに要求する場合は、 強制サインアウト方法
Implicit OAuthは、サーバー側のコンポーネントを持たない、または使用したくないシステムで使用するように設計された、軽量バージョンのOAuthです。 暗黙的なOAuthは、JavaScriptのみを使用してブラウザーに完全に実装できます。 メンバーと非メンバーが利用でき、次のように機能します。
- 特別なリンクを作成します
- クリックすると、ユーザーはに送信されます ORCID
- ORCID ユーザーに i に署名するように求めます
- ORCID アプリケーションに権限を付与するようにユーザーに要求します
- ORCID ユーザーをシステムに送り返します ORCID iD、アクセス トークン、および ID トークン。
- システムは認証済みを抽出して保存します ORCID iD 応答から。
セキュリティ上の理由から、暗黙的なOAuthを使用する場合、 ORCID 更新権限を持つアクセストークンは返されません。
暗黙のフロー
暗黙的なフローは、クライアントが開始するために秘密鍵を使用する必要がないように設計されています ORCID サインインします。セキュリティは、クライアントを登録済みのredirect_urlsに制限することで実施されます。 この低レベルのセキュリティは、 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とは何ですか?どのように使用されますか?
リダイレクトURIは、セキュリティ対策としてOAuth認証サービスによって使用されます。 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を追加]をクリックして既存のリダイレクトURIを編集します
- 変更を加えたら、保存アイコンをクリックする必要があります
HTTPSURIのみ 生産に受け入れられます。 http URI を使用してテストできますが、本番メンバー API 資格情報を申請するときに HTTPS URI を登録する必要があります。
OpenID Connect 1.0は、OAuth2.0プロトコルの上にある単純なIDレイヤーです。 これは、既存のOAuth認証フローを補足し、ユーザーに関する情報をクライアントに適切に説明された方法で提供します。
OpenID接続は、OAuthを実装し、認証されたユーザーに関する情報を共有するための標準化された方法です。 使用するサービスを構成できるようになります ORCID 他の標準に準拠したOpenID Connectプロバイダーと並んで「すぐに使える」。OpenID Connectは、ユーザーが認証されたことを証明できる署名付きオブジェクトである共有可能なIDトークンも提供する。 ORCID 特定の時間に。 これらのトークンは、ユーザーインターフェイス要素がユーザーセッションを維持するために使用できます。
ORCID OAuth認証コードフローの拡張である基本的なOpenIDプロバイダー適合性プロファイルをサポートします。 ORCID 「/ authenticate」スコープと「openid」スコープの暗黙的なトークンフローもサポートします。
これは、 ORCID:
- 'openid' スコープで生成された認証コードのトークン応答内に署名された ID トークンを埋め込みます。
- 'token'または 'token id_token'response_typesおよび' openid 'スコープを使用する場合の暗黙的なフローをサポートします。
- 'openid'スコープを含む承認リクエストの 'prompt'、 'nonce'、および 'max_age'パラメーターをサポートします。
- OpenidConnectの検出とuserinfoエンドポイントをサポートします
- 「openid」スコープを含む承認リクエストのメンバー API を使用するインテグレータの「amr」フィールドをサポートします。 これを使用して、ユーザーが XNUMX 要素認証を使用して認証されたかどうかを検出できます。
OpenID Connect認証の開始は、通常のOAuth認証と同じように機能します。 必要なのは、クライアントが「openid」スコープを要求することだけです。/authenticateスコープを使用している場合は、openidに置き換えます。authenticateとopenidは同じ認証を持っているため、どちらか一方のみを使用する必要があります。 他のスコープを使用している場合は、要求されたスコープのリストにopenidを追加します。 openidスコープが含まれている場合、レジストリはトークン応答内にid_tokenを返し、そのユーザーのユーザー情報エンドポイントにアクセスするためのアクセス許可をクライアントに付与します。
「openid」スコープは、他のスコープのように「/」で始まらないことに注意してください。 ORCID APIスコープ。 これは、「openid」スコープがによって定義されていないためです。 ORCID、ただし、代わりにOpenIDConnect仕様で定義されています。
取り付けガイドを参照してください。 技術文書 をご覧ください。
ORCID ユーザーが有効にできるようにする 二要素認証 (2FA)彼らの ORCID アカウント。 2FAは、サインインプロセス中に行われる二次セキュリティチェックです。 これは、ユーザーが実際にサインインしている人であるという追加の確認を提供します。 ORCID アカウント。 これをユーザー向けに構成する方法の詳細については、 KB記事.
OpenID メンバー API を使用する接続インテグレーターは、ユーザーがサインインしたかどうかを確認できます。 ORCID OAuthプロセスの一部として2FAが有効になっているアカウント。 これにより、メンバーインテグレーターは、研究者に高度なセキュリティシステムへのアクセスを許可できます。
と一緒に 研究者による彼らの管理への取り組み ORCID 記録、レコード所有者は、アクセストークンをアクセス許可から削除することにより、いつでも取り消すことができます。 信頼できる組織信頼できる関係者のページの下にリストを表示します。
2018年の時点で、研究者は、ユーザーが許可を取り消さない限り、20年間続く長期アクセストークンのみを付与できます。
ORCID シンプルな Javaスクリプトウィジェット 認証を取得するために使用できる ORCID OpenIDConnectでOAuthを使用するiD。
ウィジェットは暗黙的なOAuthを使用するため、書き込み権限を収集しないことに注意してください。 これは、レコードを更新したいメンバー統合には適していないことを意味します。 のチュートリアルをご覧ください 上のデータの追加と更新 ORCID レコード。
ORCID 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に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 でのみ使用可能) |
/住所 | 研究者の国または地域 |
/Eメール | レコードに関連付けられているメールアドレス |
/ external-識別子 | 他のシステムのリンクされた外部識別子 |
/ keywords | 研究者とその研究に関連するキーワード |
/他の名前 | 研究者が知っている他の名前 |
/ personal-詳細 | 個人情報:研究者名、クレジット(公表)名、略歴 |
/ researcher-urls | 研究者の個人ページまたはプロフィール ページへのリンク |
/アクティビティ | の活動セクションの要約 ORCID 以下の/ worksを含む記録。 |
/教育 | 教育機関 |
/雇用 | 雇用提携 |
/ fundings | 資金調達活動の概要 |
/ピアレビュー | ピアレビュー活動の概要 |
/ works | 研究成果のまとめ |
/ research-resources | 研究リソースの要約 |
/ services | サービスの概要 |
/資格 | 必要条件の要約 |
/ memberships | メンバーシップの概要 |
/ distinctions | 区別の要約 |
/ invited-positions | 招待されたポジションの概要 |
アイテム(仕事、雇用、資金調達、ピアレビューなど)をに追加することができます ORCID 手動で録音するか、 ORCID メンバーAPI。記録を更新したいと考えている個人の方は、こちらをチェックしてください。 これに関するヘルプセクションはこちらです。 にアイテムを追加しようとしているメンバーの場合は、 ORCID 記録するには、次のものが必要になります。
- 研究者の許可
- メンバーAPIクレデンシャル
- そしてどちらか:
- と統合するベンダーシステム ORCID メンバーAPI
- と統合する独自のシステム ORCID メンバーAPI
API を使用してアイテムをレコードに追加するメンバー向けの完全なガイドについては、以下の API チュートリアル リンクをご覧ください。
この例の呼び出しは、完全な要約を取得します ORCID サンドボックスサーバーのメンバーAPIを使用してXML形式で記録します。 パブリックAPIまたはメンバー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 です。
- システムがiDを収集する理由と、システムがレコードの更新などのタスクを実行する方法。
- 研究者が作成することで利益を得る理由 ORCID iD そして彼らのiDをあなたのシステムに接続します。
- 認定条件 ORCID より広いグローバルな研究コミュニティに利益をもたらします。
コミュニティからのフィードバックに基づいて、このリソースの「ライブラリ」を継続的に構築していきます。 見たいものがありましたら、お気軽にお問い合わせください。
にアイテムを追加する前に ORCID データをフォーマットする必要があるレコード ORCID スキーマ。 でデータをフォーマットします ORCID XMLまたはJSONのメッセージスキーマ。
GitHubリポジトリには、で新しいアイテムを作成するときにフォーマットするのに役立つリソースが含まれています ORCID 記録し、上の既存のアイテムを読むとき ORCID 記録:
API のバージョンが異なれば、メッセージ形式も異なることに注意してください。 バージョン2.0および2.1のスキーマと例も利用できます.
十分に入力されたレコードのメタデータを読み取ることで、より多くの例を簡単に見つけることができます。
以前のバージョンの ORCID APIには追加のスコープがありました。 これらのスコープは、2.0APIで段階的に廃止されました。 すべての統合で、推奨されるスコープのみを使用することをお勧めします。 参考までに、以前のスコープと、代わりに使用する必要のある現在のスコープを以下に示します。
- /orcid-profile/読み取り制限 代わりに使用してください / read-limited
- /orcid-works/読み取り制限 代わりに使用してください / read-limited
- /orcid-bio/読み取り制限d代わりに使用 / read-limited
- /orcid-works/作成 代わりに使用してください / activity / update
- /orcid-works/アップデート 代わりに使用してください / activity / update
- / affiliations / create 代わりに使用してください / activity / update
- / affiliations / update 代わりに使用してください / activity / update
- / Funding / create 代わりに使用してください / activity / update
- 代わりに/ funding / updateを使用/ activities / update
- /orcid-bio/アップデート 代わりに使用してください / person / update
- /orcid-bio/外部識別子/作成 代わりに使用してください / person / update
更新トークンは、追加のアクセストークンを生成するために使用されます。 更新トークンは、認証コードを交換するときにアクセストークンとともに返されます。 XNUMX本足のOAuthプロセス、およびアクセストークンがアクティブである限り使用できます。
新しいアクセストークンは、元のアクセストークンと同じ有効期限とスコープを持つことができます。または、元のアクセストークンからのスコープのサブセットを小さくするだけでなく、寿命を短くするように指定することもできます。 元のトークンを置き換えるために新しいアクセストークンを生成することも、追加のトークンとして機能するように生成することもできます。 更新トークン呼び出しを使用して、元のアクセスと更新トークン、およびユーザーによって付与されたすべてのアクセス許可を完全に期限切れにすることもできます。
次の条件で更新トークンを使用することをお勧めします。
- 侵害された可能性のあるアクセストークンの交換(後に元のアクセストークンを必ず取り消してください)
- あなたの一部でもある第三者を与える ORCID 統合より制限されたアクセスおよび/または限られた時間のアクセス。
私たちを参照してください 技術文書 更新トークンから新しいアクセストークンを作成する方法について。
XNUMXつの異なる更新スコープがあります。XNUMXつは経歴の詳細用で、もうXNUMXつはアクティビティ用です。
対象領域 | 説明 | APIエンドポイント |
/ person / update | 経歴データ - の左の列 ORCID ユーザーインターフェイスを記録します。 | /住所 / external-識別子 / keywords /他の名前 / researcher-urls |
/ activity / update | 研究活動データー右欄 ORCID ユーザーインターフェイスを記録します。 | /区別 / distinctions /教育 /教育 /雇用 /雇用 /資金 / fundings / invited-position / invited-positions / membership / memberships /ピアレビュー /ピアレビュー /資格 /資格 / research-resource / research-resources /サービス / services /作業 / works |
クライアントID、シークレット、およびアクティブトークンまたはそれに関連付けられた更新トークンのいずれかを使用して、トークンペアを取り消します。 XNUMX本足との両方で作成されたトークンペアを取り消すことができます XNUMX本足の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を呼び出し、アイテムの完全なデータを取得できます。 以下の項目は、 コードを入れる:
エンドポイント | 説明 |
/ address / [プットコード] | 個々の国または地域 |
/バイオグラフィー | 伝記フィールド:研究者のみが編集できるフリーテキスト領域 |
/ Education / [コードを入力] | 個人教育所属項目 |
/ email / [プットコード] | レコードに関連付けられている個々のメールアドレス |
/ employee / [プットコード] | 個人雇用所属項目 |
/ external-identifier / [プットコード] | 別のシステムでリンクされた個々の外部識別子 |
/ Funding / [プットコード] | 個別の資金調達活動 |
/ keywords / [プットコード] | 研究者とその研究に関連する個々のキーワード |
/ other-names / [プットコード] | 研究者が知っている個人の追加名 |
/ peer-review / [コードを入力] | 個々のピアレビュー活動 |
/ researcher-urls / [コードを入力] | 研究者の個人ページまたはプロフィール ページへの個別の外部リンク |
/ work / [コードを入れる] | 個別の調査研究 |
/ works / [put code1]、[put code2]、[put code3] | 個別のバルク研究(最大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 記録。 一度に更新できるアイテムはXNUMXつだけであり、最初にアイテムを作成したクライアントのクレデンシャルを使用してのみ更新できます。
更新を容易にするために、 プットコードとアクセストークンを保存する アイテムを作成するとき。
更新されたアイテムをフォーマットします 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は、アイテムが正しく更新されたことを示す200OKメッセージを返します。 別のメッセージが返される場合は、トラブルシューティングページを確認してください。
可視性は、ユーザーが設定した可視性設定に基づいて、アイテムのプライバシー設定を示します。 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構文を使用します。 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 /?= [クエリ] |
サンドボックスのパブリック 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の場合、を指定してHTTPDELETEリクエストを行うことができます 関連エンドポイント、 一緒に ORCID iD、 保存されたアクセストークン、および保存されたプットコード。 一度に削除できるアイテムはXNUMXつだけで、クライアントによって追加されたアイテムのみを削除できます。 ユーザーが権限を取り消した場合でも、アイテムを削除できます。
この例の呼び出しは、レコードからプットコード「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構文を使用します。 SOLR3.6で使用可能なすべてのクエリ構文がサポートされています、Solr拡張機能を備えたLuceneを含む (デフォルト)、DisMax、およびExtendedDismax。
の特定のセクションを検索する必要がある場合は、フィールド検索を使用できます。 ORCID 記録。 API検索で認識されるフィールドの現在のリストと、対応するレコード構造要素は次のとおりです。
検索フィールド | 説明 |
経歴データ | |
名前 | ユーザーの指定された(名)名。 |
苗字 | ユーザーの家族(sur)名。 |
クレジット名 | の「公開名」 ORCID ユーザーインターフェイス、ユーザーが出版物に通常表示する名前 |
他の名前 | ユーザーが出版物に表示した可能性のある別名。 |
ユーザーの電子メール アドレス。 | |
キーワード | ユーザーに関連付けられているキーワード。 |
外部 ID 参照 | ユーザーに追加された他のシステムからの識別子 ORCID APIを使用して記録します。 |
所属データ | |
所属組織名 | ユーザーの記録にある教育または雇用項目に含まれる組織の名前。 |
グリッド組織 ID | この グリッドID ユーザーの記録の活動セクションにある組織の通常、これは教育または雇用項目に関連付けられます。 |
r-org-id | この ROR ID ユーザーの記録の活動セクションにある組織の通常、これは教育または雇用項目に関連付けられます。 |
リングゴールド組織ID | この リングゴールド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 記録データ | |
オーキッド | 16桁 ORCID 0000-0001-2345-6789形式のユーザーの識別子。 |
プロファイル-提出-日付 | レコードが作成された日時。 |
プロファイル-最終変更日 | レコードが最後に変更された日時。 |
すべてのデータ | |
클라우드 기반 AI/ML및 고성능 컴퓨팅을 통한 디지털 트윈의 기초 – Edward Hsu, Rescale CPO 많은 엔지니어링 중심 기업에게 클라우드는 R&D디지털 전환의 첫 단계일 뿐입니다. 클라우드 자원을 활용해 엔지니어링 팀의 제약을 해결하는 단계를 넘어, 시뮬레이션 운영을 통합하고 최적화하며, 궁극적으로는 모델 기반의 협업과 의사 결정을 지원하여 신제품을 결정할 때 데이터 기반 엔지니어링을 적용하고자 합니다. Rescale은 이러한 혁신을 돕기 위해 컴퓨팅 추천 엔진, 통합 데이터 패브릭, 메타데이터 관리 등을 개발하고 있습니다. 이번 자리를 빌려 비즈니스 경쟁력 제고를 위한 디지털 트윈 및 디지털 스레드 전략 개발 방법에 대한 인사이트를 나누고자 합니다. | 上記のすべてのフィールド。 これは、Lucene構文クエリのデフォルトフィールドでもあります。 |
取り付けガイドを参照してください。 検索APIチュートリアル をご覧ください。
*Ringgold の識別子は依然として存在しますが、 ORCID 1 年 2023 月 XNUMX 日時点のレジストリ、 ORCID レジストリで使用される RINGGOLD 組織識別子データベースの更新を受信できなくなり、その日以降に作成された RINGGOLD ID を処理または使用することもできなくなります。 私たちのを参照してください よくある質問 詳細は
実際の状況では、APIの相互作用は、PHP、Java、Ruby onRailsなどのプログラミング言語を使用してシステムによって完了されます。 練習とテストのために、あなたはと対話することができます ORCID HTTPリクエストを作成および受信できるさまざまなツールを使用するAPI。 ほとんどのデスクトップHTTPツールはコマンドラインで実行されます。 グラフィカルインターフェイスを好む人にとっては、Webベースのツールが便利な代替手段です。
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リクエストを実行するために利用できるツールはたくさんあります。 私たちが使用するもの:
Webhookは、プレミアムメンバーが誰に対しても登録できます。 ORCID レジストリに記録します。 手順は次のとおりです。
URLをエンコードします
URL-必要なURLをエンコードします ORCID ユーザーのレコードが更新されたときに呼び出す。 たとえば、次の URL です。
https://nowhere2.com/0000-0002-7465-2162/updated
になる
https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
URLを作成する
の完全なURLを作成します ORCID のURLで始まるAPI呼び出し ORCID 記録し、‚√∫/webhook‚√π と呼び出したい URL を追加します。つまり、https://api.sandbox.orcid.org/{ のようになります。ORCID} / webhook / {URL-ENCODED-WEBHOOK-URL}
たとえば、上記のWebhookURLと ORCID iD 0000-0002-7465-2162、完全なURLは次のとおりです。
https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
Webhookを登録する
Webhook のアクセス トークンを使用して、ユーザーに対して 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と同じです。 ただし、HTTPDELETEメソッドを使用する必要があります。
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 レコードが更新されると、レジストリは次のHTTP呼び出しを実行します。 リクエストはHTTPPOSTメソッドを使用しますが、リクエストの本文は空です。
curl -v -X POST https://nowhere2.com/0000-0002-7253-3645/updated
サーバーは、標準のHTTP応答コードで応答する必要があります。 したがって、呼び出しが成功した場合は、204 NoContentを返す必要があります。
HTTP/1.1 204 No Content
2xx応答コードは、呼び出しが成功したことを意味します。 2xx以外のコードを返した場合は、XNUMX分後に通話を再試行します。
実際の状況では、APIの相互作用は、PHP、Java、Ruby onRailsなどのプログラミング言語を使用してシステムによって完了されます。 ただし、練習とテストでは、 ORCID HTTPリクエストを作成および受信できるさまざまなツールを使用するAPI。 ほとんどのデスクトップHTTPツール( curl)コマンドラインで実行されます。 グラフィカルインターフェイスを好む人にとっては、Webベースのツールが便利な代替手段です。
人気のあるツールのXNUMXつは GoogleのOAuth2.0プレイグラウンドは、Google が開発および管理している無料のウェブベースのツールです。
実践的な API チュートリアルについては、https://info.orcid.org/hands-on-with-the-orcid-api/ をご覧ください。
ご注意: ORCID OAuth 2.0 Playgroundを維持していません–このツールは、コードを独占的に維持しているGoogleによって作成されました。 このドキュメントは定期的に更新されますが、OAuth 2.0 Playgroundの変更にすぐに気付かない場合があるため、不正確な場合があります。
ORCID 使用している API に応じて、異なる API 使用量クォータとレート制限をサポートします。
API | 匿名API | パブリック(登録済み)API | メンバーAPI |
レート制限 | 12 リクエスト/秒40 バースト/秒 | 12 リクエスト/秒40 バースト/秒 | 24 リクエスト/秒40 バースト/秒 |
使用量制限 | 100 回/日 (IPアドレスごと) | 100 回/日 (クライアントIDごと) | 使用量制限なし |
2番目のリクエスト 1 秒間に実行できるリクエストの数です。
バースト 拒否する前にキューに入れることができるリクエストの数です。キュー内のリクエストは、503 秒あたりのリクエスト数まで減速されます。バーストを超えると、XNUMX 応答が返されます。
使用量の割り当てを超過した場合、一定期間内にそれ以上のリクエストを行うことはできなくなります。
覚えておいてください。 ORCID パブリックAPIは、以下の通り、個人による非商用利用は無料です。 パブリックAPI利用規約「非営利」とは、パブリック API に対して再利用料金を請求したり、収益を生み出す製品やサービスに関連してパブリック API を使用したりできないことを意味します。
クライアント認証情報を使用してパブリックAPIを使用すると、匿名APIよりも高い使用割り当てを統合に使用できます。 統合ガイド パブリック API クライアントを登録する方法について説明します。
パブリックAPIのAPI使用クォータを定期的に超過している場合は、 ORCID 会員登録して メンバーAPIより高いレート制限と無制限の使用クォータにアクセスできるだけでなく、信頼できるパーティデータにアクセスできるようになります。 ORCID 記録し、データを提供する ORCID ユーザーの許可を得て、組織のシステムから記録を取得します。
研究者の管理は核心です ORCID 原則 そのため、メールアドレスが登録され、 ORCID デフォルトでは、レコードはレコード所有者にのみ表示されるように設定されています。 未確認の電子メールはレコードのパブリックビューに表示されず、検証済みの電子メールアドレスのみがAPI結果に表示されます。
研究者が自分の電子メールアドレスを確認したら、第三者機関が電子メールアドレスを読み取れるように、すべての人(つまり公開)または信頼できる関係者(つまり制限付きアクセス)に表示するように選択する必要があります。
研究者が信頼できる当事者に電子メールアドレスを設定した場合、研究者があなたに許可した場合は、レコードとともに返送されます 読み取り制限付きアクセス。 詳細については、を参照してください。 ORCID 可視性の設定.
API 3.0 がデフォルトの API バージョンであり、新しい統合を構築する場合はこのバージョンを使用することをお勧めします。 API 2.0 および 2.1 は当面サポートし続け、これらのバージョンをオフにする前に少なくとも 12 か月前に通知します。
API1.2からAPI2への移行中に多くのことを学びました。今回は、アップグレードの管理がはるかに簡単になりました。 API 3.0は、絶対に必要な場合にのみ既存の機能を変更しながら、新しい機能を追加します。 これは、インテグレーターが最小限の手間で新しいAPIに切り替えることができる必要があることを意味します。 また、組織や研究者が新機能を利用できるように、できるだけ早くアップグレードの計画を開始することをお勧めしますが、3.0にいつ更新するかを柔軟に決定できることも意味します。
重大な変更の可能性のある小さなリストは、APIリリースノートにあります こちら と こちら。 オプション/必須フィールドの周りにいくつかの変更があり、JSON列挙がわずかに変更されています。また、XMLスキーマの小さなリファクタリングがあり、新しい機能に必要なメタデータを含むいくつかの新しいフィールドが追加されています。
ご覧ください ORCID パブリッシャー向けのベンダー対応システム ページ 最新の情報については
プレミアムメンバーなら誰でも「/webhook」アクセストークンを取得できます。 XNUMX つのトークンを使用して、複数のレコードの 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のバージョン管理、その背後にある理論的根拠などについて詳しくは、こちらをご覧ください。 API バージョン ポリシー.
製品の開発を続ける中で、最新のデフォルトAPIバージョンであるAPI3.0でのみ利用できる機能がいくつかあります。
次の表に、各機能の簡単な説明を示します。 機能のいずれかまたは3.0へのアップグレードに関して質問がある場合は、エンゲージメントリードまたはコンソーシアムリードにお問い合わせください。
すべてのアフィリエーションタイプを読み書きする機能(メンバーシップ、サービス、招待されたポジション、区別、および資格は、以前のバージョンのAPIでは使用できません) |
研究リソースを読み書きする能力。 |
関係タイプが「資金提供者」の作業識別子を読み書きする機能。 これは、付与IDまたは提案IDを作業メタデータにリンクするために使用されます。 |
関係タイプが「バージョン」の作業識別子を読み書きする機能。 これは、他のバージョンの作品をリンクするために使用されます。 ユースケースの例は、プレプリントと公開された記事をリンクすることです。 |
Worksメタデータ内でCRediTロールを読み書きする機能。 |
追加のソースフィールドを読み取る機能 common:assertion-origin-client-id と common:assertion-origin-name によって追加された所属の場合 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 レジストリ。 組織の技術担当者としてリストされることを希望する場合は、 お問い合わせ.
ORCID オープンかつ透明であることを約束します。 これは私たちのことを意味します 製品ロードマップ 誰でも見ることができます。 現在開発中の作業.
製品ロードマップは、 ORCID 製品開発プロセス。 要件は、チームが管理するトレロボードから、製品ロードマップトレロボードを経由して、現在の開発トレロボードに移動し、そこで実装されて本番システムに移動されます。
このボードには、実装がスケジュールされている明確に定義された要件が含まれています ある時点で、および短期的に実装が予定されている優先要件のリスト。
要件はどこから来るのですか?

要件は、によって多くのソースから収集されます ORCID スタッフ。 それらは、とりわけ、メンバーの要求、コンソーシアムのフィードバック、ユーザーテスト、戦略的プロジェクト、およびバグレポートから発生する可能性があります。 さらに、すべて ORCID チームは、Webサイトの変更、インフラストラクチャのアップグレード、運用システムの更新など、独自の内部要件を生成します。 各カードには、要件を作成したチーム(通信、戦略、技術、エンゲージメント、運用)のタグが付けられています。
ロードマップの内容はどうですか?
ORCID バランスの取れた製品開発サイクルを目指しており、短期的および長期的な優先事項について話し合うために定期的にチーム間会議を開催しています。 私たちは、バグ、新機能、技術的負債、ウェブサイトの更新、戦略的項目に等しく対処するために最善を尽くします。
ロードマップにどのように貢献できますか?
改善する方法についての提案を歓迎します ORCID レジストリ。 にフィードバックを送ってください 私たちのチーム.
加えて、 ORCID はオープンソースプロジェクトであり、ソースコードだけでなくすべてへの貢献を歓迎します 私たちのリポジトリ.
プレプリントは、著者が公開サーバーにアップロードする完全な科学論文です。 プレプリントには完全なデータと方法論が含まれています。 多くの場合、ジャーナルに投稿されるのは同じ原稿です。 作品が本質的に科学的であることを確認するための簡単な品質管理検査の後、著者の原稿は査読なしで XNUMX 日ほどでウェブに掲載され、世界中の誰もが無料で閲覧できるようになります。 フィードバックや新しいデータに基づいて、プレプリントの新しいバージョンを提出できます。 ただし、以前のプレプリント バージョンも保持されます。 プレプリント サーバーにより、科学者は世界中の科学コミュニティへの研究成果の配布を直接制御できます。 ほとんどの場合、プレプリントとして投稿された同じ研究は、ジャーナルの査読にも提出されます。 したがって、プレプリント(迅速だが査読による検証は行われない)とジャーナル出版(低速だが査読による検証の提供)は、科学研究のコミュニケーション システムとして並行して機能します。
注:このコンテンツと動画は、もともと ASAPBioのWebサイト CC-BYライセンスの下で利用できるようにしてくれたASAPBioに感謝します!
から毎月送信される会員向けニュースレター ORCID 以前は、すべてのメンバー レポートが保存されている Google ドライブ フォルダーへのリンクが含まれていました。 これは現在、すべてのメンバーが利用できる新しいレポートに置き換えられています。 メンバーポータル.
以前のレポート:
- アクティブな統合を備えたプレミアム メンバー 前月の各統合のデータを含む個別のカスタマイズされたレポートを含むフォルダーへの一意のリンクを受け取ります。
- まだアクティブな統合が行われていないプレミアム メンバー 教育機関の電子メール統計を含むカスタマイズされたレポートを含むフォルダーへの固有のリンクと、すべてのアクティブなメンバー統合の集計データを含む一般レポートを含むフォルダーへのリンクを受け取ります。
- 基本会員 過去半年のすべてのアクティブなメンバー統合の集計データを含む年に XNUMX 回発行される一般レポートを含むフォルダーへのリンクを受け取ります。 今年上半期のレポートは年に発行されます 7月 (XNUMX月~XNUMX月データ)、XNUMX年下半期レポート 1月 (翌年XNUMX月~XNUMX月)。
あなたがいる場合 ORCID 会員であり、現在月刊会員ニュースレターを受け取っていない場合は、お問い合わせください。 [メール保護]
アクティブな統合を備えたプレミアム メンバー
Google ドライブ フォルダには、発行された実稼働クライアント iD ごとのメンバー レポートが含まれています。 ファイル名にはクライアントの表示名が含まれます。 iD および報告書の日付。 最新のレポートを見つけるには、変更日で並べ替えてください。 レポートの生成に使用されたデータを含む raw_data フォルダーもあります。これは、必要に応じて追加の分析に使用できます。
まだアクティブな統合が行われていないプレミアム メンバー
Google ドライブ フォルダには、電子メール統計データのみを含むメンバー レポートと、今年および過去数年間のすべてのアクティブなメンバー統合の集計データを含む一般的な月次レポートの Google ドライブ フォルダへのリンクが含まれています。 これらのレポートでは生データは利用できません。
電子メールのドメイン数
このセクションでは、次の数を示します。 ORCID iDs は現在、すべての期間にわたって機関の電子メール ドメインを登録しています。 これらのカウントを生成するために、組織のファイルにある Web サイトの URL と一致するドメインを検索します (例: Web サイトの URL が www.universitycollege.edu の場合、@universitycollege で終わる電子メールを検索します)。 ウェブサイトの URL が登録されていない場合は、このセクションに「メール ドメインがありません」と表示されます。 メール ドメインが適切に取得されなかった場合、またはドメインを追加したい場合は、 お問い合わせ.
- メールドメインに登録されているレコードユニーク数 ORCID 所属機関の電子メール ドメイン内のアドレスを含む iD
- 電子メール ドメインに登録され、クライアント ID に関連付けられているレコードユニーク数 ORCID 貴機関の電子メール ドメイン内のアドレスを含み、かつ貴機関を信頼できる当事者として含む ID (つまり、貴機関が有効なアクセス トークンを持っていることを記録する)
作成および申請された記録
(注: ほとんどのクライアントはレポートにこのセクションを含めません)
API を介して研究者に代わってレコードを作成するために使用された機関クライアントをお持ちの場合は、「レジストリ統計」と呼ばれるセクションが表示されます。 これには、作成したレコードの数と要求されたレコードの数に関する情報が含まれます (raw_data ファイルには、これらの数値を生成するために使用された特定のレコードに関する詳細情報が含まれています)。
ユーザー
レポートのこのセクションには、統合を使用して研究者間の接続を行った研究者の総数が含まれています。 ORCID iD レポートの月にわたってシステムに送信されます。 さらに、新しい研究にサインアップした研究者の総数も表示されます。 ORCID iD の一部として iD 接続プロセス。
「Total Integration Events」というラベルの付いたグラフには、先月に統合を使用した研究者の数が日ごとに表示されます。
イベント
レポートには次の内容も含まれています イベント 情報、研究者が接続するときに実行したアクション ORCID 報告月にシステムで記録します。 各イベントは、ユーザーが許可したアクセス、またはユーザーが実行したアクションを表します。 ORCID サイト (サインインまたは読み取り制限付きアクセスの付与など)。 ほとんどの研究者は、複数のイベントを関連付けています。
イベントに ‚√∫√π が追加されている場合、これは研究者が長命 (P永続的) トークン。2018 時間で期限切れになる短命のトークンと比較して。 XNUMX 年 XNUMX 月以降、長期間有効なトークンのみがサポートされています。 ORCID レジストリ; 統合システムを使用することも、ユーザーがいつでもトークンを取り消すことを選択することもできます。
国別のユーザー数
レポートの最後のセクションには、統合にアクセスした国別に分類された、統合を使用した研究者に関する情報が含まれています。このデータは、研究者の IP アドレスまたは地理 ID (研究者の IP アドレスから Google が決定) から取得されます。
サンプリング
非常に多くの研究者が使用しているため、 ORCID レジストリ、研究者データのセット全体についてレポートを作成することは現実的ではありません。 代わりに、ここで提供される数値は、サンプリングされたセットとサンプリングされていないセットの傾向を使用して生成されます。 サンプリングされたデータから派生したレポートのセクションはアスタリスクで示され、サンプリングされたサイズとスペースは [分析データ] タブで指定されます。 レポートの Google アナリティクス セクションの数値は、保持しているローカル統計と完全には一致しない場合があり、レポートのセクション間でカウントにわずかな差異が生じる場合があります。
Integration Analytics の下にリストされているサンプリング パラメーターは、アスタリスクの付いたすべてのセクションに適用されます。 分析データによってキャプチャされたセッションの割合は、(サンプル サイズ)/(サンプル空間) * 100% です。 サンプリングに関する詳細情報は、次のサイトでご覧いただけます。 Googleの開発者.
空のレポート
レポートの「ユーザー」セクションと「イベント」セクションには、過去 XNUMX か月のデータのみが含まれます。 過去 XNUMX か月間インテグレーションを使用した研究者がいない場合、データは返されません。
質問
メンバーレポートについてご質問がある場合は、 お問い合わせ.
この ORCID レジストリは、ユーザーがOAuthを使用して組織にiDを提供できるように設計されています。これにより、正しい iD 研究者ごとに収集されます。 組織が追加することをお勧めしません ORCID 名前による研究者の検索に基づくシステムへのiD。 ただし、組織内に何人の研究者がいるのかを知ることは役立つ場合があります ORCID APIを介して実行できるiD。 組織による検索の提案を以下に示します。
検索の概要、アクセストークンの取得方法、検索結果の理解方法、および検索可能なその他のフィールドの詳細については、 レジストリAPIチュートリアルの検索
名前とDOIで検索
個人が持っているかどうかを確認するとき ORCID 記録として、彼らの名前とXNUMXつ以上の最近の作品のDOIの両方で検索することをお勧めします。 これにより、同じ名前を共有する他の人の記録ではなく、探している研究者の記録だけが得られるはずです。
「LaurelHaak」という名前のすべてのレコードと、DOI 10.1087 / 20120404またはDOI10.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
RORIDで検索
RORIDを持つすべてのレコードを検索するための呼び出し例 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形式で返すこともできます。 呼び出しの一部として、以下の使用可能なフィールドのリストから出力列を指定できます。
オーキッド
email
名
苗字
与えられた家族の名前
クレジット名
ほかの名前
現在の機関-所属-名前
過去の機関-所属-名前
クレデンシャルを使用して、ヘッダーを 'に指定する必要がありますtext / 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 識別子.
ORCID に設立されました 原則 研究者は自分の情報を管理する必要があります。 この原則を尊重するために、私たちは強力な プライバシーポリシーをご覧ください。は、プライバシー規制の地域的な違いを考慮して設計されており、ポリシーと機能を開発する際に研究者の視点に焦点を当てています。
私たちに合わせて コア原則 研究者管理の ORCID レコードは、研究者自身のみが作成できます。 ORCID ウェブサイトをご覧ください。
統合ワークフローの一環として、研究者は新しいものに登録できるようになります ORCID iD または、既存のレコードにサインインして、認証済みのレコードを収集できるようにします ORCID iD。 ご覧ください APIチュートリアル をご覧ください。
あなたの組織が ORCID メンバーの場合は、に連絡する必要があります ORCID あなたにアクセスを提供することができるあなたの組織の連絡先 ORCID メンバーポータル。 組織を特定できない場合 ORCID 連絡してから、コンソーシアムリードまたはエンゲージメントチームの担当者に連絡してください。
コミュニティからのフィードバックが大好きです。メンバーレポートについてフィードバックがあれば、次のアドレスまでご連絡ください。 https://support.orcid.org/hc/en-us/requests/new
メンバーおよび統合レポートの作成に使用されるデータは、毎日更新されます。