Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs-attestly.code4source.com/llms.txt

Use this file to discover all available pages before exploring further.

Um source é um dataset curado — tipicamente um registro de polígonos ou uma lista de identificadores de subject — usado como lado direito de um match. Exemplos:
  • br:funai:indigenous-territories — registro oficial de terras indígenas
  • br:ibama:embargoed-areas — áreas embargadas por infrações ambientais
  • br:icmbio:conservation-units — unidades de conservação federais
  • ofac:sdn — lista OFAC SDN dos EUA
  • br:car:rural-properties — Cadastro Ambiental Rural

Listando o que está disponível

GET /v1/sources
Retorna metadados de todo source que sua Organização pode acessar — nome, kind, cobertura por país e timestamp do último refresh. Filtrar por kind:
GET /v1/sources?kind=subject_register
Existem três kinds:
  • leaf — um source espacial regular.
  • group — uma coleção virtual que expande para várias leaves; selecionar um group é equivalente a consultar todos os seus membros.
  • subject_register — source não-espacial, indexado por identificadores tipados (CNPJ, EIN, OFAC SDN). Carrega uma lista supported_schemes.

Atualização

Cada source carrega collected_at_latest — o timestamp do último refresh. Os sources são atualizados em uma cadência apropriada à fonte upstream. Se uma fonte upstream estiver indisponível no momento da query, o check afetado é marcado como failed e o status do verdict vira degraded. A request ainda retorna 2xx com o resultado parcial, para que você decida como tratar.

Referenciando sources

Em um ruleset:
{
  "sets": {
    "protected_overlap": {
      "source": "br:icmbio:conservation-units",
      "join": { "op": "intersects", "target": "$input" }
    }
  }
}
Em /v1/intersections e /v1/distance, você pode consultar todos os sources de uma vez (default) ou restringir a um específico via reference_areas_source.