レジストリとAPIで説明的なエラーメッセージを提供するために最善を尽くします。 発生する可能性のあるエラーを解決するためのヒントをいくつか紹介します。
APIエラー
APIエラーコードには、簡単に理解できる説明メッセージが含まれています。
XML / JSONフォーマットエラー
追加または更新しようとしているデータのフォーマットに問題がある場合 ORCID 記録、次の方法で例を参照することをお勧めします。
- レコードまたは個々のアイテムを読み取るための呼び出しを送信して、XML / JSONの例を受け取るか、レコードを更新する場合は、更新するアイテムの完全なXML / JSONを送信し、これを開始点として使用します
- 私たちのコンサルティング サンプルXMLおよびJSONファイル GitHubリポジトリに—投稿用のクリーンなXML / JSONと、読み取り例用の完全なXML / JSONの両方があります
にアイテムを追加する前に ORCID データをフォーマットする必要があるレコード ORCID スキーマ。 でデータをフォーマットします ORCID XMLまたはJSONのメッセージスキーマ。
GitHubリポジトリには、で新しいアイテムを作成するときにフォーマットするのに役立つリソースが含まれています ORCID 記録し、上の既存のアイテムを読むとき ORCID 記録：
API のバージョンが異なれば、メッセージ形式も異なることに注意してください。 バージョン2.0および2.1のスキーマと例も利用できます.
十分に入力されたレコードのメタデータを読み取ることで、より多くの例を簡単に見つけることができます。
0
0
スコープエラー
スコープに関連するエラーが発生した場合は、次のことをお勧めします。
- パブリックAPIクライアントでメンバースコープを使用していないことを確認してください。
- アクションを実行するための正しいスコープを持っている限定された可視性データを追加、更新、または読み取る場合。
- 2本足のOAuthを使用して3本足のスコープをリクエストしていないことを確認してください。その逆も同様です。
と対話する許可を要求するとき ORCID ユーザーのレコードでは、XNUMX つ以上の「スコープ」を指定します。 各スコープでは、レコードの読み取りや特定のセクションの更新など、特定の操作を行うことができます。
3本足（認証コード）スコープ
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 メンバーのみ。
0
4
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 |
2
7
レジストリエラーメッセージ
通常、ユーザーは、アプリケーションとの接続を承認するときに、API関連のエラーをいくつか発生させるだけです。
リダイレクトURIが正しくありません
リダイレクトURIが登録済みのリダイレクトURIと一致しません。
このエラーメッセージは、認証リンクがAPIクライアントの資格情報に登録していないリダイレクトURIを指定していることを示しています。 パブリックAPIを使用している場合は、これを自分で修正できます。 開発者ツール。 メンバーAPIを使用している場合は、 ORCID エンゲージメントチームがクレデンシャルを更新します。
OAuth認証フォームへのリンクが正しくありません
リクエストされたページが見つかりません。 このページをブックマークしている場合は、削除してください。 リンクをたどった場合は、報告してください。
このエラーは、OAuth認証リンクが不適切に形成されている場合に発生する傾向があります。 https://orcid.org/signin/oauth/authorize?[….] https://orcid.org/oauth/authorize?[…]。 解決するには、リンクを修正するだけです。
説明のないメッセージ
サーバーに問題があります。 この問題が解決しない場合は、サポートに連絡してください。
このエラーは、スコープが指定されていない場合に最も頻繁に発生します。 OAuth認証リンクにスコープを含める必要があります。 最小スコープは/ authenticateです。
チェックする ORCID 仕事中！
非常にまれですが、エラーが問題であると思われる場合は、 ORCID 確認できるサーバー http://status.orcid.org/
なお、 ORCID Sandboxにはサービスレベル契約がなく、コードの更新をリリースするときに20分間ダウンする可能性があります。
ヘルプの入手
いつでも喜んでお手伝いさせていただきます！ ORCID メンバー組織は得ることができます からのサポート ORCID 直接。
すべてのインテグレーターも参加することをお勧めします ORCID APIユーザーグループ、他のインテグレーターやAPIユーザー、および ORCID チーム。