Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.5 KB

README.md

File metadata and controls

49 lines (34 loc) · 1.5 KB

BRAMON - API

API da BRAMON.

Autenticação

Todos os requests (com excessão do namespace public) deverão conter o cabeçalho de autorização e seu token de operador como valor.

Authorization: Bearer XOXOXOXOXOXOXOXO

Onde XOXOXOXOXOXOXOXO é a chave de API do usuário.

Namespaces

Filters

A API possui alguns filtros que podem ser utilizados em sua requisição GET, para utilizar algum filtro, você adicionar na url: filter[nome-do-filtro]=valor. Exemplo: https://api.bramonmeteor.org/v1/public/stations?filter[state]=SC&filter[city]=Florianópolis

Os filtros disponíveis estão separados por namespace/recurso:

Captures

Filtro Valores permitidos
analyzed true, false
captured_at date (ex: 2020-01-06)
class J8_PHP
interval dates (ex: 2020-01-06,2020-01-10)
station uuid

Stations

Filtro Valores permitidos
active true, false
city string (ex.: Florianópolis)
country string (ex: Brasil)
state string (ex: SC)
source UFO, RMS