ORCID システムがに接続できるようにするいくつかのAPIを提供します ORCID レジストリ（読み取りと書き込みを含む） ORCID 記録。 一部のAPI関数は誰でも無料で利用できます（パブリックAPI）; その他は ORCID 会員組織（メンバーおよびプレミアムメンバーAPI）。 サンドボックステストサーバーで、誰でも自由にAPIをテストできます。
あなたが始める前に
統合計画を開始するときは、次のことを考慮する必要があります。
- あなたがしたいこと ORCID API-当社にアクセスしてください ワークフロー.
- あなたの組織が すでに ORCID メンバー または XNUMXつになることを計画している。 それだけ ORCID メンバーはアイテムを追加できます ORCID レコード。
- すでにサポートしているシステムを使用しているかどうか ORCID。 もしそうなら、それはあなたのシステムを操作するように設定するのと同じくらい簡単かもしれません ORCID.
- 実施されている変更について研究者とどのようにコミュニケーションをとるか、研究者から何が必要か、彼らにとってのメリット、そして彼らが何をする必要があるか。 私たちをご覧ください アウトリーチリソース 新しい統合に関するコミュニケーションキャンペーンを構築する方法に関するアイデアのページ。
サンドボックスのクレデンシャルに登録し、テストを作成します ORCID iD
最初に、相互作用するツールを作成する必要があります が待 ORCID サンドボックス テスト中、または独自のシステムで本番レジストリのデータに影響を与えないようにするため。
また、ご購読はいつでも停止することが可能です サンドボックスメンバーAPIクレデンシャルをリクエストする アプリケーションをビルドしてテストします。 これらのクレデンシャルを使用すると、サンドボックスメンバーAPIを呼び出して、読み取り、書き込み、更新を行うことができます。 ORCID 記録。 サンドボックステスト環境へのアクセスは、あなたがそうでなくても、誰でも自由に利用できます。 ORCID メンバー組織。
注意:：すでにサポートしているサードパーティシステムを使用している場合 ORCID、サンドボックスAPIクレデンシャルを登録する必要がない場合があります。
サンドボックスを使用すると、ライブ（本番）のデータに影響を与えることを心配することなく、テストユーザーアカウントを作成して統合を開発できます。 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 記録—研究者に許可を求める必要があります。 必要なスコープは、システムに最適な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で使用できます。
/ webhook
このスコープにより、クライアントアプリケーションはWebhookを ORCID レコード、レコードが更新されたときに通知を受信するため。 このスコープはプレミアムで利用可能です ORCID メンバーのみ。 プレミアムメンバーではないが、開発者のサンドボックスでこの機能をテストしたい場合は、 接触 ORCID コミュニティ.
- 過去には ORCID 現在サポートされている他のスコープをサポート 段階的に廃止.
- あなたは見つけることができます ここで特定のセクションを追加または更新するために必要なスコープ.
データを安全に保存できることを確認してください
システムが情報を保存できることが重要です 安全な方法で.
統合は、単なる保存以上のものを保存する必要があります ORCID 記録。 システムは次のことができる必要があります。
- 受け入れて保存する ORCID iD：システムは iD ORCID 更新するレコード。 研究者の情報と一緒に保管してください。 完全なhttpsURIを保存することをお勧めします。 https://orcid.org/0000-0001-5727-2427.
- 永続的なものを受け入れて保存する アクセストークン や トークンを更新する：アクセストークンを使用して、レコードの読み取りと更新を行うことができます。また、 iD 認証済みです。 永続的なトークンは、約 20 年間、またはユーザーがトークンを取り消すまで有効です。 リフレッシュ トークンを使用して、同じスコープまたは制限されたスコープを持つ新しいアクセス トークンを作成できます。 トークンは研究者の情報と一緒に保管してください。 の保管もお勧めします。 トークンスコープ、 そしてその、トークンの有効期限.
- 受け入れて保存する コードを入れる （更新する場合 ORCID レコード）：追加するすべてのアイテム ORCID レジストリは、プットコードとともに返されます。 ORCID API。 この put コードを項目とともにシステムに保存します。これにより、読み取りまたは更新が必要な項目を特定できます。
- ログの相互作用：システムは、に対して行われた両方の呼び出しを記録する必要があります ORCID APIと受信した応答。 これは必要なので ORCID 問題が後で発生した場合に役立ちます。
- 対話が期待どおりに進まない場合は、エラーメッセージとサポート連絡先を提供します。
でチェックイン ORCID アプリケーションがどのように機能するかを示すチーム
統合を開始する前に ORCID 本番レジストリでは、エンゲージメントチームが、サンドボックス上に構築したすべてのものが本番でも機能することを再確認します。 内蔵のシステムを使用している場合 ORCID サポートの場合、このステップはスキップできる場合があります。
会員組織の要請 ORCID 本番（ライブ）サーバーのメンバーAPIクレデンシャルは、 プロダクションメンバーAPIクライアントアプリケーションフォーム。 本番メンバーAPIクレデンシャルを発行する前に、 ORCID エンゲージメントチームは、統合のデモを確認します。 ORCID サンドボックス。 これにより、構築した優れた統合を確認し、ワークフローの改善を提供し、すべての統合がベストプラクティスを満たしていることを確認する機会が得られます。
システムのデモを提供するには、 ORCID そのサンドボックス ORCID チームはプレビューできます。 作業中のサンドボックス統合を共有する方法はいくつかあります。
- 推奨： ライブデモ： ライブデモンストレーションをスケジュールするには、お問い合わせください. 統合のデモを行うために、画面を共有できる会議ソフトウェアを提供します。 これにより、システムがどのように機能するか、およびシステムの利点をどのように説明しているかについて、さらに学ぶ機会が得られます。 ORCID 統合により、お客様とお客様のユーザーにより良いサポートを提供できます。
- テストサイト： 開発サイトが公開されている場合は、 URLを送ってください システムにアクセスするためのテストクレデンシャル（必要な場合）およびシステムの使用方法を説明する手順 ORCID 特徴。 使用されているAPIバージョン、システムに保存されているデータなど、ユーザー側からは見えないものを確認するための追加のドキュメントを提供します。
- スクリーンキャストまたはスクリーンショット（ ORCID-デモンストレーションが必要な対応システム）： 記録またはスクリーンショットのセットを送信します ユーザーがアクセスを拒否した場合や iD を切断した場合に何が起こるかなど、各ステップで統合がどのように機能するかを明確に説明し、実演する説明が含まれています。 使用されている API のバージョンやデータの保存方法など、ユーザー側からは確認できないことを確認するために、必ず追加のドキュメントを提供してください。
のいずれかを使用している場合 ORCID-デモンストレーションを必要としない対応システム、直接できます 本番メンバーのAPIクレデンシャルをリクエストする。 使用しているシステム（および該当する場合はバージョン）をメモで必ず指定してください。
すべてのメンバー統合が満たすことが期待される多くの要件があります。 ザ・ ORCID チームは、統合レビュープロセスの一環として、これらの要件が満たされていることを確認します。
- OAuth 認証する ORCID iD（ユーザーが検索または入力することを許可しない ORCID iD。）
- 含む ORCID ブランドのボタンまたはリンク iDの認証を開始するためにあなたのサイトで。
- に従ってOAuth認証画面を表示します ガイドライン
- サイトのリダイレクトURIなどにHTTPSを使用する ORCID API呼び出し
- トークン交換で返されたすべてのデータを、ユーザーのデータと一緒に受け入れてシステムに保存します
- 適切に使用する スコープ や リクエストメソッド （たとえば、新しい情報を追加するためのPOST呼び出し、および既存の情報を更新するためのPUT呼び出し）
- 認証済みを公開表示 ORCID iD。 iDは次のように表示する必要があります 商標および iD ガイドラインを表示します。
本番サーバーでクレデンシャルを要求する
統合がによってレビューされたら、メンバーAPIクレデンシャルを申請できます。 ORCID チームまたは組み込みのサービスプロバイダーシステムを使用している場合 ORCID 統合。
あなたは記入する必要があります クライアントアプリケーションを登録するためのフォーム。 以下は、要求されたフィールドの概要です。
の注意事項 ORCID スタッフ：このフィールドを使用して ORCID ベンダーシステムを使用しているかどうか、統合がレビューされているかどうかなどを確認します。
連絡先メールアドレス：このアドレスにクレデンシャルを送信します。 これは、統合に関して私たちが取り組んできた連絡先、またはお客様の組織のために保持している技術的な連絡先である必要があります。
クレデンシャルにアクセスするためのPINを受け取るための連絡先：完全な資格情報を安全な方法で送信します。 この連絡先にAPIクレデンシャルにアクセスするためのパスコードを送信します。 これは、リストされている前の連絡先とは別の連絡先である必要があります。
クライアントアプリケーションの簡単な説明：このテキストは、統合ユーザーに対して疑問符アイコン付きの認証画面に表示されます。 統合の簡単な説明が必要です。
アプリケーションのホームページのURL：ユーザー内の信頼できる組織のリストにリンクとして表示されます ORCID 信頼できるパーティのページ。 これは、組織またはアプリケーションのメインページに戻るリンクである必要があります。
クライアントのOAuth2リダイレクトURIまたはコールバックURL：ユーザーがアクセスを承認した後にユーザーが戻るWebアプリケーションで許可されているURL ORCID データを記録します。 本番（ライブ）サーバークライアントの場合、すべてのリダイレクトURIはHTTPSである必要があります。
リクエストを行うと、手動プロセスでクレデンシャルが発行され、クライアントにメールが届きます iD とクライアントの秘密。 通常、これらのリクエストは48時間以内に処理されます。
アプリケーションをに転送します ORCID プロダクションレジストリ
クレデンシャルを取得したら、それを公開する準備が整います。 統合が一般に公開される前にテストしたい場合は、テスター独自のものを使用してください ORCID 記録または同僚の ORCID 記録。
起動し、全員に知らせます
アプリケーションをライブにすることは最後のステップではありません。ユーザーが接続することを知ってもらうために、ユーザーとのコミュニケーションを継続する必要があります。 ORCID iD システムにすばやく簡単に。 効果的な統合には、技術的要素（このガイドで説明）と社会的要素の両方が含まれます。 研究者は何について知らされる必要があります ORCID は、なぜあなたは彼らへのアクセスを要求しているのですか ORCID 記録し、そのデータをどうするか。
- コミュニケーションのタイムラインを作成する：利害関係者があなたのことを認識していることを確認します ORCID 起動するかなり前にプロジェクトを作成します。
- トップダウン通信とボトムアップ通信を組み合わせて使用します。
- あなたを宣伝する ORCID 頻繁に、さまざまな対象者に統合します。
- ローカルリソースを作成する FAQ、libguides、Webページ、チュートリアル、ビデオなどのユーザーをサポートするため。
- 地域の担当者を指名する ORCID関連する質問。
ソーシャルコンポーネントをサポートするために、次のツールキットを提供しています。 アウトリーチリソース 統合をサポートするキャンペーンの開発を支援し、研究者とコミュニケーションをとるには、次のようにします。
- この試験は ORCID です。
- システムがiDを収集する理由と、システムがレコードの更新などのタスクを実行する方法。
- 研究者が作成することで利益を得る理由 ORCID iD そして彼らのiDをあなたのシステムに接続します。
- 認定条件 ORCID より広いグローバルな研究コミュニティに利益をもたらします。
コミュニティからのフィードバックに基づいて、このリソースの「ライブラリ」を継続的に構築していきます。 見たいものがありましたら、お気軽にお問い合わせください。