Documentação completa da API REST v1
v1.0.0Todas as requisições à API devem incluir o header X-API-Key com a sua chave de API.
Obter API Key através de login.
Listar todos os clientes da empresa.
Parâmetros opcionais: ?pagina=1&limite=20
Obter um cliente específico por ID.
Criar um novo cliente.
Listar negócios. Filtro opcional: ?status=aberto
Criar um novo negócio.
Listar contratos da empresa.
Criar um novo contrato.
Listar notas de cobrança.
Criar uma nova nota de cobrança.
Listar tickets de suporte.
Obter ticket com todas as mensagens.
Criar um novo ticket.
Verificar status da API (não requer autenticação).
| Código | Descrição |
|---|---|
200 | Sucesso |
201 | Recurso criado com sucesso |
400 | Requisição inválida (dados faltando ou incorretos) |
401 | Não autenticado (API Key inválida ou ausente) |
403 | Não autorizado (empresa inativa) |
404 | Recurso não encontrado |
405 | Método HTTP não permitido |
500 | Erro interno do servidor |