Documentação

Documentação da API

Referência dos endpoints de ocorrências no API Gateway — parâmetros, campos de resposta e exemplos. Peça a chave em Acesso à API.

API privada. Em produção envie x-api-key. Auth de utilizadores, fórum e conta pessoal não estão documentados aqui.

Autenticação

Chaves começam por oa_ e podem ficar ligadas a IP do servidor e User-Agent.

Header
x-api-key: oa_<a-sua-chave>

Base URL

Resposta típica: { success, data }. Erros usam error.

Produção
https://api.ocorrenciasativas.pt/site

Códigos HTTP

200OK401Não autorizado429Rate limit503Auth misconfigured

Limites

Janela de 1 minuto. Em excesso: 429.

AudiênciaLimite
Chave de parceiro (sem X-Visitor-IP)até 5000 pedidos / minuto
Chave de parceiro + X-Visitor-IPaté 400 pedidos / minuto por visitante
Restantes clientesaté 200 pedidos / minuto por IP

Ocorrências

18 de 18 endpoints. Expanda para ver campos.

Lista ocorrências ativas com filtros e paginação por cursor.

Envelope comum: owner, country, dateTime, version, environment, success, data (+ cache quando aplicável).

Query params

CampoTipoObrigatórioDefaultExemploDescrição
districtstringNão—AveiroFiltrar por distrito (correspondência exacta em `district`).
naturestringNão—FlorestalFiltrar por natureza com LIKE `%valor%` sobre o campo `nature`.
natureCodestringNão—3Filtrar por código de natureza com prefixo (`nature_code LIKE 'valor%'`). Ex.: `3` = incêndios rurais.
limitintegerNão10050Tamanho da página. Máximo aceite: 500.
cursorstringNão—2026-09-15T10:00:00.000ZCursor de paginação. Use o `pagination.nextCursor` da resposta anterior (valor de `dates.last_updated`).

Campos da resposta

CampoTipoDefaultExemploDescrição
dataarray——Lista de ocorrências
paginationobject——limit, hasMore, nextCursor
data[].idstring——Identificador público da ocorrência
data[].datesobject——started, last_updated, finished
data[].means_involvedobject——aerial, aquatic, man, terrain, total_meios
data[].locationobject——district, county, parish, locality, region, subregion
data[].coordinatesobject——latitude, longitude
data[].occurrenceobject——status, natureza, natureCode/category, significant, …
Exemplo cURL
curl -sS "https://api.ocorrenciasativas.pt/site/incidents?district=Aveiro&nature=Florestal&natureCode=3&limit=50" \
  -H "x-api-key: oa_<chave>" \
  -H "User-Agent: ASuaApp/1.0"
Exemplo de resposta
{
  "success": true,
  "data": [
    {
      "id": "…",
      "dates": { "started": "…", "last_updated": "…", "finished": null },
      "means_involved": { "aerial": 0, "aquatic": 0, "man": 12, "terrain": 4, "total_meios": 16 },
      "location": { "district": "Aveiro", "county": "…", "locality": "…" },
      "coordinates": { "latitude": 40.64, "longitude": -8.65 },
      "occurrence": { "status": "Em Curso", "natureza": "…", "significant": false }
    }
  ],
  "pagination": { "limit": 100, "hasMore": false, "nextCursor": null }
}

Ainda sem chave? Pedir acesso · Documentação