Resumen
El APIs Playground es donde construyes, configuras y pruebas endpoints reutilizables — sin código. Cada endpoint mapea una operación interna de CXF (obtener contenido, products, bookings, el contact actual, …) a una ruta de la Contact API limpia, con los parámetros que eliges exponer. Los endpoints impulsan tu propio sitio o app y los consumen los Funnels, Events & Automation y los Bundles. Para ver cómo encaja en la plataforma, consulta Conceptos básicos.Dónde encontrarlo
El APIs Playground está en Orchestration → APIs Playground.APIs Playground vs. Docs explorer. El APIs Playground es donde construyes,
administras y pruebas endpoints — llenas parámetros, los ejecutas e inspeccionas la
respuesta. Endpoints en el Docs explorer es la
referencia de cliente HTTP (forma de los requests, cURL) que le pasarías a alguien
para que llame tu endpoint desde sus propias herramientas (Postman, etc.).
Cómo se construye un endpoint
No conectas rutas a mano. Partes de una Library — un tipo de endpoint pre-cableado que ya sabe qué operación de CXF llamar y a qué módulo pertenece:- Elige una library (p. ej. Stories, Products, Me, Funnel flow).
- La library fija automáticamente algunos parámetros (por ejemplo, Stories fija el tipo de contenido) y te exige proveer otros (por ejemplo, qué template de contenido leer).
- Configuras y expones los parámetros restantes.
| Tipo | Devuelve |
|---|---|
| Collection | Una lista de registros. |
| Single | Un registro. |
| Action | Una operación de escritura (crear, actualizar, disparar). |
Parámetros
Los parámetros de un endpoint controlan qué puede pasar quien llama y qué queda fijo:| Modo | Comportamiento |
|---|---|
| Fixed | Un valor bloqueado que quien llama no puede cambiar. |
| Exposed | Quien llama puede sobrescribirlo en runtime. |
| Hidden | Auto-fijado tras bambalinas; no se muestra. |
| Input type | Para |
|---|---|
text-input · number-input · boolean-input | Texto libre, números, toggles. |
list-input | Un dropdown de opciones. |
object-selector | Elegir un registro existente (template, product, …). |
query-builder | Un filtro visual; puedes exponer condiciones individuales. |
sort-input | Un campo + dirección. |
attributes-selector | Qué campos devolver. |
version-selector | Una version de idioma/entorno de contenido. |
json-input | JSON crudo (para bodies de escritura). |
Habilitar y acceso
- Un endpoint arranca deshabilitado — habilítalo para que sea llamable por la Contact API (con una API key).
- La autenticación es asimétrica: un endpoint hereda el requisito de auth de la operación subyacente y puede exigir auth encima de una operación abierta, pero nunca puede quitarle la auth a una operación protegida.
- Un endpoint habilitado queda bloqueado — para cambiarlo, deshabilítalo, edita y vuelve a habilitar.
Probar en el Playground
Cada endpoint tiene un Playground donde puedes ejecutarlo sin salir de CXF:- Test as un contact elegido — para que los endpoints autenticados se resuelvan contra un contact real.
- Llena los parámetros expuestos y (para endpoints de escritura) previsualiza la body structure con tus valores actuales sustituidos en el template.
- Ejecútalo e inspecciona el cURL generado (incluido el header
api-key) y la respuesta.
…/api/v1/endpoints/{slug} con un header api-key. Las
ejecuciones de prueba alcanzan incluso un endpoint deshabilitado, así puedes probar uno
antes de habilitarlo.
Libraries
Una library es una entrada de catálogo de solo lectura que pre-cablea un tipo de endpoint a una operación de CXF, agrupada por módulo. Ejemplos representativos:| Módulo | Libraries |
|---|---|
| Content | Stories, Products, Locations, Blocks, Taxonomies (collection + single), Bundle, Tags. |
| Customer Data | Me, My products, My bookings, My documents, Create document, Update my data, My organizations. |
| Orchestration | Schedules, Booking templates, Event (dispara un event template), Funnel statistics. |
| Engagement | Funnel flow (obtiene la estructura de un funnel o envía datos). |
Logging de requests
Cada llamada externa a un endpoint se registra — el endpoint, la library, el contact autenticado (si lo hay), IP, status code y tiempo de ejecución — para analítica, debug y auditoría. Las llamadas internas (desde funnels, automations, bundles) y las de modo test no se registran, para mantener la analítica limpia.OpenAPI
Puedes generar un spec OpenAPI de todos tus endpoints configurados, para explorarlos en una UI estilo Swagger o entregarlos a clientes externos.Cómo se usan los endpoints
- Funnels — los components y action layers de un funnel llaman endpoints para obtener o enviar datos.
- Events & Automation — la acción endpoint llama uno; habilitar un event template auto-crea un endpoint para él.
- Bundles — agregan varios endpoints en un solo payload.
Seeds
El soporte de Seeds para endpoints está próximamente.Gobernanza y permisos
Solo un super admin o un Master puede crear, habilitar y eliminar endpoints.Acceso por API
La User API gestiona los endpoints (y lista las libraries disponibles), y la Contact API ejecuta un endpoint habilitado por su slug (con una API key). Consulta la API reference.Relacionado
Endpoints (Docs explorer)
La referencia panorámica de API para cómo llamar tus endpoints.
Events & Automation
Llama un endpoint desde un flujo, o expón un event como uno.
Engagement Funnels
Los funnels obtienen y envían datos por endpoints.