Knowledge Base API をテストしたり、アプリケーションに接続したりするために必要な認証を設定します。
Knowledge Base API リクエストでは、ベアラートークン認証を使用します。短期間のテストには認証済みユーザートークンを使用するか、アプリケーションや統合のためにテクニカルアカウントを設定してください。
はじめる前に
以下を確認してください。
- 組織が Knowledge Base にアクセスできること。
- ワークフローに必要な API リソースにアクセスできること。
- アプリケーション統合を設定する場合は、Adobe Developer Console にアクセスできること。
API アクセスは Knowledge Base の権限を上書きしません。認証された ID は、アプリケーションによってリクエストされるコレクション、文書、操作にアクセスできる必要があります。
認証方法を選択
開発ステージに適した認証方法を使用してください。
| 使用例 | 認証 |
|---|---|
| テストリクエストの送信または API の探索 | 認証済みユーザーベアラートークン |
| アプリケーションまたは統合を作成 | 技術アカウント |
ユーザーベアラートークン
認証済みユーザーベアラートークンは、API リファレンスを通じて行われるリクエストを含む API リクエストのテストに役立ちます。
このトークンはサインインしたユーザーを表し、24 時間有効です。このトークンで行われるリクエストは、そのユーザーが利用できるのと同じ Knowledge Base アクセス権を持ちます。
ユーザーベアラートークンの取得後、各リクエストに含めます。
認証：ベアラー <アクセストークン>
インタラクティブな Knowledge Base API リファレンスでトークンを使用して、利用可能なエンドポイントをテストすることもできます。
既にアクセス権のあるリソースを取得する操作から始めてください。回答が成功すると、トークンが受け入れられ、認証された ID がそのリソースにアクセスできることが確定します。
ユーザーベアラートークンを中心とした永続的なアプリケーション統合は作成しないでください。
技術アカウント
インタラクティブユーザーセッションなしで認証する必要があるアプリケーションと統合には、テクニカルアカウントを使用してください。
テクニカルアカウントは Adobe Developer Console で設定されます。テクニカルアカウントのセットアップ手順に従って、アプリケーションに必要な資格情報を作成してください。
テクニカルアカウントを作成した後、このページに戻って Knowledge Base API へのアクセスを検証してください。
API 権限を理解する
認証により、API リクエストを行う ID が確立されます。認証により、その ID で実行できることが決まります。
たとえば、認証された ID は 1 つのコレクションを取得できても、別のコレクションは取得できない場合や、管理者レベルのリソースにアクセスできない場合があります。
認証が成功してもオペレーションが却下された場合は、回答を認証失敗として扱う前に、認証された ID が要求されたリソースにアクセスする権限を持っているかどうかを確認してください。
API アクセスの検証
認証が設定されたら：
- アクセストークンを取得します。
- 認証された ID がアクセスできるリソースにリクエストを送信します。
- API が予期される回答を返すことを確認します。
- API 入門ワークフローを続けます。
