Primeiros passos
Documentação completa da API
Integre o Zyron Connect Suite com n8n, backends próprios, CRMs externos e rotinas internas usando endpoints REST versionados.
Visão geral
A API v1 trabalha sempre dentro da conta dona da chave. Toda listagem, criação, atualização e envio é limitado aos recursos do usuário autenticado pela chave Bearer.
URL base
Use sempre a URL completa abaixo. Os exemplos desta documentação já vêm prontos para copiar.
https://connect.zyronstack.com/api/v1Autenticação
Envie o header Authorization em todas as chamadas. Crie a chave em Dashboard > API. Chaves novas podem ser visualizadas novamente no painel após confirmação da senha do usuário.
Authorization: Bearer SUA_CHAVE_APILimite de requisições
O limite é por chave e por plano: 120 requisições por minuto nos planos Básico e Oficial, 300 no Agency. Ao exceder, a API retorna HTTP 429 com o header Retry-After informando quantos segundos aguardar.
Paginação
Listagens aceitam limit e offset. O retorno inclui pagination.limit, pagination.offset, pagination.total e 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.
Primeiros passos
Erros
Falhas retornam JSON padronizado com error.code e error.message.
| 400 invalid_body / query_error | JSON inválido ou falha de consulta |
| 401 unauthorized | chave ausente, inválida ou revogada |
| 403 forbidden | a chave não possui o escopo exigido |
| 403 upgrade_required | o recurso exige plano Oficial ou Agency |
| 404 not_found | recurso não encontrado na conta autenticada |
| 422 validation | campo obrigatório ausente ou valor inválido |
| 429 rate_limited | limite por minuto do plano excedido |
{ "error": { "code": "unauthorized", "message": "Chave de API ausente ou inválida." } }Módulo
Módulos
Cada módulo tem sua própria página, com os endpoints do recurso e exemplos prontos.