文档Experience Platform源连接器指南

为自助源配置身份验证规范(批处理SDK)

Last update: Fri Apr 04 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 开发人员

身份验证规范定义Adobe Experience Platform用户可以如何连接到您的源。

authSpec数组包含有关将源连接到Experience Platform所需的身份验证参数的信息。 任何给定的源都可以支持多种不同类型的身份验证。

身份验证规范

自助式源(批处理SDK)支持OAuth 2刷新代码和基本身份验证。 有关使用OAuth 2刷新代码和基本身份验证的指导，请参阅下表

OAuth 2刷新代码

OAuth 2刷新代码允许通过生成临时访问令牌和刷新令牌来安全地访问应用程序。 访问令牌允许您安全地访问资源，而无需提供其他凭据，而刷新令牌允许您在访问令牌过期后生成新的访问令牌。

查看OAuth 2刷新代码的示例
code language-json 
{
  "name": "OAuth2 Refresh Code",
  "type": "OAuth2RefreshCode",
  "spec": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "description": "Define auth params required for connecting to generic rest using oauth2 authorization code.",
    "properties": {
      "authorizationTestUrl": {
        "description": "Authorization test url to validate accessToken.",
        "type": "string"
      },
      "clientId": {
        "description": "Client id of user account.",
        "type": "string"
      },
      "clientSecret": {
        "description": "Client secret of user account.",
        "type": "string",
        "format": "password"
      },
      "accessToken": {
        "description": "Access Token",
        "type": "string",
        "format": "password"
      },
      "refreshToken": {
        "description": "Refresh Token",
        "type": "string",
        "format": "password"
      },
      "expirationDate": {
        "description": "Date of token expiry.",
        "type": "string",
        "format": "date",
        "uiAttributes": {
          "hidden": true
        }
      },
      "accessTokenUrl": {
        "description": "Access token url to fetch access token.",
        "type": "string"
      },
      "requestParameterOverride": {
        "type": "object",
        "description": "Specify parameter to override.",
        "properties": {
          "accessTokenField": {
            "description": "Access token field name to override.",
            "type": "string"
          },
          "refreshTokenField": {
            "description": "Refresh token field name to override.",
            "type": "string"
          },
          "expireInField": {
            "description": "ExpireIn field name to override.",
            "type": "string"
          },
          "authenticationMethod": {
            "description": "Authentication method override.",
            "type": "string",
            "enum": [
              "GET",
              "POST"
            ]
          },
          "clientId": {
            "description": "ClientId field name override.",
            "type": "string"
          },
          "clientSecret": {
            "description": "ClientSecret field name override.",
            "type": "string"
          }
        }
      }
    },
    "required": [
      "accessToken"
    ]
  }
}
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-row-3 12-row-3 13-row-3 14-row-3 15-row-3 16-row-3 17-row-3 layout-auto
属性 描述 示例
authSpec.name 显示支持的身份验证类型的名称。 oAuth2-refresh-code
authSpec.type 定义源支持的身份验证类型。 oAuth2-refresh-code
authSpec.spec 包含有关身份验证架构、数据类型和属性的信息。
authSpec.spec.$schema 定义用于身份验证的架构。 http://json-schema.org/draft-07/schema#
authSpec.spec.type 定义架构的数据类型。 object
authSpec.spec.properties 包含有关用于身份验证的凭据的信息。
authSpec.spec.properties.description 显示凭据的简短说明。
authSpec.spec.properties.type 定义凭据的数据类型。 string
authSpec.spec.properties.clientId 与您的应用程序关联的客户端ID。 客户端ID将与您的客户端密钥结合使用，以检索您的访问令牌。
authSpec.spec.properties.clientSecret 与您的应用程序关联的客户端密钥。 客户端密钥将与您的客户端ID结合使用，以检索您的访问令牌。
authSpec.spec.properties.accessToken 访问令牌可授权您对应用程序的安全访问。
authSpec.spec.properties.refreshToken 刷新令牌用于在访问令牌过期时生成新的访问令牌。
authSpec.spec.properties.expirationDate 定义访问令牌的过期日期。
authSpec.spec.properties.refreshTokenUrl 用于检索刷新令牌的URL。
authSpec.spec.properties.accessTokenUrl 用于检索刷新令牌的URL。
authSpec.spec.properties.requestParameterOverride 允许您指定验证时要覆盖的凭据参数。
authSpec.spec.required 显示进行身份验证所需的凭据。 accessToken

基本身份验证

基本身份验证是一种身份验证类型，它允许您使用帐户用户名和帐户密码的组合来访问应用程序。

