のアクセス ORCID パブリックAPIには、クライアントIDとクライアントシークレットからなる認証情報が必要です。このガイドでは、認証情報を取得するために必要な手順について説明します。 ORCID パブリックAPIクレデンシャル。 ORCID メンバーの資格情報を代わりに使用できるため、メンバーはパブリックAPIに登録する必要はありません。 メンバーの資格情報を登録するには、を参照してください。 クライアントアプリケーションを登録する.
パブリックAPIクレデンシャルは、個人のクレデンシャルに関連付けられています ORCID 記録し、他の人に譲渡することはできません。 に同意する必要があります パブリッククライアント利用規約 クレデンシャルが発行される前。
組織のAPIクレデンシャルは、サポートする組織が利用できます ORCID 有料会員サブスクリプションを通じて。 詳細については、こちらから ORCID メンバーシップ.
開発者は、パブリックAPIをテストすることをお勧めします。 サンドボックス テスト サーバー 製品版を使用する前に。
開発者は、パブリック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 使用している API に応じて、異なる API 使用量クォータとレート制限をサポートします。
| API | 匿名API | パブリック（登録済み）API | メンバーAPI |
| レート制限 | 12 リクエスト/秒40 バースト/秒 | 12 リクエスト/秒40 バースト/秒 | 24 リクエスト/秒40 バースト/秒 |
| 使用量制限 | 50 回/日 (IPアドレスごと) | 100 回/日 (クライアントIDごと) | 使用量制限なし |
2番目のリクエスト 1 秒間に実行できるリクエストの数です。
バースト 拒否する前にキューに入れることができるリクエストの数です。キュー内のリクエストは、503 秒あたりのリクエスト数まで減速されます。バーストを超えると、XNUMX 応答が返されます。
使用量の割り当てを超過した場合、一定期間内にそれ以上のリクエストを行うことはできなくなります。
覚えておいてください。 ORCID パブリックAPIは、以下の通り、個人による非商用利用は無料です。 パブリックAPI利用規約「非営利」とは、パブリック API に対して再利用料金を請求したり、収益を生み出す製品やサービスに関連してパブリック API を使用したりできないことを意味します。
クライアント認証情報を使用してパブリックAPIを使用すると、匿名APIよりも高い使用割り当てを統合に使用できます。 統合ガイド パブリック API クライアントを登録する方法について説明します。
パブリックAPIのAPI使用クォータを定期的に超過している場合は、 ORCID 会員登録して メンバーAPIより高いレート制限と無制限の使用クォータにアクセスできるだけでなく、信頼できるパーティデータにアクセスできるようになります。 ORCID 記録し、データを提供する ORCID ユーザーの許可を得て、組織のシステムから記録を取得します。