Conexión de API HTTP

Información general

El destino de la API HTTP es un Adobe Experience Platform destino de streaming que le ayuda a enviar datos de perfil a puntos de conexión HTTP de terceros.

Para enviar datos de perfil a puntos de conexión HTTP, primero debe conectar con el destino in Adobe Experience Platform.

Casos de uso

El destino de la API HTTP permite exportar datos de perfil XDM y audiencias a extremos HTTP genéricos. Aquí puede ejecutar sus propios análisis o realizar cualquier otra operación que pueda necesitar en los datos de perfil exportados fuera de Experience Platform.

Los extremos HTTP pueden ser sistemas propios de los clientes o soluciones de terceros.

Audiencias compatibles

Esta sección describe qué tipo de audiencias puede exportar a este destino.

Tipo y frecuencia de exportación

Consulte la tabla siguiente para obtener información sobre el tipo y la frecuencia de exportación de destino.

Requisitos previos

Para utilizar el destino de la API HTTP para exportar datos fuera de Experience Platform, debe cumplir los siguientes requisitos previos:

• Debe tener un extremo HTTP que admita la API de REST.
• El extremo HTTP debe admitir el esquema de perfil del Experience Platform. No se admite ninguna transformación a un esquema de carga útil de terceros en el destino de la API HTTP. Consulte la datos exportados para ver un ejemplo del esquema de salida del Experience Platform.
• El extremo HTTP debe admitir encabezados.

LISTA DE PERMITIDOS de direcciones IP

Para cumplir los requisitos de seguridad y cumplimiento de normas de los clientes, Experience Platform proporciona una lista de direcciones IP estáticas que puede lista de permitidos para el destino de la API HTTP. Consulte LISTA DE PERMITIDOS de direcciones IP para destinos de flujo continuo para obtener la lista completa de direcciones IP que se van a lista de permitidos.

Tipos de autenticación admitidos

El destino de la API HTTP admite varios tipos de autenticación en el extremo HTTP:

• Punto final HTTP sin autenticación;
• Autenticación de token de portador;
• Credenciales del cliente de OAuth 2.0 autenticación con el formulario de cuerpo, con client ID, client secret y grant type en el cuerpo de la solicitud HTTP, como se muestra en el ejemplo siguiente.

curl --location --request POST '<YOUR_API_ENDPOINT>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=<CLIENT_ID>' \
--data-urlencode 'client_secret=<CLIENT_SECRET>'

• Credenciales del cliente de OAuth 2.0 con autorización básica, con un encabezado de autorización que contiene direcciones URL codificadas client ID y client secret.

curl --location --request POST 'https://some-api.com/token' \
--header 'Authorization: Basic base64(clientId:clientSecret)' \
--header 'Content-type: application/x-www-form-urlencoded; charset=UTF-8' \
--data-urlencode 'grant_type=client_credentials'

• Concesión de contraseña de OAuth 2.0.

Conectar con el destino

Para conectarse a este destino, siga los pasos descritos en la sección tutorial de configuración de destino. Al conectarse a este destino, debe proporcionar la siguiente información:

Información de autenticación

Autenticación de token de portador

Si selecciona la opción Token de portador tipo de autenticación para conectarse al extremo HTTP, introduzca los campos siguientes y seleccione Conectar con destino:

• Token de portador: inserte el token de portador para autenticarse en la ubicación HTTP.

Sin autenticación

Si selecciona la opción Ninguno tipo de autenticación para conectarse al extremo HTTP:

Al seleccionar esta autenticación abierta, solo necesita seleccionar Conectar con destino y se establece la conexión con el extremo.

Autenticación de contraseña de OAuth 2

Si selecciona la opción Contraseña de OAuth 2 tipo de autenticación para conectarse al extremo HTTP, introduzca los campos siguientes y seleccione Conectar con destino:

• URL de token de acceso: URL del lado que emite tokens de acceso y, opcionalmente, tokens de actualización.
• ID de cliente: La client ID que el sistema asigna a Adobe Experience Platform.
• Secreto del cliente: La client secret que el sistema asigna a Adobe Experience Platform.
• Nombre de usuario: El nombre de usuario para acceder al extremo HTTP.
• Contraseña: La contraseña para acceder al extremo HTTP.

Autenticación de credenciales de cliente de OAuth 2

Si selecciona la opción Credenciales del cliente de OAuth 2 tipo de autenticación para conectarse al extremo HTTP, introduzca los campos siguientes y seleccione Conectar con destino:

