Vai al contenuto

Endpoint API

API di amministrazione (backend del SPA Vue)

Tutte le route di amministrazione sono sotto /fabfacebookpixel/api/ e sono protette dall'autenticazione admin di PrestaShop. Vengono consumate esclusivamente dalla dashboard SPA Vue e non sono destinate ad essere un'API pubblica.

Punto di ingresso del SPA

Metodo Percorso Descrizione
GET /fabfacebookpixel Renderizza la shell del SPA Vue (SpaController::renderApp)

Contesto

Metodo Percorso Descrizione
GET/POST /fabfacebookpixel/api/context_selection Restituisce i negozi, le lingue, le valute e i paesi disponibili per il selettore di contesto dell'interfaccia

Impostazioni pixel

Metodo Percorso Descrizione
GET/POST /fabfacebookpixel/api/pixel_settings Elenca tutte le configurazioni pixel per il negozio corrente
POST /fabfacebookpixel/api/pixel_settings/update Creare o aggiornare una configurazione pixel
POST /fabfacebookpixel/api/pixel_settings/delete Eliminare una configurazione pixel
Metodo Percorso Descrizione
GET/POST /fabfacebookpixel/api/catalog_settings Ottenere le impostazioni del catalogo per il negozio corrente
POST /fabfacebookpixel/api/catalog_settings/update Aggiornare le impostazioni del catalogo
Metodo Percorso Descrizione
GET/POST /fabfacebookpixel/api/catalog_export Elencare le configurazioni di esportazione del catalogo
GET/POST /fabfacebookpixel/api/catalog_export/create Creare una nuova configurazione di esportazione
GET/POST /fabfacebookpixel/api/catalog_export/update Aggiornare una configurazione di esportazione
GET/POST /fabfacebookpixel/api/catalog_export/update_chunks Aggiornare le impostazioni dei frammenti per un'esportazione
GET/POST /fabfacebookpixel/api/catalog_export/delete Eliminare una configurazione di esportazione

Mappatura categorie

Metodo Percorso Descrizione
GET/POST /fabfacebookpixel/api/category_mapping Elencare le mappature delle categorie
POST /fabfacebookpixel/api/category_mapping/update Creare o aggiornare una mappatura di categoria
POST /fabfacebookpixel/api/category_mapping/delete Eliminare una mappatura di categoria
GET/POST /fabfacebookpixel/api/retrieve_external_categories/{provider} Recuperare e memorizzare la tassonomia Google o Facebook da una sorgente remota
GET/POST /fabfacebookpixel/api/get_external_categories/{provider} Restituire le voci di tassonomia memorizzate (provider: google o facebook)
GET/POST /fabfacebookpixel/api/get_category_tree Restituire l'albero categorie PS per l'interfaccia
GET/POST /fabfacebookpixel/api/get_categories Restituire una lista piatta di categorie

Mappatura attributi

Metodo Percorso Descrizione
GET/POST /fabfacebookpixel/api/attribute_mapping Elencare le mappature degli attributi
POST /fabfacebookpixel/api/attribute_mapping/update Creare o aggiornare una mappatura di attributo
POST /fabfacebookpixel/api/attribute_mapping/delete Eliminare una mappatura di attributo

Impostazioni cache

Metodo Percorso Descrizione
GET/POST /fabfacebookpixel/api/cache_settings Ottenere le impostazioni della cache
POST /fabfacebookpixel/api/cache_settings/update Aggiornare le impostazioni della cache
POST /fabfacebookpixel/api/cache_settings/clear Svuotare la cache del modulo

Iubenda

Metodo Percorso Descrizione
GET/POST /fabfacebookpixel/api/iubenda Ottenere le impostazioni Iubenda
POST /fabfacebookpixel/api/iubenda/update Abilitare o disabilitare l'integrazione Iubenda

Debug

Metodo Percorso Descrizione
GET/POST /fabfacebookpixel/api/debug Ottenere le impostazioni di debug e il contenuto del log
POST /fabfacebookpixel/api/debug/update Abilitare o disabilitare la modalità debug
POST /fabfacebookpixel/api/debug/clear Svuotare il file di log di debug

Front Controllers

Questi sono endpoint accessibili pubblicamente nel negozio.

ConsumerController

URL: /module/fabfacebookpixel/consumer

Gestisce la coda degli eventi lato browser. Viene chiamato dallo script JS frontend.

Azione (?action=) Metodo Descrizione
poll GET Restituisce l'ID pixel corrispondente e tutti gli eventi JS in attesa per l'ospite corrente. Risposta: { pixel: { pixel_id, external_id }, events: [ { id, event_type, js_event } ] }
confirm GET Marca un evento come inviato via JS. Parametri: id_fbp_event. Risposta: { ok: true }
revoke GET Elimina tutti gli eventi JS in attesa per l'ospite corrente (consenso revocato). Risposta: { ok: true }

CatalogExportController — elaborazione per frammenti

URL: /module/fabfacebookpixel/catalogexport

Parametro Descrizione
token Obbligatorio. Il token della configurazione di esportazione.
type Facoltativo. full (predefinito), lang o country. Seleziona quale file feed inviare quando completo.

Comportamento:

  • Se il lock di esportazione è detenuto da un altro processo: HTTP 409 con { error: "Export already in progress." }
  • Se l'esportazione sta ancora elaborando i frammenti: HTTP 200 con progresso JSON { status, currentChunk, totalChunks, processedProducts }
  • Se l'esportazione è completa: invia il file CSV richiesto come Content-Type: text/csv

CatalogfeedController — solo download

URL: /module/fabfacebookpixel/catalogfeed

Parametro Descrizione
token Obbligatorio. Il token della configurazione di esportazione.
type Facoltativo. full (predefinito), lang o country.

Comportamento:

  • Se il file di output non esiste (esportazione non ancora eseguita): HTTP 404
  • Se il file esiste: invia il CSV come Content-Type: text/csv