API REST

O Phoenix do RadarBov expõe uma API REST JSON consumida tanto pelo portal web quanto pelo app mobile.


Padrões gerais

  • Formato: JSON
  • Autenticação: JWT no header Authorization: Bearer <token>
  • Paginação: cursor-based ou offset, dependendo do endpoint
  • Busca: endpoints /search com corpo POST para filtros complexos
  • URL base: https://api.radarbov.app (prod) / https://dev.api.radarbov.app (dev)

Endpoints por domínio

Autenticação

MétodoEndpointDescrição
POST/loginAutenticar usuário, receber tokens JWT
POST/refreshRenovar access token
GET/whoamiDados do usuário autenticado
PATCH/self-updateAtualizar dados do próprio usuário

Movimentações de animais

MétodoEndpointDescrição
POST/animals-ingressesRegistrar entrada de animais
POST/animals-ingresses/searchBuscar entradas
POST/animals-egressesRegistrar saída de animais
POST/animals-egresses/searchBuscar saídas
POST/tags-identificationsRegistrar identificação
POST/tags-identifications/searchBuscar identificações

GTAs

MétodoEndpointDescrição
GET/POST/gtasListar / criar GTA
POST/gtas/searchBuscar GTAs com filtros
POST/gtas/uploadEnviar PDF de GTA externa
POST/gtas/inviteCompartilhar acesso temporário à GTA
POST/gtas/unrestricted/searchBusca sem restrição de estabelecimento

Rastreamento

MétodoEndpointDescrição
GET/POST/travelsListar / criar viagem
POST/travels/searchBuscar viagens
GET/POST/vehiclesVeículos
POST/vehicles/searchBuscar veículos

Estabelecimentos e organizações

MétodoEndpointDescrição
GET/POST/establishmentsListar / criar estabelecimento
POST/establishments/searchBuscar com filtros
POST/establishments/unrestricted/searchBusca para convites
GET/POST/organizationsOrganizações

Compartilhamento e convites

MétodoEndpointDescrição
GET/POST/sharesCompartilhamentos ativos
POST/shares/searchBuscar compartilhamentos
GET/POST/invitesConvites
POST/invites/{id}/notifyReenviar notificação de convite

Conformidade socioambiental

MétodoEndpointDescrição
POST/socioenvironmental/establishment_history/searchHistórico por estabelecimento
POST/socioenvironmental/animal_history/searchHistórico por animal

Sincronização mobile

O app mobile sincroniza registros criados offline enviando os mesmos endpoints REST. Quando a conexão é restabelecida, o serviço de sync do app processa a fila de registros pendentes. Ver Modo Offline e Sincronização.


Ver também