Integrazione Manuale

Introduzione

Questo metodo di integrazione prevede la creazione di una piccola API HTTPS sul tuo dominio con cui Fanplayr può interagire tramite il suo JavaScript per memorizzare e recuperare l'identificatore utente.

Lettura del valore memorizzato nel cookie di identità utente lato server.

Quando Fanplayr deve leggere il cookie di identità utente, eseguirà una richiesta al server web. Ciascuno dei punti nel diagramma sopra è descritto qui:

• Richiesta di lettura cookie (1) — Il JavaScript di Fanplayr esegue una richiesta GET dal browser al tuo server web nella posizione definita dalla proprietà connect.endpoint nella configurazione JavaScript di Fanplayr.
  
  Se l'identità dell'utente è stata precedentemente memorizzata nel cookie e esiste ancora, il browser includerà il cookie nella richiesta al server.
• Risposta di lettura cookie (2) — Se il cookie è disponibile, il server web dovrebbe leggere il valore del cookie e rispondere con il valore decodificato al browser. Questo valore sarà un oggetto JSON.

Aggiornamento del valore memorizzato nel cookie di identità utente lato server.

Quando Fanplayr deve aggiornare il valore memorizzato nel cookie di identità utente, eseguirà una richiesta GET con un parametro data contenente il valore da memorizzare. Ciascuno dei punti numerati nel diagramma sopra è descritto qui:

• Richiesta di scrittura cookie (3) — Il JavaScript di Fanplayr effettua una richiesta GET dal browser al tuo server web nella posizione definita dalla proprietà connect.endpoint nella configurazione JavaScript di Fanplayr.
• Risposta di scrittura cookie (4) — Il server risponde alla richiesta con un header Set-Cookie che istruisce il browser a memorizzare il nuovo valore nel cookie per un massimo di 1 anno nel percorso base del sito web. I dettagli di implementazione sono inclusi più avanti in questo documento. Infine, il server include il valore del cookie decodificato come corpo della risposta.

Come funziona

Dovrai definire una piccola API HTTPS sul tuo server che leggerà o scriverà in un cookie sicuro sul tuo dominio. La libreria JavaScript di Fanplayr invocherà questa API dal browser quando avrà bisogno di recuperare o aggiornare l'identificatore utente.

Definizione dell'URL della tua API nello snippet di tracciamento della pagina
Definisci la proprietà connect sia per il codice di tracciamento della pagina che per quello di tracciamento dell'ordine come un oggetto con i seguenti valori:

• endpoint
  • Tipo: string
  • Obbligatorio
  • Dettagli: L'URL completo dell'API personalizzata che hai implementato
• baseDomain
  • Tipo: string
  • Dettagli: Se il cookie deve essere memorizzato

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

Memorizzazione dell'identificatore utente
Quando Fanplayr deve memorizzare l'identificatore utente, effettuerà una richiesta alla tua API includendo un parametro di query data con il valore da memorizzare. Questo valore sarà una stringa JSON codificata in URL. Ad esempio:

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

• La tua API dovrebbe scrivere il valore in un cookie sicuro (con un nome a tua scelta) con i seguenti attributi:
  • Scadenza: (1 anno dall'ora corrente)
  • HttpOnly
  • Secure
  • SameSite: Strict
  • Percorso: /
• La tua API dovrebbe anche restituire il valore JSON decodificato, in questo modo:

{"value":"1234"}

Recupero dell'identificatore utente
Quando Fanplayr deve recuperare l'identificatore utente, effettuerà la stessa richiesta API ma senza il parametro di query data, ad esempio: https://store.com/api/connect.php

• La tua API dovrebbe leggere il valore dal tuo cookie definito nel passaggio precedente e restituire il valore JSON decodificato, in questo modo:

{"value":"1234"}

Codice di esempio

I seguenti esempi di codice dimostrano come memorizzare e recuperare l'identificatore utente utilizzando un cookie chiamato _fphu:

WARNING

Se stai ospitando questa API su un sottodominio separato dal dominio su cui si trova il codice di tracciamento di Fanplayr, dovrai assicurarti che l'API sia compatibile con le richieste CORS.

Questo può essere generalmente ottenuto generando i seguenti header nella tua risposta API:

• Access-Control-Allow-Origin: https://store.com
  Nota: dovrai sostituire "https://store.com" con il tuo dominio, o assicurarti che il valore sia lo stesso del valore dell'header di richiesta Origin in entrata.
• Access-Control-Allow-Methods: OPTIONS, GET
• Access-Control-Allow-Headers: Origin
• Access-Control-Allow-Credentials: true