文档 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 Storage

创建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存储租户
`servicePrincipalId`	字符串	Azure Data Lake Storage的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 SDKAPI端点遵循常规Experience PlatformAPI错误消息原则。请参阅平台疑难解答指南中的API状态代码和请求标头错误。

后续步骤 next-steps

阅读本文档后，您现在知道何时使用凭据终结点，以及如何使用/authoring/credentials API终结点设置凭据配置。阅读如何使用Destination SDK配置目标，以了解此步骤在配置目标的过程中适合的位置。

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6