Saltar a contenido

Endpoints de la API

API de administración (backend del SPA Vue)

Todas las rutas de administración están bajo /fabfacebookpixel/api/ y están protegidas por la autenticación de administración de PrestaShop. Son consumidas exclusivamente por el panel SPA de Vue y no están destinadas a ser una API pública.

Punto de entrada del SPA

Método Ruta Descripción
GET /fabfacebookpixel Renderiza la shell del SPA Vue (SpaController::renderApp)

Contexto

Método Ruta Descripción
GET/POST /fabfacebookpixel/api/context_selection Devuelve las tiendas, idiomas, monedas y países disponibles para el selector de contexto de la interfaz

Configuración del píxel

Método Ruta Descripción
GET/POST /fabfacebookpixel/api/pixel_settings Lista todas las configuraciones de píxel para la tienda actual
POST /fabfacebookpixel/api/pixel_settings/update Crear o actualizar una configuración de píxel
POST /fabfacebookpixel/api/pixel_settings/delete Eliminar una configuración de píxel
Método Ruta Descripción
GET/POST /fabfacebookpixel/api/catalog_settings Obtener la configuración del catálogo para la tienda actual
POST /fabfacebookpixel/api/catalog_settings/update Actualizar la configuración del catálogo
Método Ruta Descripción
GET/POST /fabfacebookpixel/api/catalog_export Listar las configuraciones de exportación del catálogo
GET/POST /fabfacebookpixel/api/catalog_export/create Crear una nueva configuración de exportación
GET/POST /fabfacebookpixel/api/catalog_export/update Actualizar una configuración de exportación
GET/POST /fabfacebookpixel/api/catalog_export/update_chunks Actualizar la configuración de fragmentos para una exportación
GET/POST /fabfacebookpixel/api/catalog_export/delete Eliminar una configuración de exportación

Mapeo de categorías

Método Ruta Descripción
GET/POST /fabfacebookpixel/api/category_mapping Listar los mapeos de categorías
POST /fabfacebookpixel/api/category_mapping/update Crear o actualizar un mapeo de categoría
POST /fabfacebookpixel/api/category_mapping/delete Eliminar un mapeo de categoría
GET/POST /fabfacebookpixel/api/retrieve_external_categories/{provider} Obtener y almacenar la taxonomía de Google o Facebook desde una fuente remota
GET/POST /fabfacebookpixel/api/get_external_categories/{provider} Devolver las entradas de taxonomía almacenadas (proveedor: google o facebook)
GET/POST /fabfacebookpixel/api/get_category_tree Devolver el árbol de categorías de PS para la interfaz
GET/POST /fabfacebookpixel/api/get_categories Devolver una lista plana de categorías

Mapeo de atributos

Método Ruta Descripción
GET/POST /fabfacebookpixel/api/attribute_mapping Listar los mapeos de atributos
POST /fabfacebookpixel/api/attribute_mapping/update Crear o actualizar un mapeo de atributo
POST /fabfacebookpixel/api/attribute_mapping/delete Eliminar un mapeo de atributo

Configuración de la caché

Método Ruta Descripción
GET/POST /fabfacebookpixel/api/cache_settings Obtener la configuración de la caché
POST /fabfacebookpixel/api/cache_settings/update Actualizar la configuración de la caché
POST /fabfacebookpixel/api/cache_settings/clear Limpiar la caché del módulo

Iubenda

Método Ruta Descripción
GET/POST /fabfacebookpixel/api/iubenda Obtener la configuración de Iubenda
POST /fabfacebookpixel/api/iubenda/update Activar o desactivar la integración con Iubenda

Depuración

Método Ruta Descripción
GET/POST /fabfacebookpixel/api/debug Obtener la configuración de depuración y el contenido del registro
POST /fabfacebookpixel/api/debug/update Activar o desactivar el modo de depuración
POST /fabfacebookpixel/api/debug/clear Limpiar el archivo de registro de depuración

Front Controllers

Estos son endpoints accesibles públicamente en la tienda.

ConsumerController

URL: /module/fabfacebookpixel/consumer

Gestiona la cola de eventos del lado del navegador. Es llamado por el script JS del frontend.

Acción (?action=) Método Descripción
poll GET Devuelve el ID de píxel coincidente y todos los eventos JS pendientes para el invitado actual. Respuesta: { pixel: { pixel_id, external_id }, events: [ { id, event_type, js_event } ] }
confirm GET Marca un evento como enviado por JS. Parámetros: id_fbp_event. Respuesta: { ok: true }
revoke GET Elimina todos los eventos JS pendientes para el invitado actual (consentimiento revocado). Respuesta: { ok: true }

CatalogExportController — procesamiento por fragmentos

URL: /module/fabfacebookpixel/catalogexport

Parámetro Descripción
token Obligatorio. El token de la configuración de exportación.
type Opcional. full (predeterminado), lang o country. Selecciona qué archivo de feed transmitir cuando esté completo.

Comportamiento:

  • Si el bloqueo de exportación está en uso por otro proceso: HTTP 409 con { error: "Export already in progress." }
  • Si la exportación todavía está procesando fragmentos: HTTP 200 con progreso JSON { status, currentChunk, totalChunks, processedProducts }
  • Si la exportación está completa: transmite el archivo CSV solicitado como Content-Type: text/csv

CatalogfeedController — solo descarga

URL: /module/fabfacebookpixel/catalogfeed

Parámetro Descripción
token Obligatorio. El token de la configuración de exportación.
type Opcional. full (predeterminado), lang o country.

Comportamiento:

  • Si el archivo de salida no existe (exportación no ejecutada aún): HTTP 404
  • Si el archivo existe: transmite el CSV como Content-Type: text/csv