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

Flow Service O é usado para coletar e centralizar dados do cliente de várias fontes diferentes no Adobe Experience Platform. O serviço fornece uma interface de usuário e uma RESTful API da qual todas as fontes compatíveis são conectáveis.

Este tutorial usa a API Flow Service para orientá-lo pelas etapas para conectar a Platform a uma conta Microsoft Dynamics (a seguir denominada "Dinâmica") usando a API do Serviço de fluxo.

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.

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

Lendo exemplos de chamadas de API

Este tutorial fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações do . Isso inclui caminhos, cabeçalhos necessários e cargas de solicitação formatadas corretamente. O JSON de exemplo retornado nas respostas da API também é fornecido. Para obter informações sobre as convenções usadas na documentação para chamadas de API de exemplo, consulte a seção sobre como ler chamadas de API de exemplo no guia de solução de problemas do Experience Platform.

Coletar valores para cabeçalhos necessários

Para fazer chamadas para APIs da plataforma, primeiro complete o tutorial de autenticação. A conclusão do tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todas as chamadas de API do Experience Platform, conforme mostrado abaixo:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Todos os recursos no Experience Platform, incluindo aqueles pertencentes a Flow Service, são isolados para sandboxes virtuais específicas. Todas as solicitações para APIs da plataforma exigem um cabeçalho que especifica o nome da sandbox em que a operação ocorrerá:

  • x-sandbox-name: {SANDBOX_NAME}

Todas as solicitações que contêm uma carga útil (POST, PUT, PATCH) exigem um cabeçalho de tipo de mídia adicional:

  • Content-Type: application/json

Criar uma conexão

Uma conexão especifica uma fonte e contém suas credenciais para essa fonte. Somente uma conexão é necessária por conta Dynamics, pois pode ser usada para criar vários fluxos de dados para trazer dados diferentes.

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

Para criar uma conexão 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

Para criar uma conexão Dynamics, a ID de especificação de conexão exclusiva deve ser fornecida como parte da solicitação POST. A ID de especificação de conexão para Dynamics é 38ad80fe-8b06-4938-94f4-d4ee80266b07.

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 especificação de conexão id da sua conta Dynamics recuperada na etapa anterior.

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 Dynamics usando a autenticação baseada em chave principal de serviço

Para criar uma conexão 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.

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

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now