Skip to main content

​
Padrões de Resposta

Todas as respostas da API seguem um formato padronizado para garantir consistência e facilitar o consumo pelos clientes.

​
Resposta de Sucesso

{
  "status": "success",
  "data": {
    "id": "uuid-do-recurso",
    "type": "person",
    "attributes": {
      "name": "João Silva",
      "territory": "Zona Norte",
      "created_at": "2026-01-15T10:30:00Z"
    }
  },
  "meta": {
    "request_id": "req-uuid",
    "timestamp": "2026-01-15T10:30:00Z"
  }
}

​
Resposta com Lista (Paginada)

{
  "status": "success",
  "data": [...],
  "meta": {
    "total": 1500,
    "page": 1,
    "per_page": 20,
    "total_pages": 75
  }
}

​
Paginação

Todas as listagens são paginadas por padrão:
ParâmetroTipoPadrãoDescrição
pageinteger1Número da página
per_pageinteger20Itens por página (máximo: 100)
sortstringcreated_atCampo de ordenação
orderstringdescDireção da ordenação (asc ou desc)
Os padrões de resposta serão refinados durante o desenvolvimento. O formato acima é uma proposta inicial baseada em boas práticas de APIs RESTful.