Criar uma conexão de base Microsoft Dynamics usando a API Flow Service

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 (doravante denominada "Dynamics") usando a Flow Service API.

Introdução

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

  • Fontes: 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 a API Flow Service.

Coletar credenciais necessárias

Para que Flow Service se conecte 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 A URL de serviço da instância Dynamics.
username O nome de usuário da sua conta de usuário Dynamics.
password A senha da sua conta Dynamics.
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 de cliente da sua conta Dynamics. 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 sobre introdução às APIs da Platform.

Criar uma conexão básica

TIP
Depois de criada, você não pode alterar o tipo de autenticação de uma conexão de base Dynamics. 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 uma ID de conexão base, faça uma solicitação POST para o ponto de extremidade /connections enquanto fornece suas credenciais de autenticação Dynamics como parte dos parâmetros de solicitação.

Criar uma conexão de base Dynamics

TIP
Depois de criada, você não pode alterar o tipo de autenticação de uma conexão de base Dynamics. 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 sua origem Dynamics e gerar uma ID de conexão base. 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 uma ID de conexão base, faça uma solicitação POST para o ponto de extremidade /connections enquanto fornece suas credenciais de autenticação Dynamics como parte dos parâmetros de solicitação.

Formato da API

POST /connections
Autenticação básica

Para criar uma conexão base Dynamics usando autenticação básica, faça uma solicitação POST para a API Flow Service enquanto fornece valores para os serviceUri, username e password da sua conexão.

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 à sua instância Dynamics.
auth.params.username O nome de usuário associado à sua conta Dynamics.
auth.params.password A senha associada à sua conta Dynamics.
connectionSpec.id A ID da especificação de conexão Dynamics: 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 na chave da entidade de serviço

Para criar uma conexão base Dynamics usando a autenticação baseada em chave da entidade de serviço, faça uma solicitação POST para a API Flow Service enquanto fornece valores para os serviceUri, servicePrincipalId e servicePrincipalKey da sua conexão.

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 à sua instância Dynamics.
auth.params.servicePrincipalId A ID de cliente da sua conta Dynamics. 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 ID da especificação de conexão Dynamics: 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

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

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