查看基本身份验证的示例
code language-json 
{
  "name": "Basic Authentication",
  "type": "BasicAuthentication",
  "spec": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "description": "defines auth params required for connecting to rest service.",
    "properties": {
      "username": {
        "description": "Username to connect rest endpoint.",
        "type": "string"
      },
      "password": {
        "description": "Password to connect rest endpoint.",
        "type": "string",
        "format": "password"
      }
    },
    "required": [
      "username",
      "password"
    ]
  }
}
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 layout-auto
属性 描述 示例
authSpec.name 显示支持的身份验证类型的名称。 Basic Authentication
authSpec.type 定义源支持的身份验证类型。 BasicAuthentication
authSpec.spec 包含有关身份验证架构、数据类型和属性的信息。
authSpec.spec.$schema 定义用于身份验证的架构。 http://json-schema.org/draft-07/schema#
authSpec.spec.type 定义架构的数据类型。 object
authSpec.spec.description 显示特定于您的身份验证类型的详细信息。
authSpec.spec.properties 包含有关用于身份验证的凭据的信息。
authSpec.spec.properties.username 与您的应用程序关联的帐户用户名。
authSpec.spec.properties.password 与应用程序关联的帐户密码。
authSpec.spec.required 指定所需的字段作为在Experience Platform中输入的必需值。 username

API密钥身份验证 api-key-authentication

API密钥身份验证是通过在请求中提供API密钥和其他相关身份验证参数来访问API的安全方法。 根据您的特定API信息，您可以将API密钥作为请求标头、查询参数或正文的一部分发送。

使用API密钥身份验证时，通常需要以下参数：

参数
类型
必需
描述
host
字符串
否
资源URL。
authKey1
字符串
是
API访问所需的第一个身份验证密钥。 它通常以请求标头或查询参数的形式发送。
authKey2
字符串
可选
第二个身份验证密钥。 如果需要，此密钥通常用于进一步验证请求。
authKeyN
字符串
可选
根据需要可以使用的其他身份验证变量，但API除外。
查看API密钥身份验证
code language-json 
{
  "name": "API Key Authentication",
  "type": "KeyBased",
  "spec": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "description": "Define authentication parameters required for API access",
    "properties": {
      "host": {
        "type": "string",
        "description": "Enter resource URL host path"
      },
      "authKey1": {
        "type": "string",
        "format": "password",
        "title": "Authentication Key 1",
        "description": "Primary authentication key for accessing the API",
        "restAttributes": {
          "headerParamName": "X-Auth-Key1"
        }
      },
      "authKey2": {
        "type": "string",
        "format": "password",
        "title": "Authentication Key 2",
        "description": "Secondary authentication key, if required",
        "restAttributes": {
          "headerParamName": "X-Auth-Key2"
        }
      },
      ..
      ..
      "authKeyN": {
        "type": "string",
        "format": "password",
        "title": "Additional Authentication Key",
        "description": "Additional authentication keys as needed by the API",
        "restAttributes": {
          "headerParamName": "X-Auth-KeyN"
        }
      }
    },
    "required": [
      "authKey1"
    ]
  }
}

身份验证行为

您可以使用restAttributes参数定义应如何在请求中包含API密钥。 例如，在以下示例中，headerParamName属性指示X-Auth-Key1应作为标头发送。

  "restAttributes": {
      "headerParamName": "X-Auth-Key1"
  }

每个身份验证密钥（如authKey1、authKey2等）都可以与restAttributes关联，以规定它们作为请求发送的方式。

如果authKey1具有"headerParamName": "X-Auth-Key1"。 这意味着请求标头应包含X-Auth-Key:{YOUR_AUTH_KEY1}。 此外，键名和headerParamName不必相同。 例如：

  • authKey1可以具有headerParamName: X-Custom-Auth-Key。 这意味着请求标头将使用X-Custom-Auth-Key而不是authKey1。
  • 相反，authKey1可以具有headerParamName: authKey1。 这意味着请求标头名称保持不变。

示例API格式

GET /data?X-Auth-Key1={YOUR_AUTH_KEY1}&X-Auth-Key2={YOUR_AUTH_KEY2}

身份验证规范示例

以下是使用MailChimp Members源的已完成身份验证规范示例。

查看身份验证规范示例
code language-json 
  "authSpec": [
    {
      "name": "OAuth2 Refresh Code",
      "type": "OAuth2RefreshCode",
      "spec": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "description": "Define auth params required for connecting to generic rest using oauth2 authorization code.",
        "properties": {
          "authorizationTestUrl": {
            "description": "Authorization test url to validate accessToken.",
            "type": "string"
          },
          "accessToken": {
            "description": "Access Token of mailChimp endpoint.",
            "type": "string",
            "format": "password"
          }
        },
        "required": [
          "accessToken"
        ]
      }
    },
    {
      "name": "Basic Authentication",
      "type": "BasicAuthentication",
      "spec": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "description": "defines auth params required for connecting to rest service.",
        "properties": {
          "username": {
            "description": "Username to connect mailChimp endpoint.",
            "type": "string"
          },
          "password": {
            "description": "Password to connect mailChimp endpoint.",
            "type": "string",
            "format": "password"
          }
        },
        "required": [
          "username",
          "password"
        ]
      }
    }
  ],

后续步骤

填充身份验证规范后，您可以继续为要集成到Experience Platform的源配置源规范。 有关详细信息，请参阅配置源规范上的文档。

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089