Skip to navigation

Visão Geral da Referência da API

URL Base

https://dev.muchau.com.br/api

Exemplo:

https://dev.muchau.com.br/api/messages/send

Autenticação

Todos os endpoints exigem uma chave de API (exceto as rotas públicas de Link de Cadastro):

Authorization: Bearer mk_live_<43-chars>

Veja Autenticação para detalhes.

Formato da requisição

  • Content type: application/json
  • Datas: strings ISO 8601 (ex: 2024-01-15T10:00:00.000Z)
  • Números de telefone: formato internacional sem + (ex: 5511999990000)

Formato da resposta

Todas as respostas são JSON. Respostas bem-sucedidas retornam o recurso diretamente (ou um array/objeto paginado).

Formato de erro

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Number not found",
    "status": 404
  }
}
Status HTTPCódigoDescrição
400VALIDATION_ERRORCorpo da requisição ou parâmetros de query falharam na validação
401UNAUTHORIZEDChave de API ausente, inválida ou revogada
403FORBIDDENRecurso pertence a uma conta diferente
404NOT_FOUNDRecurso não existe
409CONFLICTRecurso já existe (ex: slug duplicado)
429RATE_LIMITEDMuitas requisições — reduza a velocidade
500INTERNAL_ERRORErro do servidor — entre em contato com o suporte

Paginação

Endpoints de listagem retornam uma resposta paginada:

{
  "data": [ ... ],
  "pagination": {
    "total": 42,
    "limit": 20,
    "offset": 0
  }
}

Parâmetros de query:

ParâmetroPadrãoMáximoDescrição
limit20100Número de itens por página
offset0—Número de itens a pular

Limites de taxa

PlanoRequisições por minuto
Starter100
Pro500

Headers de limite de taxa são incluídos em todas as respostas:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 87
X-RateLimit-Reset: 1720000060

Quando excedido: 429 Too Many Requests com um header Retry-After.

Idempotência

O endpoint POST /api/messages/send aceita um header Idempotency-Key:

Idempotency-Key: <string-única>

Requisições repetidas com a mesma chave dentro de 24 horas retornam a resposta original sem reprocessar.