BETA

A cascata: zones1 / zones2 / zones3

São três endpoints que devolvem as mesmas zonas que a lista completa, mas um nível por vez:

zones1  →  as províncias/estados de um país
zones2  →  os municípios de uma província
zones3  →  as localidades/bairros de um município

Servem para resolver um ramo pontual sem baixar as milhares de linhas do país. Se o que você está fazendo é mapear todo o seu catálogo, use a lista completa: é uma chamada a cada mil zonas em vez de uma por ramo.

Informações do recurso
Autenticação	Obrigatória (Token de API, Bearer)
Escopo	`property-api-catalog`
HTTP Method	GET
Response	JSON
Version	1

1 · Províncias de um país

GET https://mapaprop.app/api/action/property-catalog-v1/zones1?country=AR

Key	Type	Required	Descrição
country	string	sim	ISO de 2 letras

[
  { "zone0": 1, "zone1": 2, "description": "Buenos Aires" },
  { "zone0": 1, "zone1": 1, "description": "Capital Federal" }
]

Este nível não traz code, e isso é proposital. Uma província sozinha não é uma zona publicável: todo código válido chega pelo menos até o município. Se houvesse um code aqui, isso convidaria a enviá-lo no objeto do imóvel e não funcionaria. Desça mais um nível.

2 · Municípios de uma província

GET https://mapaprop.app/api/action/property-catalog-v1/zones2?country=AR&zone1=1

Key	Type	Required	Descrição
country	string	sim	ISO de 2 letras
zone1	int	sim	O `zone1` devolvido pelo passo anterior

[
  { "zone0": 1, "zone1": 1, "zone2": 1340, "description": "Abasto", "code": "1-1-1340-0" }
]

Aqui o code vem sim: cada município já é uma zona publicável por si só. Se você souber o município e não a localidade, este código é suficiente.

3 · Localidades de um município

GET https://mapaprop.app/api/action/property-catalog-v1/zones3?country=AR&zone1=2&zone2=201

Key	Type	Required	Descrição
country	string	sim	ISO de 2 letras
zone1	int	sim	A província
zone2	int	sim	O município

[
  { "zone0": 1, "zone1": 2, "zone2": 201, "zone3": 117,
    "description": "Aldo Bonzi", "code": "1-2-201-117" }
]

Uma lista vazia aqui não é um erro: significa que aquele município não tem localidades abaixo e que o código publicável é o do município (zone2 com -0). Acontece com todos os bairros da cidade de Buenos Aires, por exemplo.

Erros

HTTP	error	O que aconteceu
400	`REQUIRED_INPUT`	Falta `country`
400	`VALIDATION`	Falta `zone1` (em `zones2`/`zones3`) ou `zone2` (em `zones3`)
400	`INVALID_INPUT`	O ISO não corresponde a nenhum país
403	`INVALID_PERMISSION`	O seu token não tem o escopo `property-api-catalog`
404	—	Você usou outro método: os três são GET

Veja também

Zonas — o conceito e o formato do código
A lista completa — para mapear o seu catálogo em lote