認証用のAPIキーとベアラートークンの生成

プロジェクト内のデータやアセットをプログラムで操作するには、 watsonx リソースへのアクセス権限を証明するために認証を行う必要があります。

手順

ほとんどのAPIメソッドでは、APIリクエストにアクセス トークンとしてIdentity and Access Management（IAM）ベアラ トークンを含める必要があります。 クラウドアカウントのAPIキーを使用して、IAMベアラートークンを生成してください。

API認証情報を生成するには、次の手順を完了してください：

  1. API キーを作成します。

    IBM Cloud の watsonx アカウントで、ナビゲーションメニューから [管理 ] > [アクセス (IAM) ] > [ IBM Cloud IAM にリダイレクト] > [API キー ] を選択し、 [作成 + ] をクリックします。詳細については、 IBM Cloud API キーを参照してください。

    重要： セキュリティ上の理由により、APIキーは作成時のみコピーまたはダウンロードが可能です。 APIキーは記録のために保存してください。

    AWS アカウントで、ナビゲーションメニューから「 管理 」＞「 アクセス（IAM）」 ＞「 個人用アクセスキー 」を選択し、 「作成 + 」をクリックします。

  2. APIキーを使用してIAMベアラートークンを作成します。

    IBM Cloud の場合、次のコマンドを実行してください:

    curl -X POST \
--url https://iam.cloud.ibm.com/identity/token \
--header "Content-Type: application/x-www-form-urlencoded" \
--data "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=${APIKEY}"

    AWS の場合、次のコマンドを実行してください:

    curl --request POST \
--url https://<region>.aws.data.ibm.com/api/rest/mcsp/apikeys/token \
--header 'Content-Type: application/json' \
--data '{
   "apikey": "${APIKEY}"
}'

    GovCloud データセンター内の AWS アカウントに対して、次のコマンドを実行します:

    curl --request POST \
--url https:///dai.ibmforusgov.com/api/rest/mcsp/apikeys/token \
--header 'Content-Type: application/json' \
--data '{
   "apikey": "${APIKEY}"
}'

    レスポンスの access_token フィールドからIAMベアラートークンを取得する。 ベアラートークンを使用して、 watsonx API への認証を行うことができます。

    重要： ベアラートークンが期限切れになった場合、トークンを再作成して更新する責任はあなたにあります。

次のタスク

REST APIリクエストを送信する際、認証ヘッダーに生成されたIAMベアラートークンを指定することで、APIエンドポイントを呼び出すことができます。具体的には以下の通りです：

curl -X POST "https://<region>.<cloud-provider-domain>/<api-endpoint>" --header "Authorization: Bearer ${TOKEN} ..."

呼び出すAPI <cloud-provider-domain> エンドポイントに基づいてを設定し、アカウントで利用可能な地理的位置の URL に <region> 設定します。

watsonx API のクラウドプロバイダーのドメインおよび地理的位置に関する詳細については、API ドキュメントを参照してください。 利用可能なAPIとSDK をご覧ください。