Pular para o conteúdo
Maestron Maestron / Docs /

Visão Geral

A API pública Maestron é uma interface REST sobre JSON para integrar sistemas de parceiros ao CRM da sua empresa. Toda comunicação ocorre por HTTPS, com corpos de requisição e resposta em application/json.

Base URL

Seção intitulada “Base URL”

Todas as rotas partem da base URL versionada:

https://api.maestron.com.br/api/v1

Os caminhos documentados ao longo desta referência são relativos a essa base — por exemplo, /crm/deals corresponde a https://api.maestron.com.br/api/v1/crm/deals.

Formato REST/JSON

Seção intitulada “Formato REST/JSON”
  • Os métodos HTTP seguem a semântica REST: GET (leitura), POST (criação e ações), PATCH (atualização parcial), DELETE (remoção).
  • Requisições com corpo enviam Content-Type: application/json.
  • As respostas retornam application/json e usam o código de status HTTP adequado à operação.

Envelope de resposta

Seção intitulada “Envelope de resposta”

Toda resposta de sucesso usa um envelope com message e data:

{
  "message": "Negócio retornado.",
  "data": {}
}
  • message: frase curta em português, sempre com ponto final.
  • data: o recurso (objeto), a coleção (array) ou null em ações sem corpo de retorno relevante.
  • Criação retorna 201; leitura, atualização e ações retornam 200.
  • Listagens incluem o objeto meta de paginação:
{
  "message": "Negócios listados.",
  "data": [],
  "meta": {
    "current_page": 1,
    "per_page": 20,
    "total": 0,
    "last_page": 1
  }
}

Respostas de erro sempre trazem "data": null, e em validação (422) também errors:

{
  "message": "Os dados informados são inválidos.",
  "data": null,
  "errors": {
    "contact_name": ["O campo contact_name é obrigatório."]
  }
}

O detalhamento de cada código de status está centralizado em Erros.

Autenticação

Seção intitulada “Autenticação”

A API pública autentica por API Key, não por login de usuário. Toda requisição envia o segredo da chave no header HTTP Authorization:

Authorization: Bearer maestron_pk_SEU_SEGREDO

A empresa é a dona da chave e é resolvida automaticamente a partir dela — não existe nem deve ser enviado nenhum identificador de empresa. O fluxo completo de geração, escopos e ambientes está em Autenticação.

Identificadores e tipos de dado

Seção intitulada “Identificadores e tipos de dado”
  • IDs são UUID v4 (ex.: b7e8c1a2-3d4f-4a5b-8c9d-0e1f2a3b4c5d), nunca string prefixada por recurso.
  • Valores monetários são inteiros em centavos (ex.: R$ 15.000,00 vira 1500000).
  • Datas e horários usam ISO-8601 (ex.: 2026-06-20T14:30:00.000000Z). Datas puras usam YYYY-MM-DD.

Módulo disponível

Seção intitulada “Módulo disponível”

CRM

Pipelines, estágios, negócios e atividades. Disponível

Próximos passos

Seção intitulada “Próximos passos”