API de Simpliers CHAT
Lista, publica y despublica tus automatizaciones.
Última actualización: 10 de septiembre de 2026
Alcance
Esta API lee y cambia el estado de las automatizaciones creadas en el panel. No existen endpoints para crear, editar o borrar una automatización, ni para enviar mensajes.
- La autenticación funciona con una clave Bearer en la cabecera Authorization. La clave se crea en el panel y su valor completo se muestra solo en el momento en que se crea.
- El nivel de acceso de una clave se fija al crearla y no cambia después: eliges o solo ver, o ver con publicar y despublicar.
- Las peticiones se envían solo desde un servidor. Las peticiones que llevan la cabecera Origin devuelven 403, así que un navegador o una aplicación móvil no pueden usar esta API.
- El límite es de 120 peticiones por minuto por clave y 300 por minuto por IP. Una petición por encima del límite devuelve 429.
Autenticación
Cada petición lleva una sola clave. No se envía ningún id de cuenta con la petición. La clave se crea en el panel, en la parte de claves de API de la pestaña Integraciones de la configuración de la cuenta.
- Abre la configuración de la cuenta en el panel y ve a la parte de claves de API de la pestaña Integraciones.
- Crea una clave nueva y elige su nivel de acceso.
- Guarda la clave en las variables de entorno de tu servidor.
La clave se envía en la cabecera Authorization en cada petición:
Authorization: Bearer smpl_... La clave no puede ir incrustada en un navegador ni en una aplicación móvil. Una petición que lleva la cabecera Origin devuelve 403 browser_origin_not_allowed, porque el navegador añade esa cabecera a cada petición.
Niveles de acceso
El nivel de acceso se elige al crear la clave y no puede cambiar durante toda la vida de la clave.
Solo ver
Lee la lista de automatizaciones. Las peticiones que cambian el estado devuelven 403 missing_scope.
Ver y gestionar
Lee la lista de automatizaciones; publica o despublica una automatización.
Endpoints
Todos los endpoints están bajo https://api.simpliers.com.
Los comandos se ejecutan en la terminal. Cambia {flowId} por el id de la automatización y "smpl_..." por tu clave. Las peticiones de publicar y despublicar no envían cuerpo.
Listar automatizaciones
GET /api/v1/chat/flows?status=published
Los parámetros se separan por comas. El parámetro status=published devuelve solo las automatizaciones publicadas y status=unpublished solo las despublicadas. Sin el parámetro se listan todas las automatizaciones de la cuenta. "limit" define el tamaño de página. El tamaño de página es 25 por defecto y 100 como máximo. El flowId viene también de esta respuesta.
curl -H "Authorization: Bearer smpl_..." \ "https://api.simpliers.com/api/v1/chat/flows?status=published"
Publicar una automatización
POST /api/v1/chat/flows/{flowId}/publish
curl -X POST -H "Authorization: Bearer smpl_..." \ "https://api.simpliers.com/api/v1/chat/flows/{flowId}/publish"
Despublicar una automatización
POST /api/v1/chat/flows/{flowId}/unpublish
Una automatización despublicada no corre hasta que se publique otra vez, y su configuración no se borra.
curl -X POST -H "Authorization: Bearer smpl_..." \ "https://api.simpliers.com/api/v1/chat/flows/{flowId}/unpublish"
Códigos de respuesta
Para los errores, la respuesta trae un objeto error con los campos code y message. El code es estable, el texto del message puede cambiar.
{ "error": { "code": "missing_scope", "message": "..." }}
- 403 browser_origin_not_allowedSi la petición tiene una cabecera Origin, o sea que vino de un navegador, devuelve un error. La clave se usa solo desde un servidor.
- 403 missing_scopeLa clave no está en el nivel de acceso que necesita este endpoint. Una clave de solo ver no puede cambiar el estado.
- 404 flow_not_foundLa automatización no se encontró. Una automatización de otra cuenta también devuelve este código.
- 429 rate_limit_exceededSe superó el límite de peticiones. La misma petición se puede repetir un minuto después.
Reglas y límites
Reglas para una clave:
- Límite de peticiones120 peticiones por minuto por clave, 300 por minuto por IP. Una petición por encima del límite devuelve 429 rate_limit_exceeded.
- Alcance de la cuentaNo se envía ningún id de cuenta con la petición, y una clave solo ve las automatizaciones de su propia cuenta.
- Cuenta bloqueadaSi account.effective en la respuesta es blocked, una automatización no corre aunque parezca publicada. La petición responde con éxito y la automatización no se dispara.
- Rotación de claveEl nombre y el nivel de acceso de una clave no se editan después. Puedes crear una clave nueva y cambiar el valor en tu servidor.