Integración Manual

Introducción

Este método de integración implica la creación de una pequeña API HTTPS en su dominio con la que Fanplayr puede interactuar a través de su JavaScript para almacenar y recuperar el identificador de usuario.

Lectura del valor almacenado en la cookie de identidad de usuario del lado del servidor.

Cuando Fanplayr necesita leer la cookie de identidad de usuario, ejecutará una solicitud al servidor web. Cada uno de los puntos del diagrama anterior se describe aquí:

• Solicitud de lectura de cookie (1) — El JavaScript de Fanplayr ejecuta una solicitud GET desde el navegador a su servidor web en la ubicación definida por la propiedad connect.endpoint en la configuración de JavaScript de Fanplayr.
  
  Si la identidad del usuario se ha almacenado previamente en la cookie y aún existe, el navegador incluirá la cookie en la solicitud al servidor.
• Respuesta de lectura de cookie (2) — Si la cookie está disponible, el servidor web debe leer el valor de la cookie y responder con el valor decodificado al navegador. Este valor será un objeto JSON.

Actualización del valor almacenado en la cookie de identidad de usuario del lado del servidor.

Cuando Fanplayr necesita actualizar el valor almacenado en la cookie de identidad de usuario, ejecutará una solicitud GET con un parámetro data que contiene el valor a almacenar. Cada uno de los puntos numerados del diagrama anterior se describe aquí:

• Solicitud de escritura de cookie (3) — El JavaScript de Fanplayr realiza una solicitud GET desde el navegador a su servidor web en la ubicación definida por la propiedad connect.endpoint en la configuración de JavaScript de Fanplayr.
• Respuesta de escritura de cookie (4) — El servidor responde a la solicitud con una cabecera Set-Cookie que instruye al navegador a almacenar el nuevo valor en la cookie por hasta 1 año en la ruta base del sitio web. Los detalles de implementación se incluyen más adelante en este documento. Finalmente, el servidor incluye el valor de la cookie decodificado como cuerpo de la respuesta.

Cómo funciona

Deberá definir una pequeña API HTTPS en su servidor que leerá o escribirá en una cookie segura en su dominio. La biblioteca JavaScript de Fanplayr invocará esta API desde el navegador cuando necesite recuperar o actualizar el identificador de usuario.

Definición de la URL de su API en el fragmento de seguimiento de página
Defina la propiedad connect tanto para el código de seguimiento de página como para el de seguimiento de pedidos como un objeto con los siguientes valores:

• endpoint
  • Tipo: string
  • Obligatorio
  • Detalles: La URL completa de la API personalizada que implementó
• baseDomain
  • Tipo: string
  • Detalles: Si la cookie necesita ser almacenada

{
  accountKey: '...',
  connect: {
    endpoint: 'https://store.com/api/connect.php',
    baseDomain: 'store.com'
  }
}

Almacenamiento del identificador de usuario
Cuando Fanplayr necesite almacenar el identificador de usuario, realizará una solicitud a su API incluyendo un parámetro de consulta data con el valor a almacenar. Este valor será una cadena JSON codificada en URL. Por ejemplo:

https://store.com/api/connect.php?data=%7B%22value%22%3A%221234%22%7D

• Su API debe escribir el valor en una cookie segura (con el nombre de su elección) con los siguientes atributos:
  • Caduca: (1 año desde la hora actual)
  • HttpOnly
  • Segura
  • SameSite: Strict
  • Ruta: /
• Su API también debe devolver el valor JSON decodificado de la siguiente manera:

{"value":"1234"}

Recuperación del identificador de usuario
Cuando Fanplayr necesite recuperar el identificador de usuario, realizará la misma solicitud API pero sin el parámetro de consulta data, por ejemplo: https://store.com/api/connect.php

• Su API debe leer el valor de la cookie definida en el paso anterior y devolver el valor JSON decodificado de la siguiente manera:

{"value":"1234"}

Código de ejemplo

Los siguientes ejemplos de código demuestran cómo almacenar y recuperar el identificador de usuario utilizando una cookie llamada _fphu:

Si está alojando esta API en un subdominio que está separado del dominio en el que se encuentra el código de seguimiento de Fanplayr, deberá asegurarse de que la API sea compatible con las solicitudes CORS.

Esto generalmente se puede lograr emitiendo las siguientes cabeceras en la respuesta de su API:

• Access-Control-Allow-Origin: https://store.com
  Nota: deberá reemplazar "https://store.com" por su dominio, o asegurarse de que el valor sea el mismo que el valor de la cabecera de solicitud Origin entrante.
• Access-Control-Allow-Methods: OPTIONS, GET
• Access-Control-Allow-Headers: Origin
• Access-Control-Allow-Credentials: true