ORCID システムがに接続できるようにするいくつかのAPIを提供します ORCID レジストリ（読み取りと書き込みを含む） ORCID 記録。 一部のAPI関数は誰でも無料で利用できます（パブリックAPI）; その他は ORCID 会員組織（メンバーおよびプレミアムメンバーAPI）。 サンドボックステストサーバーで、誰でも自由にAPIをテストできます。
始める前に
統合計画を開始するときは、次のことを考慮する必要があります。
- あなたがしたいこと ORCID API-当社にアクセスしてください ワークフロー と 統合のベストプラクティス。 あなたが ORCID メンバー組織の場合は、弊社またはコンソーシアムのリーダーに問い合わせてサポートを受けることができます。
- すでにサポートしているシステムを使用しているかどうか ORCID。そうであれば、システムを設定して動作させるだけで済むかもしれません。 ORCID. ご確認ください ORCID 認定サービスプロバイダーリスト あなたのシステムが含まれているかどうかを確認するには
- 実施されている変更について研究者とどのようにコミュニケーションをとるか、研究者から何が必要か、彼らにとってのメリット、そして彼らが何をする必要があるか。 私たちをご覧ください アウトリーチリソース 新しい統合に関するコミュニケーションキャンペーンを構築する方法についてのアイデアについては、こちらのページをご覧ください。また、当社のウェビナー「会員になったら何をすればいいの？ ORCID'
サンドボックスのクレデンシャルに登録し、テストを作成します ORCID iD
カスタム統合を構築する場合、または認定されていないサービス プロバイダー アプリケーションを使用する場合は、まずサンドボックス環境を使用して統合を構築およびテストする必要があります。
また、ご購読はいつでも停止することが可能です サンドボックスメンバー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 メンバー API を使用して、ユーザーの情報を読み取り、追加、または更新できます。 ORCID 記録する場合は、研究者に許可を求めるだけです。
と対話する許可を要求するとき 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 メンバーのみ。
データを安全に保存できることを確認してください
システムが情報を保存できることが重要です 安全な方法で.
統合は、単なる保存以上のものを保存する必要があります ORCID 記録。 システムは次のことができる必要があります。
- 受け入れて保存する ORCID iD：システムは iD ORCID 表示するレコード iD 正しく更新するためには、トークン交換レスポンスで返される研究者の情報と一緒に保存してください。完全な https URI を保存することをお勧めします。 https://orcid.org/0000-0001-5727-2427.
- 永続的なものを受け入れて保存する アクセストークン と トークンを更新する：アクセストークンを使用して、レコードの読み取りと更新を行うことができます。また、 iD 認証されたアクセストークンは約20年間、またはユーザーが取り消すまで有効です。また、 トークンスコープ, トークンの有効期限 と トークンを更新するリフレッシュ トークンを使用すると、必要に応じて同じスコープまたは制限されたスコープを持つ新しいアクセス トークンを作成できます。アクセス トークンのトークン データを研究者の情報と一緒に保存します。
- 受け入れて保存する コードを入れる : 追加するすべてのアイテム ORCID レジストリは、プットコードとともに返されます。 ORCID API。この 6 桁の PUT コードをシステム内のアイテムと一緒に保存します。これにより、読み取り、更新、または削除する必要があるアイテムを識別できます。
- 対話が期待どおりに進まない場合は、エラーメッセージとサポート連絡先を提供します。
でチェックイン ORCID チームまたはコンソーシアムリーダーにアプリケーションの動作をデモンストレーションしてもらいます
統合を開始する前に ORCID 実稼働レジストリを使用する場合、当社のエンゲージメントチームまたはコンソーシアムリーダーが、サンドボックスで構築したものがすべて実稼働でも機能するかどうかを再確認します。 ORCID 認定サービスプロバイダーシステムでは、この手順は省略できます。 最小要件 メンバー API プロダクション認証情報を発行する前に満たす必要がある条件です。
会員組織の要請 ORCID 本番（ライブ）サーバーのメンバーAPIクレデンシャルは、 プロダクションメンバーAPIクライアントアプリケーションフォーム。 本番メンバーAPIクレデンシャルを発行する前に、 ORCID エンゲージメントチーム/コンソーシアムリーダーは、 ORCID サンドボックス。これにより、お客様が構築した優れた統合を確認し、ワークフローの改善を提案できるほか、すべての統合がベスト プラクティスとリリースの最小要件を満たしているかどうかを確認できます。
システムのデモを提供するには、 ORCID そのサンドボックス ORCID チームはプレビューできます。 作業中のサンドボックス統合を共有する方法はいくつかあります。
- 推奨： ライブデモ： ライブデモンストレーションをスケジュールするには、お問い合わせください統合のデモを行うために、画面を共有できる会議ソフトウェアを提供します。
- テストサイト： 開発サイトが公開されている場合は、 URLを送ってください システムにアクセスするためのテストクレデンシャル（必要な場合）およびシステムの使用方法を説明する手順 ORCID 特徴。 使用されているAPIバージョン、システムに保存されているデータなど、ユーザー側からは見えないものを確認するための追加のドキュメントを提供します。
- スクリーンキャストまたはスクリーンショット:記録またはスクリーンショットのセットを送信します ユーザーがアクセスを拒否したり、ID を切断した場合に何が起こるかなど、各ステップで統合がどのように機能するかを明確に説明し、実演する説明を添えてください。使用されている API バージョンやデータの保存方法など、ユーザー側からは確認できない事項を確認するための追加ドキュメントを必ず提供してください。
会員組織の要請 ORCID 本番（ライブ）サーバーのメンバーAPIクレデンシャルは、 プロダクションメンバーAPIクライアントアプリケーションフォームリストに載っていないベンダーシステムを使用している場合は、 ORCID 認定サービスプロバイダー統合には、次のことを保証するためのレビュープロセスが必要です。 統合の最小要件とベストプラクティス 満たされています。
認定されていないサービスプロバイダーに連絡して、最低基準を満たしていることの証拠を直接入手することができます。この証拠を ORCID エンゲージメント チームまたはコンソーシアム リーダー。
この証拠を共有する方法はいくつかあります。
- スクリーンキャストまたはスクリーンショット: ユーザーがアクセスを拒否したり、iD を切断した場合に何が起こるかなど、各ステップで統合がどのように機能するかを明確に説明および実証する録画またはスクリーンショットのセットを送信してください。使用されている API バージョンやデータの保存方法など、ユーザー側からは確認できない事項を確認するための追加ドキュメントを必ず提供してください。
- 公開されている統合ドキュメント: 各ステップで統合がどのように機能するかを明確に説明した、公開されている最新のリンクを送信してください。オプション 1 と同様に、使用されている API バージョンやデータの保存方法など、ユーザー側からは確認できない事項を確認するための追加ドキュメントを必ず提供してください。
メンバーAPI認証情報のリクエスト
統合がによってレビューされたら、メンバーAPIクレデンシャルを申請できます。 ORCID チームまたは ORCID 認定サービスプロバイダーシステム。
あなたは記入する必要があります クライアントアプリケーションを登録するためのフォーム。 以下は、要求されたフィールドの概要です。
組織名： きみの ORCID 会員組織名
資格情報の主な連絡先メールアドレス: このメールアドレスは、暗号化されたメールで認証情報をお送りしたり、統合に関して質問やエラーが発生した場合にご連絡するために使用します。
パスワード用の予備メールアドレス: 暗号化されたメールパスワードを送信できるメール アドレス。
顧客の名前: これはあなたになります ORCID メンバー組織名。統合が 1 つ以上ある場合は、名前にアプリケーションが追加されます。
アプリケーションのホームページの URL: ユーザー内の信頼できる組織のリストにリンクとして表示されます ORCID 信頼できるパーティのページ。 これは、組織またはアプリケーションのメインページに戻るリンクである必要があります。
クライアントアプリケーションの簡単な説明: このテキストは、認証画面で疑問符アイコンとともに統合ユーザーに表示されます。統合の簡単な説明が必要です。
URIのリダイレクト： ユーザーがアプリケーションを承認すると、指定したURIに返されます。 これらのURIを事前に提供する必要があります。そうしないと、統合ユーザーでエラーが発生します。
- HTTPSURIのみが受け入れられます。
- 登録されたドメインは、サブドメインを含め、使用されているドメインと完全に一致する必要があります。
- 可能な場合は、すべてのリダイレクト URI を完全に登録します。
- 5つ以上のリダイレクトURIが必要ですか？ の注記にこれを示してください ORCID スタッフ。
の注意事項 ORCID スタッフ：このフィールドを使用して ORCID スタッフはあなたのリクエストや統合について何か追加の情報を知ることができます
アプリケーションをに転送します ORCID プロダクションレジストリ
認証情報を取得したら、統合を公開する準備が整います。公開前に統合をテストしたい場合は、テスター自身の ORCID 記録または同僚の ORCID 記録。
起動し、全員に知らせます
アプリケーションをライブにすることは最後のステップではありません。ユーザーが接続することを知ってもらうために、ユーザーとのコミュニケーションを継続する必要があります。 ORCID iD システムにすばやく簡単に。 効果的な統合には、技術的要素（このガイドで説明）と社会的要素の両方が含まれます。 研究者は何について知らされる必要があります ORCID は、なぜあなたは彼らへのアクセスを要求しているのですか ORCID 記録し、そのデータをどうするか。
- コミュニケーションのタイムラインを作成する：利害関係者があなたのことを認識していることを確認します ORCID 起動するかなり前にプロジェクトを作成します。
- トップダウン通信とボトムアップ通信を組み合わせて使用します。
- あなたを宣伝する ORCID 頻繁に、さまざまな対象者に統合します。
- ローカルリソースを作成する FAQ、libguides、Webページ、チュートリアル、ビデオなどのユーザーをサポートするため。
- 地域の担当者を指名する ORCID関連する質問。
ご不明な点がございましたら、担当のエンゲージメントリーダーまたはコンソーシアムリーダーにお問い合わせください。
ソーシャルコンポーネントをサポートするために、次のツールキットを提供しています。 アウトリーチリソース 統合をサポートするキャンペーンの開発を支援し、研究者とコミュニケーションをとるには、次のようにします。
- この試験は ORCID です。
- システムがiDを収集する理由と、システムがレコードの更新などのタスクを実行する方法。
- 研究者が作成することで利益を得る理由 ORCID iD そして彼らのiDをあなたのシステムに接続します。
- 認定条件 ORCID より広いグローバルな研究コミュニティに利益をもたらします。
コミュニティからのフィードバックに基づいて、このリソースの「ライブラリ」を継続的に構築していきます。 見たいものがありましたら、お気軽にお問い合わせください。