文件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引數來設定您目的地的驗證資訊。
閱讀客戶驗證組態，以取得支援的驗證型別的詳細資訊。

只有在Adobe和您的目的地平台之間有全域驗證系統，且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}

以下兩個要求會擷取您IMS組織的所有認證設定，或特定的認證設定，端視您是否在要求中傳遞INSTANCE_ID引數而定。

選取下方的每個索引標籤以檢視對應的裝載。

擷取所有認證設定
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
回應

成功的回應會根據您使用的IMS Org ID和沙箱名稱，傳回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"
   }
},
{
   "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