Pular para o conteúdo

Maestron Developers

Documentação
da API Maestron.

Integre o CRM Maestron à sua stack. Base https://api.maestron.com.br/api/v1, autenticação por API Key e respostas JSON com envelope previsível.

bash — api.maestron.com.br
▋

Conceitos da API

O que vale para qualquer requisição, em qualquer módulo: identidade, isolamento por empresa, formato das respostas, erros e limites.

Autenticação por API Key

Gere a chave em Configurações → API Keys no painel. Envie Authorization: Bearer maestron_pk_… em toda chamada — sem login, sem refresh. Use o prefixo maestron_pk_test_ para testar sem gravar nada de verdade.

Resolução de empresa

A empresa é a dona da chave e é resolvida a partir dela — todo recurso já sai filtrado. Nunca envie identificador de empresa no corpo, query ou header.

Envelope de resposta

Sucesso: { message, data }; listas trazem meta com current_page, per_page, total e last_page. 201 na criação, 200 no restante. Erro: { message, data: null } e, em 422, errors por campo.

Erros & status HTTP

401 chave inválida, 403 sem escopo, 404 recurso inexistente ou de outra empresa, 422 validação ou regra de negócio, 429 rate limit. Erro sempre traz “data”: null; nunca vaza segredo nem stack trace.

Rate limiting

120 requisições por minuto, por chave. As respostas trazem X-RateLimit-Limit e X-RateLimit-Remaining; ao estourar, 429 com Retry-After em segundos.

Versionamento

Toda rota vive sob o prefixo /api/v1. Campo novo na resposta é retrocompatível; mudança que quebra entra numa versão nova, sem alterar a v1.

Módulos da API

Mesma base e autenticação para todos. Cada módulo adiciona seus próprios endpoints sob um prefixo.

Disponível
CRMPipelines, estágios, negócios e atividades./crm
Planejado
EstoqueProdutos, movimentações, inventário e fornecedores.
Planejado
HelpdeskTickets, SLA, base de conhecimento e agentes.
Planejado
MarketingCampanhas, automações, e-mail e segmentação.