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

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

Este tutorial o orienta pelas etapas para criar uma conexão básica para Microsoft Dynamics (a seguir chamada "Dynamics") usando a Flow Service API.

Introdução

Este guia requer uma compreensão funcional dos seguintes componentes do Adobe Experience Platform:

  • Fontes: O Experience Platform permite que os dados sejam assimilados de várias fontes, fornecendo 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 informações adicionais que você precisará saber para se conectar com êxito do Platform a uma conta do Dynamics usando a API Flow Service.

Obter credenciais necessárias

Para que Flow Service se conecte a Dynamics, você deve fornecer valores para as seguintes propriedades de conexão:

Credencial Descrição
serviceUri O URL de serviço da sua instância Dynamics.
username O nome de usuário para sua conta de usuário Dynamics.
password A senha da sua conta Dynamics.
servicePrincipalId A ID do cliente da sua conta Dynamics. Essa ID é necessária ao usar a principal 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.
connectionSpec.id A especificação de conexão retorna as propriedades do conector de origem, incluindo especificações de autenticação relacionadas à criação das conexões base e de origem. A ID de especificação de conexão para Dynamics é: 38ad80fe-8b06-4938-94f4-d4ee80266b07.

Para obter mais informações sobre a introdução, visite this Dynamics document.

Uso de APIs da plataforma

Para obter informações sobre como fazer chamadas para APIs da plataforma com êxito, consulte o guia sobre como começar a usar APIs da plataforma.

Criar uma conexão base

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

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

Criar uma conexão base Dynamics usando autenticação básica

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

Formato da API

POST /connections

Solicitação

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: {IMS_ORG}' \
    -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"
        }
    }'
Propriedade Descrição
auth.params.serviceUri O URI de serviço associado à 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

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.

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

Criar uma conexão base Dynamics usando autenticação baseada em chave principal de serviço

Para criar uma conexão base Dynamics usando a autenticação com chave principal de serviço, faça uma solicitação POST para a API Flow Service, fornecendo valores para as serviceUri, servicePrincipalId e servicePrincipalKey da sua conexão.

Formato da API

POST /connections

Solicitação

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: {IMS_ORG}' \
    -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"
        }
    }'
Propriedade Descrição
auth.params.serviceUri O URI de serviço associado à instância Dynamics.
auth.params.servicePrincipalId A ID do cliente da sua conta Dynamics. Essa ID é necessária ao usar a principal 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

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.

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

Próximas etapas

Ao seguir este tutorial, você criou uma conexão Dynamics usando a API Flow Service e obteve o valor de ID exclusivo da conexão. Você pode usar essa ID no próximo tutorial à medida que aprende a explorar sistemas CRM usando a API do Serviço de Fluxo.

Nesta página