ベンダーシステムは、クライアントに既成のものを提供できます ORCID 統合、彼らに彼らの完全な利点を提供します ORCID 独自の統合を構築する必要なしにメンバーシップ。 このワークフローは、を構築するための全体的なガイドラインの概要を示しています ORCID 顧客にソフトウェアを提供するベンダーとしての統合。 あなたを構築するとき ORCID 統合あなたはあなたの統合があなたの顧客が満たすことができることを確実にする必要があるでしょう メンバーAPIクレデンシャルを発行するための要件 、および統合のベストプラクティスに従います。
- ブランド ORCID 個人のOAuthプロセスを使用して、所属や貢献に正しく関連付けられていることを確認するiD。
- ディスプレイ 表示ガイドラインに従ってシステム内で公開されている認証済みiDは、システムが配管されて使用をサポートしていることを研究者に通知します。 ORCID.
- お問合せ システムからユーザーのデータ ORCID 記録。顧客は必要に応じて研究者の記録を更新できます。
- 収集します ユーザーのデータ ORCID システムまたはフォーム内にデータを入力するのに役立つ記録。
- 同期します システムのデータと ORCID 双方向の情報フローを介したレジストリ。
開発を開始する前に、エンゲージメント リードに連絡して統合計画について話し合うことをお勧めします。
システム設定
に接続するすべてのシステム ORCID 保存する必要があります ORCID 収集されたiDとアクセストークン、およびから読み取った情報を保存することもできます ORCID 記録。
- 認証されたiDを保存します。 システムは、受け入れて保存できる必要があります ORCID ユーザーの情報と一緒にiD。
- 交換認証コード： システムは、XNUMX桁の認証コードをキャプチャして、すぐにアクセストークンと交換できる必要があります。
- トークン応答を保存します。 システムは、受け入れて保存できる必要もあります ORCID iD およびアクセストークン。 以下を含む完全なトークン応答をユーザーの情報と一緒に保存することをお勧めします。
- 永続的なアクセストークン
- トークンを更新する
- 要求されたスコープ
- スコープの有効期限
- データを書き込むときに保存するアイテム： システムがデータを書き込む場合 ORCID 記録：
- システムは保存できる必要があります コードを入れる に追加されたアイテムごとに ORCID レコード（およびグループ ID ピアレビュー用）。 プットコードは、内のアイテムの一意の識別子です ORCID レジストリ。
- システムは、XMLまたはJSONでフォーマットされたデータを送信できる必要があります。 ORCID メッセージスキーマ.
- ログの相互作用：システムは、に対して行われた両方の呼び出しを記録する必要があります ORCID 受け取ったAPIと応答。 これは、後で問題が発生した場合にチームが支援できるようにするために必要です。 理想的には、クライアントもこれらのログを読み取って共有できる必要があります。
- APIの選択：システムでは、クライアントがパブリックAPIクレデンシャルとメンバーAPIクレデンシャルのどちらを使用しているかを選択できるようにする必要があります（システムで両方が許可されている場合）。
- データのエクスポート：システムは、クライアントが保存されたものをエクスポートする方法を提供する必要があります ORCID iDとトークン交換データ（アクセストークン、更新トークン、スコープ、スコープの有効期限）。 システムがデータも書き込む場合は、データのエクスポートに関連するプットコードも含める必要があります。
ORCID APIクレデンシャル
ORCID データを要求する組織、つまりクライアントが独自のデータを使用する必要があります ORCID APIクレデンシャル。 これは、誰が更新へのアクセスを要求しているかを明確に示しています ORCID 記録し、によって必要とされます ORCIDの会員契約。 組織は取得する必要があります ORCID 独自のAPIクレデンシャル。 組織がシステムを管理するのを支援していて、そのAPIクレデンシャルがリダイレクトURIの更新などの変更を必要とする場合、組織は変更の要求を送信する必要があります。
あなたのシステムについて教えてください
システムをリリースする準備ができたら、 弊社までお問い合わせください。 プロセスを開始します。 知っておく必要があります：
- システムの名前と開発者の名前。
- その機能と接続方法の簡単な説明 ORCID レジストリ。
- 統合レビューの可用性。これにより、 ORCID メンバーは、APIクレデンシャルを受け取る前に完全な統合レビューを受ける必要があります。また、システムがメンバーがCollect＆Connectを満たすのにどのように役立つかを確認する必要があります。
- 組織がシステムについて詳しく知ることができるように、組織を参照できるページ、プレゼンテーション、および/またはデモシステムへのリンク。
- APIユーザーリストに参加するために招待したり、直接連絡したりできる技術的および管理上の連絡先。これにより、クライアントに最新の機能を提供できます。