Getting Started

Do zero à primeira chamada em 6 passos.

1. Base URL

Desenvolvimento local: http://localhost:PORT (a porta vem de appConfig.port). Não documentamos URL de produção aqui — use o valor do seu ambiente. O Swagger expõe o serverUrl configurado via appConfig.baseUrl.

Prefixos reais: Public API → /api/v1/…; Dashboard (JWT) → sem prefixo (/links, /domains, …). Esquemas e exemplos de cada endpoint estão na API Reference.

2. Escolha a autenticação

Dashboard (usuário): registre-se em POST /auth/register e use o accessToken como Authorization: Bearer <token>. Integrações externas: crie uma API Key no Dashboard e envie Authorization: Bearer <API_KEY>. Detalhes em Authentication.

3. Primeira chamada

curl http://localhost:PORT/api/v1/links \
  -H "Authorization: Bearer <API_KEY>"

4. Entenda o response

Sucesso: { "success": true, "data": ... } (envelope aplicado pelo TransformInterceptor). Listas retornam a paginação dentro de data: { data, total, page, pageSize, totalPages }.

{
  "success": true,
  "data": {
    "data": [],
    "total": 0,
    "page": 1,
    "pageSize": 20,
    "totalPages": 0
  }
}

5. Entenda erros básicos

{
  "success": false,
  "error": { "code": "VALIDATION_ERROR", "message": "Invalid request payload" },
  "requestId": "req-01J0000000000000000000000"
}

Validação (Zod) falha com 400, não 422. Veja a lista completa em Errors.

6. Explore a referência

Continue em API Reference (por domínio) ou abra o Swagger para schemas interativos.