Nesta página
Brasil Terras Raras
Português (Brasil)

Visão geral da API proprietária

A API proprietária reúne, em um snapshot versionado, as camadas e os indicadores usados pela experiência pública do mapa.

Como o mapa consome a API

O cliente público consulta o endpoint de bootstrap da API de mapa e recebe um documento JSON. A leitura solicita conteúdo atualizado e declara explicitamente o formato aceito.

Antes de montar as camadas, a aplicação valida a versão do esquema, a versão do snapshot e o caminho dos mosaicos vetoriais. Um contrato incompatível interrompe o carregamento em vez de exibir dados ambíguos.

OperaçãoContrato atual
Bootstrap do mapaGET https://api.brasilterrasraras.com.br/v1/map/bootstrap?client=ownership-color-v1
Formatoapplication/json
Cache no clienteno-store

Contrato do snapshot

A resposta identifica a versão e a validade do conjunto publicado. Também apresenta contagens operacionais para que a interface consiga verificar o volume entregue.

v1
versão esperada do esquema
JSON
formato de resposta
3
estados possíveis por fonte
  • schemaVersion: versão esperada do formato.
  • snapshotVersion: identificador da publicação carregada.
  • generatedAt e expiresAt: geração e validade do snapshot.
  • counts: totais de hexágonos detalhados, hexágonos de visão geral, áreas pontuadas, áreas vinculadas e feições.

Camadas e fontes entregues

O snapshot separa dados vetoriais, coleções de feições e sobreposições raster. Cada fonte informa seu estado como pending, ready ou error, permitindo que o mapa indisponibilize somente a camada afetada.

  • Estados e registros minerais.
  • Recursos do GeoSGB.
  • Eventos ambientais e sísmicos.
  • Sobreposições raster com seus endereços de mosaicos.
  • Caminho dos mosaicos vetoriais usados nas áreas de oportunidade.

Escopo documentado

Esta página descreve o contrato consumido pela experiência pública do Mapa Mineral. Ela não anuncia uma API aberta de uso geral nem concede acesso a operações internas.