文件 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，包括如何取得必要的目的地撰寫許可權和必要的標頭。

建立認證設定 create

您可以對/authoring/credentials端點發出POST要求，以建立新的認證組態。

API格式

POST /authoring/credentials

以下要求會建立新的認證設定，由承載中提供的引數定義。

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

基本

建立基本認證組態

accordion

要求

code language-shell

curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
    "basicAuthentication":{
      "url":"string",
      "username":"string",
      "password":"string"
   }
}

table 0-row-3 1-row-3 2-row-3 3-row-3 layout-auto
參數	類型	說明
`url`	字串	授權提供者的URL
`username`	字串	認證組態登入使用者名稱
`password`	字串	認證組態登入密碼

accordion
回應
成功的回應會傳回HTTP狀態200以及您新建立的認證組態的詳細資料。

Amazon S3

建立Amazon S3認證組態

accordion

要求

code language-shell

curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "s3Authentication":{
      "accessId":"string",
      "secretKey":"string"
   }
}

table 0-row-3 1-row-3 2-row-3 layout-auto
參數	類型	說明
`accessId`	字串	Amazon S3存取識別碼
`secretKey`	字串	Amazon S3秘密金鑰

accordion
回應
成功的回應會傳回HTTP狀態200以及您新建立的認證組態的詳細資料。

SSH

建立SSH認證組態

accordion

要求

code language-shell

curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
    "sshAuthentication":{
      "username":"string",
      "sshKey":"string"
   }
}

table 0-row-3 1-row-3 2-row-3 layout-auto
參數	類型	說明
`username`	字串	認證組態登入使用者名稱
`sshKey`	字串	使用SSH驗證的SFTP的SSH金鑰

accordion
回應
成功的回應會傳回HTTP狀態200以及您新建立的認證組態的詳細資料。

Azure Data Lake儲存體

建立Azure Data Lake Storage認證組態

accordion

要求

code language-shell

curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
    "azureAuthentication":{
      "url":"string",
      "tenant":"string",
      "servicePrincipalId":"string",
      "servicePrincipalKey":"string"
   }
}

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 layout-auto
參數	類型	說明
`url`	字串	授權提供者的URL
`tenant`	字串	Azure Data Lake Storage租使用者
`servicePrincipalId`	字串	Azure資料湖儲存體的Azure服務主體ID
`servicePrincipalKey`	字串	Azure Data Lake儲存體的Azure服務主要金鑰

accordion
回應
成功的回應會傳回HTTP狀態200以及您新建立的認證組態的詳細資料。

Azure Blob儲存體

建立Azure Blob Storage認證組態

accordion

要求

code language-shell

curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
    "azureConnectionStringAuthentication":{
      "connectionString":"string"
   }
}

table 0-row-3 1-row-3 layout-auto
參數	類型	說明
`connectionString`	字串	Azure Blob Storage連線字串

accordion
回應
成功的回應會傳回HTTP狀態200以及您新建立的認證組態的詳細資料。

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