• URL de token de acceso: URL del lado que emite tokens de acceso y, opcionalmente, tokens de actualización.
• ID de cliente: La client ID que el sistema asigna a Adobe Experience Platform.
• Secreto del cliente: La client secret que el sistema asigna a Adobe Experience Platform.
• Tipo de credenciales de cliente: seleccione el tipo de concesión de credenciales de cliente de OAuth2 admitida por el extremo:
  • Formulario de cuerpo codificado: En este caso, la variable client ID y client secret están incluidos en el cuerpo de la solicitud enviado a su destino. Para ver un ejemplo, consulte la Tipos de autenticación admitidos sección.
  • Autorización básica: En este caso, la variable client ID y client secret están incluidos en un Authorization encabezado después de ser codificado en base64 y enviado a su destino. Para ver un ejemplo, consulte la Tipos de autenticación admitidos sección.

Rellenar detalles de destino

Para configurar los detalles del destino, rellene los campos obligatorios y opcionales a continuación. Un asterisco junto a un campo en la interfaz de usuario indica que el campo es obligatorio.

• Nombre: introduzca un nombre por el cual reconocerá este destino en el futuro.
• Descripción: introduzca una descripción que le ayudará a identificar este destino en el futuro.
• Encabezados: introduzca los encabezados personalizados que desee incluir en las llamadas de destino, con este formato: header1:value1,header2:value2,...headerN:valueN.
• Punto final HTTP: Dirección URL del extremo HTTP al que desea enviar los datos de perfil.
• Parámetros de consulta: Opcionalmente, puede agregar parámetros de consulta a la dirección URL del extremo HTTP. Aplique este formato a los parámetros de consulta que utilice: parameter1=value&parameter2=value.
• Incluir nombres de segmentos: cambie si desea que la exportación de datos incluya los nombres de las audiencias que está exportando. Para ver un ejemplo de exportación de datos con esta opción seleccionada, consulte la Datos exportados más abajo.
• Incluir marcas de tiempo de segmentos: Marque esta opción si desea que la exportación de datos incluya la marca de tiempo UNIX cuando se crearon y actualizaron las audiencias, así como la marca de tiempo UNIX cuando las audiencias se asignaron al destino para la activación. Para ver un ejemplo de exportación de datos con esta opción seleccionada, consulte la Datos exportados más abajo.

Habilitar alertas

Puede activar alertas para recibir notificaciones sobre el estado del flujo de datos a su destino. Seleccione una alerta de la lista a la que suscribirse para recibir notificaciones sobre el estado del flujo de datos. Para obtener más información sobre las alertas, consulte la guía de suscripción a alertas de destinos mediante la IU.

Cuando haya terminado de proporcionar detalles para la conexión de destino, seleccione Siguiente.

Activar audiencias en este destino

Consulte Activación de datos de audiencia en destinos de exportación de perfil de flujo continuo para obtener instrucciones sobre cómo activar audiencias en este destino.

Atributos de destino

En el Seleccionar atributos paso, Adobe recomienda seleccionar un identificador único de su esquema de unión. Seleccione el identificador único y cualquier otro campo XDM que desee exportar al destino.

Comportamiento de exportación de perfil

Experience Platform optimiza el comportamiento de exportación de perfiles a su destino de API HTTP para exportar solo datos a su punto final de API cuando se han producido actualizaciones relevantes en un perfil tras la calificación de la audiencia u otros eventos significativos. Los perfiles se exportan al destino en las siguientes situaciones:

• La actualización de perfil se determinó mediante un cambio en el abono a audiencia de al menos una de las audiencias asignadas al destino. Por ejemplo, el perfil cumple los requisitos de una de las audiencias asignadas al destino o ha salido de una de las audiencias asignadas al destino.
• La actualización de perfil se determinó mediante un cambio en la variable mapa de identidad. Por ejemplo, a un perfil que ya estaba cualificado para una de las audiencias asignadas al destino se le ha añadido una nueva identidad en el atributo del mapa de identidad.
• La actualización de perfil estaba determinada por un cambio en los atributos de al menos uno de los atributos asignados al destino. Por ejemplo, uno de los atributos asignados al destino en el paso de asignación se agrega a un perfil.

En todos los casos descritos anteriormente, solo los perfiles en los que se han producido actualizaciones relevantes se exportan a su destino. Por ejemplo, si una audiencia asignada al flujo de destino tiene cien miembros y cinco perfiles nuevos cumplen los requisitos para el segmento, la exportación a su destino es incremental y solo incluye los cinco perfiles nuevos.

Tenga en cuenta que todos los atributos asignados se exportan para un perfil, independientemente de dónde se encuentren los cambios. Por lo tanto, en el ejemplo anterior, todos los atributos asignados para esos cinco nuevos perfiles se exportarán incluso si los atributos en sí no han cambiado.

Qué determina una exportación de datos y qué se incluye en la exportación

Con respecto a los datos que se exportan para un perfil determinado, es importante comprender los dos conceptos diferentes de qué determina una exportación de datos a su destino de API HTTP y qué datos se incluyen en la exportación.

Por ejemplo, considere este flujo de datos para un destino HTTP en el que se seleccionen tres audiencias en el flujo de datos y se asignen cuatro atributos al destino.

