DocumentaçãoExperience PlatformGuia dos conectores de origem

Configurar especificações de autenticação para Fontes de autoatendimento (SDK em lote)

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • undefined

As especificações de autenticação definem como os usuários do Adobe Experience Platform podem se conectar à origem.

A matriz authSpec contém informações sobre os parâmetros de autenticação necessários para conectar uma origem à Platform. Qualquer origem fornecida pode suportar vários tipos diferentes de autenticação.

Especificações de autenticação

Fontes de autoatendimento (SDK em lote) são compatíveis com códigos de atualização OAuth 2 e autenticação básica. Consulte as tabelas abaixo para obter orientação sobre como usar um código de atualização OAuth 2 e uma autenticação básica

Código de atualização do OAuth 2

Um código de atualização OAuth 2 permite acesso seguro a um aplicativo gerando um token de acesso temporário e um token de atualização. O token de acesso permite acessar com segurança os recursos sem precisar fornecer outras credenciais, enquanto o token de atualização permite gerar um novo token de acesso depois que ele expirar.

{
  "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"
    ]
  }
}
Propriedade
Descrição
Exemplo
authSpec.name
Exibe o nome do tipo de autenticação suportado.
oAuth2-refresh-code
authSpec.type
Define o tipo de autenticação aceito pela origem.
oAuth2-refresh-code
authSpec.spec
Contém informações sobre o esquema, o tipo de dados e as propriedades da autenticação.
authSpec.spec.$schema
Define o esquema usado para a autenticação.
http://json-schema.org/draft-07/schema#
authSpec.spec.type
Define o tipo de dados do esquema.
object
authSpec.spec.properties
Contém informações sobre as credenciais usadas para a autenticação.
authSpec.spec.properties.description
Exibe uma breve descrição da credencial.
authSpec.spec.properties.type
Define o tipo de dados da credencial.
string
authSpec.spec.properties.clientId
A ID do cliente associada ao aplicativo. A ID do cliente é usada juntamente com o segredo do cliente para recuperar o token de acesso.
authSpec.spec.properties.clientSecret
O segredo do cliente associado ao aplicativo. O segredo do cliente é usado em conjunto com a ID do cliente para recuperar o token de acesso.
authSpec.spec.properties.accessToken
O token de acesso autoriza o acesso seguro ao aplicativo.
authSpec.spec.properties.refreshToken
O token de atualização é usado para gerar um novo token de acesso, quando o token de acesso expira.
authSpec.spec.properties.expirationDate
Define a data de expiração do token de acesso.
authSpec.spec.properties.refreshTokenUrl
O URL usado para recuperar o token de atualização.
authSpec.spec.properties.accessTokenUrl
O URL usado para recuperar o token de atualização.
authSpec.spec.properties.requestParameterOverride
Permite que você especifique parâmetros de credencial a serem substituídos na autenticação.
authSpec.spec.required
Exibe as credenciais necessárias para a autenticação.
accessToken

Autenticação básica

A autenticação básica é um tipo de autenticação que permite acessar seu aplicativo usando uma combinação do nome de usuário da conta e da senha da conta.

{
  "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"
    ]
  }
}
Propriedade
Descrição
Exemplo
authSpec.name
Exibe o nome do tipo de autenticação suportado.
Basic Authentication
authSpec.type
Define o tipo de autenticação aceito pela origem.
BasicAuthentication
authSpec.spec
Contém informações sobre o esquema, o tipo de dados e as propriedades da autenticação.
authSpec.spec.$schema
Define o esquema usado para a autenticação.
http://json-schema.org/draft-07/schema#
authSpec.spec.type
Define o tipo de dados do esquema.
object
authSpec.spec.description
Exibe mais informações específicas para o seu tipo de autenticação.
authSpec.spec.properties
Contém informações sobre as credenciais usadas para a autenticação.
authSpec.spec.properties.username
O nome de usuário da conta associado ao aplicativo.
authSpec.spec.properties.password
A senha da conta associada ao aplicativo.
authSpec.spec.required
Especifica os campos obrigatórios que devem ser inseridos na Platform.
username

Exemplo de especificação de autenticação

Este é um exemplo de uma especificação de autenticação concluída usando uma origem MailChimp Members.

  "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"
        ]
      }
    }
  ],

Próximas etapas

Com suas especificações de autenticação preenchidas, você pode continuar a configurar as especificações de origem para a origem que deseja integrar à Platform. Consulte o documento sobre configuração de especificações de origem para obter mais informações.

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