检索凭据配置

IMPORTANT
API端点platform.adobe.io/data/core/activation/authoring/credentials

本页举例说明了可用于检索凭据配置的API请求和有效负载,使用 /authoring/credentials API端点。

何时使用 /credentials API端点 when-to-use

IMPORTANT
在大多数情况下,您 不要 需要使用 /credentials API端点。 您而是可以通过配置目标的身份验证信息 customerAuthenticationConfigurations 的参数 /destinations 端点。
读取 客户身份验证配置 以了解有关支持的身份验证类型的详细信息。

只有在Adobe和目标平台之间存在全局身份验证系统,并且 Platform 客户无需提供任何身份验证凭据即可连接到您的目标。 在这种情况下,您必须使用创建凭据配置 /credentials API端点。

在使用全局身份验证系统时,必须设置 "authenticationRule":"PLATFORM_AUTHENTICATION"目标投放 配置,时间 创建新的目标配置.

IMPORTANT
Destination SDK支持的所有参数名称和值包括 区分大小写. 为避免出现区分大小写错误,请完全按照文档中的说明使用参数名称和值。

凭据API操作快速入门 get-started

在继续之前,请查看 快速入门指南 获取成功调用API所需了解的重要信息,包括如何获取所需的目标创作权限和所需的标头。

检索凭据配置 retrieve

您可以检索 现有 凭据配置,方法是 GET 请求 /authoring/credentials 端点。

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
响应

成功的响应会返回HTTP状态200,其中包含您有权访问的凭据配置列表,该列表基于 IMS Org ID 和您使用的沙盒名称之间的关联。 一 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 SDKAPI端点遵循常规Experience PlatformAPI错误消息原则。 请参阅 API状态代码请求标头错误 ,位于平台疑难解答指南中。

后续步骤 next-steps

阅读本文档后,您现在知道如何使用 /authoring/credentials API端点。 读取 如何使用Destination SDK配置目标 以了解此步骤在配置目标的过程中所处的位置。

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