Criar um Microsoft Dynamics conexão básica usando o Flow Service API

Uma conexão base representa a conexão autenticada entre uma origem e o Adobe Experience Platform.

Este tutorial guiará você pelas etapas para criar uma conexão básica para Microsoft Dynamics (a seguir designado por "Dynamics") usando o Flow Service API.

Introdução

Este manual necessita de uma compreensão funcional dos seguintes componentes da Adobe Experience Platform:

  • Origens: o Experience Platform permite que os dados sejam assimilados de várias fontes e, ao mesmo tempo, fornece a capacidade de estruturar, rotular e aprimorar os dados recebidos usando os serviços da plataforma.
  • Sandboxes: o Experience Platform fornece sandboxes virtuais que particionam uma única instância da Platform em ambientes virtuais separados para ajudar a desenvolver aplicativos de experiência digital.

As seções a seguir fornecem as informações adicionais que você precisará saber para conectar com êxito o Platform a uma conta do Dynamics usando o Flow Service API.

Coletar credenciais necessárias

A fim de Flow Service para se conectar a Dynamics, você deve fornecer valores para as seguintes propriedades de conexão:

Autenticação básica
table 0-row-2 1-row-2 2-row-2 3-row-2
Credencial Descrição
serviceUri O URL de serviço do Dynamics instância.
username O nome de usuário do seu Dynamics conta de usuário.
password A senha do Dynamics conta.
Autenticação da entidade de serviço e da chave
table 0-row-2 1-row-2 2-row-2
Credencial Descrição
servicePrincipalId A ID do cliente do Dynamics conta. Essa ID é necessária ao usar a entidade de serviço e a autenticação baseada em chave.
servicePrincipalKey A chave secreta da entidade de serviço. Essa credencial é necessária ao usar a entidade de serviço e a autenticação baseada em chave.

Para obter mais informações sobre a introdução, consulte este Dynamics documento.

Uso de APIs da plataforma

Para obter informações sobre como fazer chamadas para APIs da Platform com êxito, consulte o manual em introdução às APIs da Platform.

Crie uma conexão básica

TIP
Depois de criado, não é possível alterar o tipo de autenticação de um Dynamics conexão básica. Para alterar o tipo de autenticação, você deve criar uma nova conexão base.

Uma conexão base retém informações entre sua origem e a Platform, incluindo as credenciais de autenticação da origem, o estado atual da conexão e sua ID de conexão base exclusiva. A ID de conexão básica permite explorar e navegar pelos arquivos de dentro da origem e identificar os itens específicos que deseja assimilar, incluindo informações sobre os tipos de dados e formatos.

Para criar um ID de conexão base, faça uma solicitação POST ao /connections ao fornecer sua Dynamics credenciais de autenticação como parte dos parâmetros de solicitação.

Criar um Dynamics conexão básica

TIP
Depois de criado, não é possível alterar o tipo de autenticação de um Dynamics conexão básica. Para alterar o tipo de autenticação, você deve criar uma nova conexão base.

A primeira etapa na criação de uma conexão de origem é autenticar seu Dynamics origem e gere uma ID de conexão básica. Uma ID de conexão básica permite explorar e navegar pelos arquivos de dentro da origem e identificar itens específicos que você deseja assimilar, incluindo informações sobre os tipos de dados e formatos.

Para criar um ID de conexão base, faça uma solicitação POST ao /connections ao fornecer sua Dynamics credenciais de autenticação como parte dos parâmetros de solicitação.

Formato da API

POST /connections
Autenticação básica

Para criar um Dynamics conexão básica usando autenticação básica, faça uma solicitação POST ao Flow Service ao fornecer valores para a configuração de serviceUri, username, e password.

accordion
Solicitação
code language-shell
curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/connections' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "Dynamics connection",
        "description": "Dynamics connection using basic auth",
        "auth": {
            "specName": "Basic Authentication for Dynamics-Online",
            "params": {
                "serviceUri": "{SERVICE_URI}",
                "username": "{USERNAME}",
                "password": "{PASSWORD}"
            }
        },
        "connectionSpec": {
            "id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
            "version": "1.0"
        }
    }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Propriedade Descrição
auth.params.serviceUri O URI de serviço associado à Dynamics instância.
auth.params.username O nome de usuário associado à Dynamics conta.
auth.params.password A senha associada ao seu Dynamics conta.
connectionSpec.id A variável Dynamics ID da especificação de conexão: 38ad80fe-8b06-4938-94f4-d4ee80266b07
accordion
Resposta

Uma resposta bem-sucedida retorna a conexão recém-criada, incluindo seu identificador exclusivo (id). Essa ID é necessária para explorar seu sistema CRM na próxima etapa.

code language-json
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}
Autenticação baseada em chave da entidade de serviço

Para criar um Dynamics conexão básica usando autenticação baseada em chave de entidade de serviço, faça uma solicitação POST ao Flow Service ao fornecer valores para a configuração de serviceUri, servicePrincipalId, e servicePrincipalKey.

accordion
Solicitação
code language-shell
curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "Dynamics connection",
      "description": "Dynamics connection using key-based authentication",
      "auth": {
          "specName": "Service Principal Key Based Authentication",
          "params": {
              "serviceUri": "{SERVICE_URI}",
              "servicePrincipalId": "{SERVICE_PRINCIPAL_ID}",
              "servicePrincipalKey": "{SERVICE_PRINCIPAL_KEY}"
          }
      },
      "connectionSpec": {
          "id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Propriedade Descrição
auth.params.serviceUri O URI de serviço associado à Dynamics instância.
auth.params.servicePrincipalId A ID do cliente do Dynamics conta. Essa ID é necessária ao usar a entidade de serviço e a autenticação baseada em chave.
auth.params.servicePrincipalKey A chave secreta da entidade de serviço. Essa credencial é necessária ao usar a entidade de serviço e a autenticação baseada em chave.
connectionSpec.id A variável Dynamics ID da especificação de conexão: 38ad80fe-8b06-4938-94f4-d4ee80266b07
accordion
Resposta

Uma resposta bem-sucedida retorna a conexão recém-criada, incluindo seu identificador exclusivo (id). Essa ID é necessária para explorar seu sistema CRM na próxima etapa.

code language-json
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}

Próximas etapas

Ao seguir este tutorial, você criou um Microsoft Dynamics conexão básica usando o Flow Service API. Você pode usar essa ID de conexão básica nos seguintes tutoriais:

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