Referência da API
Como a referência está organizada e o que cada módulo cobre.
A referência interativa é gerada a partir do contrato público da API e mostra, para cada operação, o operationId, a credencial aceita e o escopo exigido, os parâmetros, os schemas de pedido e resposta e os erros. O JSON bruto do contrato fica em /openapi/nexus.json, pronto para gerar um cliente na sua linguagem.
Base e formato
- Base:
https://nexus.socialfy.me - Formato: JSON na entrada (
Content-Type: application/json) e na saída. - Credenciais: ver Autorização.
- Contrato atual: versão 1.0.0. A política de mudanças está em Versionamento.
Módulos
| Módulo | O que cobre | Credenciais |
|---|---|---|
| Conexões | Catálogo de recursos por tipo de conexão, para a integração saber o que uma conexão pode fazer antes de usar | pública |
| Instâncias | Criar uma conexão por QR, listar as conexões da conta, consultar o estado e os recursos efetivos de uma linha | sessão, chave da conta (instances:read), chave da linha |
| Mensagens | Enviar mensagem de texto com idempotência | sessão, chave da conta (messages:send), chave da linha |
| Webhooks | Configurar URL, eventos, segredo e espelhamento no CRM para uma linha | sessão |
Módulos em prévia (afiliação, checkout, pagamentos) entram na referência quando cumprirem o contrato público e forem ligados para todas as contas. O anúncio sai no changelog.
Convenções que valem em todas as operações
instanceIdé o nome da linha escolhido na criação (minúsculas, números e hífen). É chave natural: repetir a criação com o mesmo nome responde409, nunca cria uma segunda.- Telefones são E.164, com
+e código do país:+5511999990000. - Operações que criam ou enviam aceitam
Idempotency-Key. Ver Limites e idempotência. - Erros têm sempre o mesmo formato, descrito em Erros.
200ou201significa "aceito". Entrega de mensagem se confirma pelo estado ou pelo webhook.
O que não está na referência
Rotas do painel, rotas administrativas e recursos em prévia não aparecem na referência pública e não fazem parte do contrato. Se a sua integração depende de algo que não está lá, fale com o suporte antes de construir: o caminho certo costuma ser pedir a operação no contrato público, não contornar.
Seu próximo passo está na Central de Ajuda Nexus.