Una exportación de perfil al destino puede determinarse mediante un perfil que cumpla los requisitos de uno de los siguientes criterios o que salga de él tres segmentos asignados. Sin embargo, en la exportación de datos, en la variable segmentMembership objeto (consulte Datos exportados , podrían aparecer otras audiencias no asignadas, si ese perfil en particular es miembro de ellas y si comparten la misma política de combinación que la audiencia que activó la exportación. Si un perfil cumple los requisitos para la Cliente con coches DeLorean segmento, pero también es miembro del Visto "Volver al futuro" película y Aficionados a la ciencia ficción segmentos, estas otras dos audiencias también estarán presentes en el segmentMembership objeto de la exportación de datos, aunque no estén asignados en el flujo de datos, si comparten la misma política de combinación con el Cliente con coches DeLorean segmento.

Desde el punto de vista de los atributos de perfil, cualquier cambio en los cuatro atributos asignados anteriormente determinará una exportación de destino y cualquiera de los cuatro atributos asignados presentes en el perfil estará presente en la exportación de datos.

Relleno de datos históricos

Cuando se añade una audiencia nueva a un destino existente o se crea un destino nuevo y se le asignan audiencias, Experience Platform exporta al destino los datos históricos de cualificación de audiencias. Perfiles que cumplen los requisitos para la audiencia antes la audiencia añadida al destino se exporta al destino en un plazo aproximado de una hora.

Datos exportados

Su exportado Experience Platform Los datos de aterrizan en su HTTP destino en formato JSON. Por ejemplo, la exportación siguiente contiene un perfil que se ha clasificado para un segmento determinado, es miembro de otros dos segmentos y ha salido de otro segmento. La exportación también incluye el atributo de perfil nombre, apellidos, fecha de nacimiento y dirección de correo electrónico personal. Las identidades de este perfil son ECID y correo electrónico.

{
  "person": {
    "birthDate": "YYYY-MM-DD",
    "name": {
      "firstName": "John",
      "lastName": "Doe"
    }
  },
  "personalEmail": {
    "address": "john.doe@acme.com"
  },
  "segmentMembership": {
   "ups":{
      "7841ba61-23c1-4bb3-a495-00d3g5fe1e93":{
         "lastQualificationTime":"2022-01-11T21:24:39Z",
         "status":"exited"
      },
      "59bd2fkd-3c48-4b18-bf56-4f5c5e6967ae":{
         "lastQualificationTime":"2022-01-02T23:37:33Z",
         "status":"realized"
      },
      "947c1c46-008d-40b0-92ec-3af86eaf41c1":{
         "lastQualificationTime":"2021-08-25T23:37:33Z",
         "status":"realized"
      },
      "5114d758-ce71-43ba-b53e-e2a91d67b67f":{
         "lastQualificationTime":"2022-01-11T23:37:33Z",
         "status":"realized"
      }
   }
},
  "identityMap": {
    "ecid": [
      {
        "id": "14575006536349286404619648085736425115"
      },
      {
        "id": "66478888669296734530114754794777368480"
      }
    ],
    "email_lc_sha256": [
      {
        "id": "655332b5fa2aea4498bf7a290cff017cb4"
      },
      {
        "id": "66baf76ef9de8b42df8903f00e0e3dc0b7"
      }
    ]
  }
}

A continuación, se muestran más ejemplos de datos exportados, según la configuración de la interfaz de usuario seleccionada en el flujo de destino de conexión para Incluir nombres de segmentos y Incluir marcas de tiempo de segmentos opciones:

"segmentMembership": {
        "ups": {
          "5b998cb9-9488-4ec3-8d95-fa8338ced490": {
            "lastQualificationTime": "2019-04-15T02:41:50+0000",
            "status": "realized",
            "createdAt": 1648553325000,
            "updatedAt": 1648553330000,
            "mappingCreatedAt": 1649856570000,
            "mappingUpdatedAt": 1649856570000,
            "name": "First name equals John"
          }
        }
      }

"segmentMembership": {
        "ups": {
          "5b998cb9-9488-4ec3-8d95-fa8338ced490": {
            "lastQualificationTime": "2019-04-15T02:41:50+0000",
            "status": "realized",
            "createdAt": 1648553325000,
            "updatedAt": 1648553330000,
            "mappingCreatedAt": 1649856570000,
            "mappingUpdatedAt": 1649856570000,
          }
        }
      }

Límites y directiva de reintentos

En el 95 por ciento de los casos, Experience Platform intenta ofrecer una latencia de rendimiento de menos de 10 minutos para los mensajes enviados correctamente con una tasa de menos de 10 000 solicitudes por segundo para cada flujo de datos a un destino HTTP.

En caso de solicitudes fallidas al destino de la API HTTP, el Experience Platform almacena las solicitudes fallidas y las reintenta dos veces para enviar las solicitudes al extremo.

Recursos de Business.Adobe.com