Crear un Microsoft Dynamics conexión base mediante el Flow Service API

Una conexión base representa la conexión autenticada entre un origen y Adobe Experience Platform.

Este tutorial lo acompañará durante los pasos para crear una conexión base para Microsoft Dynamics (en lo sucesivo, "Dynamics") utilizando el Flow Service API.

Introducción

Esta guía requiere una comprensión práctica de los siguientes componentes de Adobe Experience Platform:

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

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

Recopilar credenciales necesarias

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

Autenticación básica
table 0-row-2 1-row-2 2-row-2 3-row-2
Credencial Descripción
serviceUri La URL de servicio de su Dynamics ejemplo.
username El nombre de usuario de su Dynamics cuenta de usuario.
password La contraseña de su Dynamics cuenta.
Autenticación de clave y principal de servicio
table 0-row-2 1-row-2 2-row-2
Credencial Descripción
servicePrincipalId El ID de cliente de su Dynamics cuenta. Este ID es necesario cuando se utiliza la autenticación principal del servicio y basada en claves.
servicePrincipalKey La clave secreta principal de servicio. Esta credencial es necesaria cuando se utiliza la autenticación principal del servicio y basada en claves.

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

Uso de API de Platform

Para obtener información sobre cómo realizar llamadas correctamente a las API de Platform, consulte la guía de introducción a las API de Platform.

Cree una conexión base

TIP
Una vez creado, no se puede cambiar el tipo de autenticación de una Dynamics conexión base. Para cambiar el tipo de autenticación, debe crear una nueva conexión base.

Una conexión base retiene información entre el origen y Platform, incluidas las credenciales de autenticación del origen, el estado actual de la conexión y el ID único de conexión base. El ID de conexión base le permite explorar y navegar por archivos desde el origen e identificar los elementos específicos que desea introducir, incluida la información sobre sus tipos de datos y formatos.

Para crear un ID de conexión base, realice una solicitud de POST al /connections extremo al proporcionar su Dynamics credenciales de autenticación como parte de los parámetros de solicitud.

Crear un Dynamics conexión base

TIP
Una vez creado, no se puede cambiar el tipo de autenticación de una Dynamics conexión base. Para cambiar el tipo de autenticación, debe crear una nueva conexión base.

El primer paso para crear una conexión de origen es autenticar su Dynamics y generar un ID de conexión base. Un ID de conexión base le permite explorar y navegar por archivos desde el origen e identificar elementos específicos que desee introducir, incluida información sobre sus tipos de datos y formatos.

Para crear un ID de conexión base, realice una solicitud de POST al /connections extremo al proporcionar su Dynamics credenciales de autenticación como parte de los parámetros de solicitud.

Formato de API

POST /connections
Autenticación básica

Para crear un Dynamics conexión base mediante autenticación básica, realice una solicitud de POST al Flow Service API, al tiempo que proporciona valores para el serviceUri, username, y password.

accordion
Solicitud
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
Propiedad Descripción
auth.params.serviceUri El URI de servicio asociado con su Dynamics ejemplo.
auth.params.username El nombre de usuario asociado con su Dynamics cuenta.
auth.params.password La contraseña asociada a su Dynamics cuenta.
connectionSpec.id El Dynamics identificador de especificación de conexión: 38ad80fe-8b06-4938-94f4-d4ee80266b07
accordion
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.

code language-json
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}
Autenticación basada en claves principales de servicio

Para crear un Dynamics conexión base mediante autenticación basada en claves principales de servicio, realice una solicitud de POST al Flow Service API, al tiempo que proporciona valores para el serviceUri, servicePrincipalId, y servicePrincipalKey.

accordion
Solicitud
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
Propiedad Descripción
auth.params.serviceUri El URI de servicio asociado con su Dynamics ejemplo.
auth.params.servicePrincipalId El ID de cliente de su Dynamics cuenta. Este ID es necesario cuando se utiliza la autenticación principal del servicio y basada en claves.
auth.params.servicePrincipalKey La clave secreta principal de servicio. Esta credencial es necesaria cuando se utiliza la autenticación principal del servicio y basada en claves.
connectionSpec.id El Dynamics identificador de especificación de conexión: 38ad80fe-8b06-4938-94f4-d4ee80266b07
accordion
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.

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

Pasos siguientes

Al seguir este tutorial, ha creado un Microsoft Dynamics conexión base mediante el Flow Service API. Puede utilizar este ID de conexión base en los siguientes tutoriales:

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