Documentação

Documentação da API

Referência dos recursos expostos pelo API Gateway do Ocorrências Ativas. O acesso é restrito a pedidos aprovados — veja como pedir acesso em Acesso à API.

Esta é uma API privada. Os endpoints abaixo não são acessíveis publicamente sem uma chave de acesso válida — esta página serve apenas como referência para entidades cujo pedido de acesso foi aprovado.

Autenticação

Todos os pedidos devem incluir a chave de acesso no cabeçalho:

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

Base da API

Todos os recursos abaixo estão sob o namespace /site/:

GET /site/{recurso}

Ocorrências

Listagem, estado e estatísticas de ocorrências de proteção civil.

DescriçãoCaminho
Listar ocorrênciasGET /site/incidents
Incêndios ativosGET /site/incidents/active-fires
Histórico completoGET /site/incidents/historics/all
natureCategoriesGET /site/incidents/nature-categories
Ocorrências significativasGET /site/incidents/significant
Totais agregadosGET /site/incidents/total-counts
Estatísticas em tempo realGET /site/incidents/stats/live
Estatísticas globaisGET /site/incidents/stats/global
Evolução temporalGET /site/incidents/stats/evolution
Estatísticas horáriasGET /site/incidents/stats/hourly
Estado dos meiosGET /site/incidents/status
Dados agregadosGET /site/incidents/data
Detalhe de uma ocorrênciaGET /site/incidents/{id}

Notícias

Artigos publicados no portal.

DescriçãoCaminho
Listar artigosGET /site/blog
Artigos recentesGET /site/blog/recent
Pesquisar artigosGET /site/blog/search
Tags popularesGET /site/blog/tags/popular
Artigo por slugGET /site/blog/{slug}

Meios e Infraestruturas

Bases aéreas, corpos de bombeiros, viaturas e hospitais.

DescriçãoCaminho
Listar bases aéreasGET /site/airbases
Listar corpos de bombeirosGET /site/departments
Listar distritosGET /site/departments/districts
Listar tipos de departamentoGET /site/departments/types
Listar concelhosGET /site/departments/cities
Detalhe de um departamentoGET /site/departments/{id}
Listar viaturasGET /site/vehicles
Categorias de viaturasGET /site/vehicles/categories
Exportar viaturas (CSV)GET /site/vehicles/export
Detalhe de uma viaturaGET /site/vehicles/{id}
Listar hospitaisGET /site/hospitals

Camadas de Mapa

Dados geoespaciais usados no mapa interativo (incêndios, meteorologia, meios aéreos).

DescriçãoCaminho
Focos de calor (FIRMS)GET /site/map/firms
VentoGET /site/map/wind
Qualidade do arGET /site/map/air-quality
Perigo de incêndioGET /site/map/fire-danger
Impacto de fumoGET /site/map/smoke-impact
Áreas ardidasGET /site/map/burned-areas
Áreas ardidas (histórico)GET /site/map/burned-areas/historic
Infraestruturas críticasGET /site/map/critical-infrastructure
Pós-combateGET /site/map/post-combat
Zonas de preocupação (vento)GET /site/map/wind-concern-zones
Cortes de estradaGET /site/road-closures?closures=1
Aeronaves (posição atual)GET /site/flightradar/aircrafts
Aeronaves (stream)GET /site/flightradar/stream
Corpos de bombeiros (camada)GET /site/departments
Áreas ardidas (incêndios rurais)GET /site/wildfire/burned-areas
Pontos de águaGET /site/wildfire/water-points
Locais críticosGET /site/wildfire/critical-locations

Formulários

Submissões de voluntariado e subscrição de newsletter.

DescriçãoCaminho
Candidatura de voluntárioGET /site/volunteers/apply
Consultar estado da candidaturaGET /site/volunteers/check-status
Subscrever newsletterGET /site/newsletters/subscribe