ドキュメントExperience Platform宛先ガイド

資格情報設定の取得

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

  • 管理者
  • ユーザー
IMPORTANT
API エンドポイント：platform.adobe.io/data/core/activation/authoring/credentials

このページでは、/authoring/credentials API エンドポイントを使用して、資格情報設定を取得するために使用できる API リクエストおよびペイロードの例を示します。

/credentials API エンドポイントを使用するタイミング when-to-use

IMPORTANT
ほとんどの場合、/credentials API エンドポイントを使用する必要は​ ありません。代わりに、/destinations エンドポイントの customerAuthenticationConfigurations パラメーターを介して宛先の認証情報を設定できます。
サポートされる認証タイプについて詳しくは、顧客認証設定を参照してください。

アドビと宛先プラットフォームとの間にグローバル認証システムがあり、Platform の顧客が宛先への接続に認証資格情報を提供する必要がない場合にのみ、この API エンドポイントを使用して資格情報設定を作成します。この場合、/credentials API エンドポイントを使用して、資格情報設定を作成する必要があります。

グローバル認証システムを使用する場合、新しい宛先設定を作成する際に、宛先配信設定で "authenticationRule":"PLATFORM_AUTHENTICATION" を設定する必要があります。

IMPORTANT
Destination SDK でサポートされているすべてのパラメーター名および値は、大文字と小文字が区別 ​されます。大文字と小文字を区別することに関するエラーを避けるために、ドキュメントに示すように、パラメーター名および値を正確に使用してください。

資格情報 API 操作の概要 get-started

続行する前に、「はじめる前に」を参照し、API の呼び出しを正常に行うために必要となる重要な情報（必要な宛先オーサリング権限および必要なヘッダーの取得方法など）を確認してください。

資格情報設定の取得 retrieve

/authoring/credentials エンドポイントに GET リクエストを行うことで、既存の資格情報設定を取得できます。

API 形式

以下の API 形式を使用して、お使いのアカウントに関するすべての資格情報設定を取得します。

GET /authoring/credentials

以下の API 形式を使用して、{INSTANCE_ID} パラメーターで定義された、特定の資格情報設定を取得します。

GET /authoring/credentials/{INSTANCE_ID}

以下の 2 つのリクエストは、リクエストで INSTANCE_ID パラメーターを渡すかどうかに応じて、お客様の IMS 組織に対するすべての資格情報設定か、特定の資格情報設定を取得します。

以下の各タブを選択して、対応するペイロードを表示します。

すべての資格情報設定の取得
accordion
リクエスト
code language-shell 
curl -X GET https://platform.adobe.io/data/core/activation/authoring/credentials \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
accordion
応答

応答が成功すると、HTTP ステータス 200 が、使用した IMS Org ID およびサンドボックス名に基づいた、アクセス権のある資格情報設定のリストと共に返されます。1 つの instanceId は、1 つの資格情報設定に対応します。

code language-json 
{
   "instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
   "createdDate":"2021-06-07T06:41:48.641943Z",
   "lastModifiedDate":"2021-06-07T06:41:48.641943Z",
   "type":"s3Authentication",
   "name":"yourdestination",
   "s3Authentication":{
      "accessId":"string",
      "secretKey":"string"
   }
},
{
   "instanceId":"a25bffa0-3127-4030-895d-1d1236bb3680",
   "createdDate":"2022-06-07T06:41:48.641943Z",
   "lastModifiedDate":"2022-08-07T06:41:48.641943Z",
   "type":"basic",
   "name":"yourdestination",
   "s3Authentication":{
      "url":"string",
      "username":"string",
      "password":"string"
   }
}
特定の資格情報設定の取得
accordion
リクエスト
code language-shell 
curl -X GET https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
table 0-row-2 1-row-2
パラメーター 説明
{INSTANCE_ID} 取得する資格情報設定の ID。
accordion
応答

応答が成功すると、HTTP ステータス 200 が、リクエストで提供された instanceId に対応する資格情報設定の詳細と共に返されます。

code language-json 
{
   "instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
   "createdDate":"2021-06-07T06:41:48.641943Z",
   "lastModifiedDate":"2021-06-07T06:41:48.641943Z",
   "type":"s3Authentication",
   "name":"yourdestination",
   "s3Authentication":{
      "accessId":"string",
      "secretKey":"string"
   }
}

API エラー処理 error-handling

Destination SDK API エンドポイントは、一般的な Experience Platform API エラーメッセージの原則に従います。Platform トラブルシューティングガイドの API ステータスコードおよびリクエストヘッダーエラーを参照してください。

次の手順 next-steps

このドキュメントでは、/authoring/credentials API エンドポイントを使用した、資格情報設定に関する詳細の取得方法を確認しました。この手順が宛先設定プロセスのどこに当てはまるかを把握するには、Destination SDK を使用した宛先の設定方法を参照してください。

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6