Introdução

Bem-vindo à documentação da API Matias! Aqui você encontra tudo o que precisa para integrar nossos serviços.

Descrição

A API foi desenvolvida seguindo os padrões REST, proporcionando uma experiência simples e compatível. Todas as respostas são fornecidas no formato JSON.

Base URL

# Produção
https://api.usematias.com/v1

# Desenvolvimento
http://localhost:3000/v1

Formato de Resposta

Todas as respostas seguem o formato padronizado abaixo:

Resposta de sucessojson
{
  "success": true,
  "data": { ... },
  "timestamp": "2026-02-15T12:00:00.000Z"
}
Resposta de errojson
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Token de autenticação expirado",
    "statusCode": 401,
    "timestamp": "2026-02-15T12:00:00.000Z",
    "path": "/v1/auth/me",
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Rate Limiting

Tipo de RotaLimiteJanela
API Geral100 req1 minuto
Autenticação5 req1 minuto
Upload10 req1 minuto

Swagger UI

Para testar os endpoints interativamente, acesse o Swagger UI disponível em /api.