Aller au contenu

Endpoints API

API d'administration (backend du SPA Vue)

Toutes les routes d'administration sont sous /fabfacebookpixel/api/ et sont protégées par l'authentification admin de PrestaShop. Elles sont consommées exclusivement par le tableau de bord SPA Vue et ne sont pas destinées à être une API publique.

Point d'entrée du SPA

Méthode Chemin Description
GET /fabfacebookpixel Rend le shell du SPA Vue (SpaController::renderApp)

Contexte

Méthode Chemin Description
GET/POST /fabfacebookpixel/api/context_selection Retourne les boutiques, langues, devises et pays disponibles pour le sélecteur de contexte de l'interface

Paramètres du pixel

Méthode Chemin Description
GET/POST /fabfacebookpixel/api/pixel_settings Liste toutes les configurations de pixels pour la boutique actuelle
POST /fabfacebookpixel/api/pixel_settings/update Créer ou mettre à jour une configuration de pixel
POST /fabfacebookpixel/api/pixel_settings/delete Supprimer une configuration de pixel

Paramètres du catalogue

Méthode Chemin Description
GET/POST /fabfacebookpixel/api/catalog_settings Obtenir les paramètres du catalogue pour la boutique actuelle
POST /fabfacebookpixel/api/catalog_settings/update Mettre à jour les paramètres du catalogue

Export du catalogue

Méthode Chemin Description
GET/POST /fabfacebookpixel/api/catalog_export Lister les configurations d'export du catalogue
GET/POST /fabfacebookpixel/api/catalog_export/create Créer une nouvelle configuration d'export
GET/POST /fabfacebookpixel/api/catalog_export/update Mettre à jour une configuration d'export
GET/POST /fabfacebookpixel/api/catalog_export/update_chunks Mettre à jour les paramètres de fragments pour un export
GET/POST /fabfacebookpixel/api/catalog_export/delete Supprimer une configuration d'export

Mapping des catégories

Méthode Chemin Description
GET/POST /fabfacebookpixel/api/category_mapping Lister les mappings de catégories
POST /fabfacebookpixel/api/category_mapping/update Créer ou mettre à jour un mapping de catégorie
POST /fabfacebookpixel/api/category_mapping/delete Supprimer un mapping de catégorie
GET/POST /fabfacebookpixel/api/retrieve_external_categories/{provider} Récupérer et stocker la taxonomie Google ou Facebook depuis une source distante
GET/POST /fabfacebookpixel/api/get_external_categories/{provider} Retourner les entrées de taxonomie stockées (provider : google ou facebook)
GET/POST /fabfacebookpixel/api/get_category_tree Retourner l'arbre de catégories PS pour l'interface
GET/POST /fabfacebookpixel/api/get_categories Retourner une liste plate de catégories

Mapping des attributs

Méthode Chemin Description
GET/POST /fabfacebookpixel/api/attribute_mapping Lister les mappings d'attributs
POST /fabfacebookpixel/api/attribute_mapping/update Créer ou mettre à jour un mapping d'attribut
POST /fabfacebookpixel/api/attribute_mapping/delete Supprimer un mapping d'attribut

Paramètres du cache

Méthode Chemin Description
GET/POST /fabfacebookpixel/api/cache_settings Obtenir les paramètres du cache
POST /fabfacebookpixel/api/cache_settings/update Mettre à jour les paramètres du cache
POST /fabfacebookpixel/api/cache_settings/clear Vider le cache du module

Iubenda

Méthode Chemin Description
GET/POST /fabfacebookpixel/api/iubenda Obtenir les paramètres Iubenda
POST /fabfacebookpixel/api/iubenda/update Activer ou désactiver l'intégration Iubenda

Débogage

Méthode Chemin Description
GET/POST /fabfacebookpixel/api/debug Obtenir les paramètres de débogage et le contenu du journal
POST /fabfacebookpixel/api/debug/update Activer ou désactiver le mode débogage
POST /fabfacebookpixel/api/debug/clear Vider le fichier journal de débogage

Front Controllers

Ce sont des endpoints accessibles publiquement sur la vitrine.

ConsumerController

URL : /module/fabfacebookpixel/consumer

Gère la file d'attente d'événements côté navigateur. Appelé par le script JS frontend.

Action (?action=) Méthode Description
poll GET Retourne l'ID pixel correspondant et tous les événements JS en attente pour l'invité actuel. Réponse : { pixel: { pixel_id, external_id }, events: [ { id, event_type, js_event } ] }
confirm GET Marque un événement comme envoyé par JS. Paramètres : id_fbp_event. Réponse : { ok: true }
revoke GET Supprime tous les événements JS en attente pour l'invité actuel (consentement révoqué). Réponse : { ok: true }

CatalogExportController — traitement par fragments

URL : /module/fabfacebookpixel/catalogexport

Paramètre Description
token Obligatoire. Le token de la configuration d'export.
type Optionnel. full (par défaut), lang ou country. Sélectionne le fichier flux à diffuser une fois terminé.

Comportement :

  • Si le verrou d'export est détenu par un autre processus : HTTP 409 avec { error: "Export already in progress." }
  • Si l'export traite encore des fragments : HTTP 200 avec la progression JSON { status, currentChunk, totalChunks, processedProducts }
  • Si l'export est terminé : diffuse le fichier CSV demandé en Content-Type: text/csv

CatalogfeedController — téléchargement uniquement

URL : /module/fabfacebookpixel/catalogfeed

Paramètre Description
token Obligatoire. Le token de la configuration d'export.
type Optionnel. full (par défaut), lang ou country.

Comportement :

  • Si le fichier de sortie n'existe pas (export non encore exécuté) : HTTP 404
  • Si le fichier existe : diffuse le CSV en Content-Type: text/csv