GET /api/action/portal-v2/zones/suggestions

PROD

Serviço de sugestões de zonas para autocompletar uma localização.

Informações do recurso
Autenticação	Required
Método HTTP	GET
Resposta	JSON
Versão	1

URL do recurso

https://mapaprop.app/api/action/portal-v2/zones/suggestions

Parâmetros

Chave	Tipo	Obrigatório	Descrição
term	string	yes	Termo de busca, mínimo 3 caracteres
country	string	yes	O código ISO do país. Constantes
exclude	string	não	Códigos de zona a excluir das sugestões
limit	int	no	Quantidade de registros a retornar, máximo 100, padrão 10

Exemplo de chamada

GET /api/action/portal-v2/zones/suggestions?term=buenos&country=AR HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

Resposta

Um Array JSON de sugestões de zona, ordenadas por relevância. Não há objeto contêiner: a resposta é a lista.

Objeto	Campo	Tipo	Obrigatório	Descrição
Zone	description	string	sim	A zona com os seus níveis superiores, pronta para exibir
Zone	code	string	sim	O código completo, com o país na frente — o que se usa para filtrar
Zone	localCode	string	sim	O mesmo código sem o país
Zone	seoUrl	string	sim	O seu identificador na URL
Zone	country	int	sim	O id do país
Zone	_id	string	sim	O id interno do documento

Uma mesma localidade pode aparecer várias vezes se existir em mais de uma província — o termpalermo devolve Palermo, Anta, Salta e Palermo, Capital Federal. É por isso que description traz os níveis superiores: é o que torna cada sugestão distinguível.

Exemplo de resposta

[
    {
        "country": 1,
        "description": "General Güemes, General Güemes, Salta",
        "localCode": "17-452-2534",
        "seoUrl": "general-guemes-general-guemes-salta",
        "code": "1-17-452-2534"
    },
    {
        "country": 1,
        "description": "General Alvear, General Alvear, Mendoza",
        "localCode": "13-338-1974",
        "seoUrl": "general-alvear-general-alvear-mendoza",
        "code": "1-13-338-1974"
    },
    {
        "country": 1,
        "description": "General Alvear, General Alvear, Buenos Aires",
        "localCode": "2-179-1431",
        "seoUrl": "general-alvear-general-alvear-buenos-aires",
        "code": "1-2-179-1431"
    },
    {
        "country": 1,
        "description": "General Lavalle, General Lavalle, Buenos Aires",
        "localCode": "2-185-1469",
        "seoUrl": "general-lavalle-general-lavalle-buenos-aires",
        "code": "1-2-185-1469"
    },
    {
        "country": 1,
        "description": "General Arenales, General Arenales, Buenos Aires",
        "localCode": "2-180-1432",
        "seoUrl": "general-arenales-general-arenales-buenos-aires",
        "code": "1-2-180-1432"
    },
    {
        "country": 1,
        "description": "General Hornos, General Las Heras, Buenos Aires",
        "localCode": "2-184-1464",
        "seoUrl": "general-hornos-general-las-heras-buenos-aires",
        "code": "1-2-184-1464"
    },
    {
        "country": 1,
        "description": "General Guido, General Guido, Buenos Aires",
        "localCode": "2-182-1450",
        "seoUrl": "general-guido-general-guido-buenos-aires",
        "code": "1-2-182-1450"
    },
    {
        "country": 1,
        "description": "General Rodriguez, General Rodriguez, Buenos Aires",
        "localCode": "2-190-1065",
        "seoUrl": "general-rodriguez-general-rodriguez-buenos-aires",
        "code": "1-2-190-1065"
    },
    {
        "country": 1,
        "description": "General Pinto, General Pinto, Buenos Aires",
        "localCode": "2-188-1477",
        "seoUrl": "general-pinto-general-pinto-buenos-aires",
        "code": "1-2-188-1477"
    },
    {
        "country": 1,
        "description": "General Belgrano, General Belgrano, Buenos Aires",
        "localCode": "2-181-1443",
        "seoUrl": "general-belgrano-general-belgrano-buenos-aires",
        "code": "1-2-181-1443"
    }
]