Magidoc

FAQ

#

Como autenticar minhas requisições?

#

Todas as requisições para a API precisam incluir o header Authorization: Bearer SEU_TOKEN . Para obter o token, utilize a mutation signIn com seu e-mail e senha cadastrados na plataforma. Sua conta precisa estar com o e-mail verificado. Veja o tutorial Sign In para mais detalhes.

Qual é o endpoint correto da API?

#

Aponte suas requisições para https://plataforma.alerta.mapbiomas.org/api/v2/graphql . Para experimentar consultas sem escrever código, utilize o Sandbox .

Preciso de uma conta para consultar a API?

#

Sim, utilize o mesmo login da plataforma. Sua conta MapBiomas Alerta é válida (após verificação de e-mail) para criar um Bearer Token com signIn . Caso precise criar uma conta, acesse https://plataforma.alerta.mapbiomas.org/sign-up . Atualmente, o acesso não possui suporte a conta de serviço — é necessário usar login e senha de usuário.

Qual a diferença entre alerts e alert ?

#

Use a query alerts para listar alertas com filtros e paginação. Use a query alert para obter o detalhe completo de um alerta específico, incluindo laudo e cruzamentos territoriais. Para totais e resumos estatísticos, use alertSummary .

Como consultar a lista de alertas com base nos filtros da plataforma?

#

Para realizar uma consulta com recortes temporais ou espaciais, consulte a documentação da query alerts . Use territoryIds e territoryCategory para filtrar por território — os códigos disponíveis estão em territoryOptions .

Como paginar os resultados?

#

A query alerts utiliza os parâmetros page e limit (padrão: 100 alertas por página). Percorra os resultados usando metadata.currentPage , metadata.totalPages e metadata.totalCount retornados na consulta.

Como consultar um alerta e/ou as informações do laudo?

#

Todas as informações do laudo ou detalhe do alerta podem ser recuperadas pela query alert , informando o código do alerta (alertCode ).

Como obter cruzamentos territoriais (TIs, UCs, embargos etc.)?

#

Os cruzamentos estão consolidados no campo alertIntersections , disponível nas queries alert e alerts . Os campos crossed* estão depreciados e serão removidos em versões futuras. Consulte Consulta de cruzamentos para migrar suas integrações.

Como baixar todos os alertas no formato de planilha (CSV) ou Shapefile?

#

Para baixar todos os alertas publicados, consulte a query relatoryAlert ou acesse https://plataforma.alerta.mapbiomas.org/downloads . Os parâmetros format (csv/shape) e typename (alerts/alertsCars) definem o formato e o tipo de conteúdo.

Posso baixar apenas alertas filtrados?

#

Sim. Para um subconjunto filtrado em Shapefile, utilize a query downloadShapefile , que aceita os mesmos filtros da query alerts . O download é processado de forma assíncrona.

Como consultar alertas por imóvel rural (CAR/SIGEF/SNCI)?

#

Utilize a query ruralProperty com o código do imóvel. Para o laudo de cruzamento alerta/imóvel, consulte alert .

Como obter estatísticas da consulta?

#

Utilize a query alertSummary com os mesmos filtros aplicados em alerts — ela retorna os quantitativos exibidos no painel lateral da plataforma.

Como consultar o histórico de um ponto no mapa?

#

Utilize a query pointInformation informando um boundingBox com as coordenadas do ponto. Veja o exemplo em Histórico do Ponto .

O token de autenticação expira?

#

Sim. O Bearer Token retornado por signIn é um JWT com validade limitada. Quando expirar, realize login novamente para obter um novo token.

Ainda uso a API v1 — como migrar?

#

A API v1 foi descontinuada. O mapeamento principal é: publishedAlerts → alerts , publishedAlert /alertReport → alert . Consulte Migrar da API v1 para detalhes.

Onde obter ajuda técnica?

#

Entre em contato com suporte.alerta@mapbiomas.org ou consulte o FAQ da plataforma em https://alerta.mapbiomas.org/perguntas-frequentes/ .