API Personalizada

Introducción

Es posible que aún no admitamos su plataforma para introducir datos en Fanplayr 360, por lo que ofrecemos una potente API para trabajar directamente con nuestro sistema y añadir datos.

Puede utilizar la API Personalizada para enviar datos desde un servidor o una aplicación móvil. Las opciones son ilimitadas.

La API de JavaScript utiliza exactamente las mismas llamadas internamente.

Envío de Mensajes

Una vez que haya creado una Integración Personalizada antes de comenzar, obtendrá una WRITE_KEY y un ENDPOINT que podrá utilizar para enviar datos a Fanplayr 360.

Llamar a la API es tan sencillo como hacer una solicitud HTTPS con los siguientes detalles:

• URL: https://<ENDPOINT>/v1/collect;
• Método: POST;
• Encabezados
  • content-type: application/json;
  • x-api-key: <WRITE_KEY>;
• Cuerpo: Una cadena JSON que contiene una matriz de Mensajes.

Ejemplo de Solicitud

WARNING

La API solo puede manejar mensajes de ~250kb, por lo que recomendamos llamar a la API con no más de 20 Mensajes en una sola llamada.

Estructura del Mensaje

Cada mensaje que envía a Fanplayr 360 debe contener un conjunto básico de datos.

Mensaje Básico

• messageId - Cada mensaje que envíe debe incluir un identificador único. Sugerimos usar un UUID, nanoID o ulid.
• writeKey - La WRITE_KEY que se envía en el x-api-key también debe proporcionarse aquí.
• timestamp - La hora en que ocurrió el evento en formato ISO-8601 y zona horaria UTC, por ejemplo, "2023-01-23T15:34:48Z".
• type - El tipo de mensaje.
• userId - Un identificador único para este usuario. Si se proporciona el mismo userId en una sesión diferente, los mensajes se tratarán como si fueran del mismo usuario. Esto es independiente de la gestión de identidad mediante llamadas identify.
• sessionId - Un identificador único para una sesión. Consulte Gestión de Sesiones para más detalles.
• pageId - Un identificador único para la vista de página / pantalla actual. Se utiliza para vincular eventos. Consulte Seguimiento de Vistas de Página.

La estructura básica del mensaje puede o no incluir context, properties, identities y operations dependiendo del type que se envíe.

• context - se puede usar en cualquier tipo de mensaje
• properties - solo debe usarse en mensajes de tipo track o page
• identities - solo debe usarse en mensajes de tipo identify
• operations - solo debe usarse en mensajes de tipo userDataOps y consent

Contexto

El contexto se utiliza para rastrear información sobre la página o pantalla en la que se encuentra el usuario, su dirección IP para la ubicación y el userAgent para rastrear el tipo de navegador o dispositivo.

• page
  • url - la URL de la página, si se realiza un seguimiento en un sitio web.
  • referrer - la URL de la página de referencia, si se realiza un seguimiento en un sitio web.
  • type - una cadena que representa la página. Se puede utilizar cualquier valor aquí, pero algunos valores añadirán funcionalidad - vea API de JavaScript / Rastreo de Páginas. También se puede usar para representar "pantallas" en una aplicación móvil.
  • title - el título de la página web o de la pantalla de la aplicación.
• ipAddress - la dirección IP del dispositivo del usuario, o del servidor/dispositivo desde el que se envió este mensaje. Se utiliza para generar atributos adicionales como $country.
• userAgent - la cadena de User Agent de un navegador, o definida para un tipo de dispositivo como un teléfono móvil. Se utiliza para generar atributos adicionales como $device.

Propiedades

Las propiedades son cualquier par clave/valor, o Objeto Semántico, que desea rastrear junto con el evento. Esto solo debe usarse con mensajes de tipo track o page.

INFO

La key para una propiedad puede ser cualquier valor de cadena. Se sugiere no iniciar el valor con "$" ya que esto podría anular atributos generados. También podría ser una buena práctica usar claves en camel-case como "myKeyName", y evitar caracteres no ASCII, ya que algunos sistemas a los que exporte datos podrían tener problemas de otra manera.

INFO

Aunque puede enviar tipos string, number o boolean, todos los datos se almacenan como cadenas en Fanplayr 360.

Identidades

Las identidades son pares clave/valor que permiten al sistema saber cómo identificar y fusionar usuarios y sesiones. Esto solo debe proporcionarse para el tipo de mensaje identify.

Operaciones

Las operaciones solo deben usarse con los mensajes de tipo userDataOps y consent. Las propiedades admitidas son diferentes para cada uno.

operacionesDeDatosDeUsuario

consentimiento

¿Qué sigue?

Continúe leyendo para comprender cómo utilizar cada tipo de mensaje, junto con ejemplos.

• Gestión de Sesiones
• Seguimiento de Vistas de Página
• Seguimiento de Eventos
• Gestión de Identidad
• Gestión de Consentimiento