Crear una conexión de origen Microsoft Dynamics mediante la API Flow Service

Flow Service se utiliza para recopilar y centralizar datos de clientes de diferentes fuentes dentro de Adobe Experience Platform. El servicio proporciona una interfaz de usuario y una API RESTful desde las que se pueden conectar todas las fuentes admitidas.

Este tutorial utiliza la API Flow Service para guiarle por los pasos para conectar Platform a una cuenta Microsoft Dynamics (en adelante denominada "Dynamics") mediante la API de servicio de flujo.

Primeros pasos

Esta guía requiere conocer los siguientes componentes de Adobe Experience Platform:

  • Fuentes: Experience Platform permite la ingesta de datos de varias fuentes, al mismo tiempo que le ofrece la capacidad de estructurar, etiquetar y mejorar los datos entrantes mediante los servicios de Platform.
  • Simuladores para pruebas: Experience Platform proporciona entornos limitados virtuales que dividen una sola instancia de Platform en entornos virtuales independientes para ayudar a desarrollar y desarrollar aplicaciones de experiencia digital.

Las secciones siguientes proporcionan información adicional que deberá conocer para conectar correctamente Platform a una cuenta de Dynamics mediante la API Flow Service.

Recopilar las credenciales necesarias

Para que Flow Service se conecte a Dynamics, debe proporcionar valores para las siguientes propiedades de conexión:

Credencial Descripción
serviceUri La URL de servicio de su instancia Dynamics.
username El nombre de usuario de su cuenta de usuario Dynamics.
password La contraseña de su cuenta Dynamics.
servicePrincipalId El ID de cliente de su cuenta Dynamics. Este ID es necesario cuando se utiliza la entidad de seguridad del servicio y la autenticación basada en claves.
servicePrincipalKey La clave secreta principal del servicio. Esta credencial es necesaria cuando se utiliza la entidad de seguridad del servicio y la autenticación basada en claves.

Para obtener más información sobre cómo empezar, visite este Dynamics documento.

Leer llamadas de API de ejemplo

Este tutorial proporciona llamadas de API de ejemplo para demostrar cómo dar formato a las solicitudes. Estas incluyen rutas de acceso, encabezados necesarios y cargas de solicitud con el formato correcto. También se proporciona el JSON de muestra devuelto en las respuestas de API. Para obtener información sobre las convenciones utilizadas en la documentación para las llamadas de API de ejemplo, consulte la sección sobre cómo leer llamadas de API de ejemplo en la guía de solución de problemas del Experience Platform.

Recopilar valores para encabezados necesarios

Para realizar llamadas a las API de Platform, primero debe completar el tutorial de autenticación. Al completar el tutorial de autenticación, se proporcionan los valores para cada uno de los encabezados necesarios en todas las llamadas a la API de Experience Platform, como se muestra a continuación:

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

Todos los recursos del Experience Platform, incluidos los que pertenecen a Flow Service, están aislados en entornos limitados virtuales específicos. Todas las solicitudes a las API de Platform requieren un encabezado que especifique el nombre del simulador para pruebas en el que se realizará la operación:

  • x-sandbox-name: {SANDBOX_NAME}

Todas las solicitudes que contienen una carga útil (POST, PUT, PATCH) requieren un encabezado de tipo de medio adicional:

  • Content-Type: application/json

Crear una conexión

Una conexión especifica un origen y contiene sus credenciales para ese origen. Solo se requiere una conexión por cada cuenta Dynamics, ya que se puede utilizar para crear varios flujos de datos para introducir datos diferentes.

Crear una conexión Dynamics utilizando la autenticación básica

Para crear una conexión Dynamics utilizando la autenticación básica, realice una solicitud de POST a la API Flow Service y proporcione los valores serviceUri, username y password de la conexión.

Formato de API

POST /connections

Solicitud

Para crear una conexión Dynamics, su ID de especificación de conexión única debe proporcionarse como parte de la solicitud del POST. El ID de especificación de conexión para Dynamics es 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"
        }
    }'
Propiedad Descripción
auth.params.serviceUri El URI de servicio asociado a su instancia Dynamics.
auth.params.username El nombre de usuario asociado a su cuenta Dynamics.
auth.params.password La contraseña asociada a su cuenta Dynamics.
connectionSpec.id La especificación de conexión id de su cuenta Dynamics recuperada en el paso anterior.

Respuesta

Una respuesta correcta devuelve la conexión recién creada, incluido su identificador único (id). Este ID es necesario para explorar el sistema CRM en el siguiente paso.

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

Creación de una conexión Dynamics mediante autenticación de claves principales de servicio

Para crear una conexión Dynamics utilizando la autenticación basada en claves principales del servicio, realice una solicitud de POST a la API Flow Service mientras proporciona valores para las serviceUri, servicePrincipalId y servicePrincipalKey de la conexión.

Formato de API

POST /connections

Solicitud

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"
        }
    }'
Propiedad Descripción
auth.params.serviceUri El URI de servicio asociado a su instancia Dynamics.
auth.params.servicePrincipalId El ID de cliente de su cuenta Dynamics. Este ID es necesario cuando se utiliza la entidad de seguridad del servicio y la autenticación basada en claves.
auth.params.servicePrincipalKey La clave secreta principal del servicio. Esta credencial es necesaria cuando se utiliza la entidad de seguridad del servicio y la autenticación basada en claves.

Respuesta

Una respuesta correcta devuelve la conexión recién creada, incluido su identificador único (id). Este ID es necesario para explorar el sistema CRM en el siguiente paso.

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

Pasos siguientes

Siguiendo este tutorial, ha creado una conexión Dynamics utilizando la API Flow Service y ha obtenido el valor de ID único de la conexión. Puede utilizar este ID en el siguiente tutorial, mientras aprende a explorar los sistemas CRM mediante la API de servicio de flujo.

En esta página