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):

1
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

1
{
2
  "error": {
3
    "code": "NOT_FOUND",
4
    "message": "Number not found",
5
    "status": 404
6
  }
7
}

Paginação

Endpoints de listagem retornam uma resposta paginada:

1
{
2
  "data": [ ... ],
3
  "pagination": {
4
    "total": 42,
5
    "limit": 20,
6
    "offset": 0
7
  }
8
}

Parâmetros de query:

Limites de taxa

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

1
X-RateLimit-Limit: 100
2
X-RateLimit-Remaining: 87
3
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:

1
Idempotency-Key: <string-única>

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