Primeros pasos
Documentación completa de la API
Integra Zyron Connect Suite con n8n, backends propios, CRMs externos y rutinas internas usando endpoints REST versionados.
Visión general
La API v1 opera siempre dentro de la cuenta dueña de la clave. Cada lectura, creación, actualización y envío queda limitado al usuario autenticado por Bearer.
URL base
Usa siempre la URL completa abajo. Los ejemplos de esta documentación ya están listos para copiar.
https://connect.zyronstack.com/api/v1Autenticación
Envía el header Authorization en todas las llamadas. Crea la clave en Dashboard > API. Las claves nuevas pueden verse nuevamente tras confirmar la contraseña del usuario.
Authorization: Bearer SUA_CHAVE_APILímite de solicitudes
El límite es por clave y por plan: 120 solicitudes por minuto en los planes Básico y Oficial, 300 en Agency. Al excederlo, la API devuelve HTTP 429 con el header Retry-After.
Paginación
Los listados aceptan limit y offset. La respuesta incluye pagination.limit, pagination.offset, pagination.total y pagination.next_offset.
OpenAPI JSON
GET https://connect.zyronstack.com/api/v1/openapi.json
OpenAPI JSONMonte seus exemplos
Cole os valores da sua conta uma vez
Os exemplos não usam UUIDs fictícios: onde faltar um valor, aparece <NOME_DO_VALOR>. A chave fica só na memória deste navegador.
Identifique a conexão
Use o número da instância direto, ou copie connection_id em GET /connections.
Envie ou faça upload
Cada tipo tem sua rota: /messages/text, /media, /template ou /interactive.
Acompanhe a entrega
O 202 apenas aceita; consulte o status pelo wamid.
Baixe mídia recebida
Leia a mensagem, consulte GET /media/:id e chame a URL de download.
Primeros pasos
Errores
Las fallas devuelven JSON estandarizado con error.code y error.message.
| 400 invalid_body / query_error | JSON inválido o error de consulta |
| 401 unauthorized | clave ausente, inválida o revocada |
| 403 forbidden | la clave no tiene el alcance requerido |
| 403 upgrade_required | el recurso exige plan Oficial o Agency |
| 404 not_found | recurso no encontrado en la cuenta autenticada |
| 422 validation | campo obligatorio ausente o valor inválido |
| 429 rate_limited | protección excepcional contra abuso |
{ "error": { "code": "unauthorized", "message": "Chave de API ausente ou inválida." } }Módulo
Módulos
Explora los endpoints por área del producto, con ejemplos listos para cada operación.