Referência da API

Documentação detalhada de todos os endpoints disponíveis na API Sinapse.

Módulos Disponíveis

Convenções, formatos e padrões da API

Gestão de usuários e perfis

Sistema RBAC e permissões

Casos de doenças e notificações

Todos os endpoints (exceto /health e /auth/login) requerem autenticação via Bearer Token:

Authorization: Bearer SEU_TOKEN_AQUI

{
  "data": { ... },
  "meta": {
    "timestamp": "2025-07-29T10:30:00Z",
    "version": "1.0.0"
  }
}

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Descrição do erro",
    "details": [ ... ]
  }
}

{
  "total": 100,
  "page": 1,
  "size": 20,
  "pages": 5,
  "items": [ ... ]
}

GET /endpoint?page=1&size=50

GET /endpoint?campo=valor&data_inicio=2025-01-01

GET /endpoint?sort=campo&order=desc

GET /endpoint?search=termo

Headers de resposta:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 834
X-RateLimit-Reset: 1627654800

Ambiente	URL
Produção	`https://api.sinapse.org.br/v1`
Staging	`https://api-staging.sinapse.saude.gov.br/v1`
Sandbox	`https://api-sandbox.sinapse.saude.gov.br/v1`

Use o API Explorer para testar endpoints interativamente com sua chave de API!