GET /api/action/mapaprop-chat-ai-v1/zones/suggestions

BETA

Serviço de sugestões de zonas para autocompletar uma zona a partir de um termo de busca. Diferente de GET /api/action/mapaprop-chat-ai-v1/zones, não está limitado às zonas onde o cliente tem propriedades: busca no catálogo geográfico completo do país indicado.

Informações do recurso
Autenticação	Obrigatória (Token de API, Bearer)
Método HTTP	GET
Resposta	JSON
Versão	1

URL do recurso

https://mapaprop.app/api/action/mapaprop-chat-ai-v1/zones/suggestions

Parâmetros

Chave	Tipo	Obrigatório	Descrição
term	string	sim	Termo de busca, mínimo de 3 caracteres
country	string	sim	Código ISO do país (2 caracteres). Constantes
exclude	string	não	Lista de códigos de zona separados por vírgula, a excluir dos resultados
limit	int	não	Quantidade de registros a retornar. Por padrão `10`, máximo `100`

Código de exemplo

GET /api/action/mapaprop-chat-ai-v1/zones/suggestions?term=palermo&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 de zonas correspondentes, retornado diretamente (sem objeto contêiner).

Objeto	Campo	Tipo	Obrigatório	Descrição
Response	(root)	Array of Zone	sim	Array de zonas correspondentes
Zone	country	int	sim	ID do país
	description	string	sim	Descrição completa da zona (cidade, município, estado)
	localCode	string	sim	Código local da zona (hierarquia interna)
	seoUrl	string	sim	Slug da zona para URLs
	code	string	sim	Código completo da zona, com prefixo de país

Exemplo de resposta

[
    {
        "country": 1,
        "description": "Palermo, Capital Federal",
        "localCode": "1-46",
        "seoUrl": "palermo-capital-federal",
        "code": "1-1-46"
    },
    {
        "country": 1,
        "description": "Palermo Soho, Palermo, Capital Federal",
        "localCode": "1-50",
        "seoUrl": "palermo-soho-palermo-capital-federal",
        "code": "1-1-50"
    }
]

Se faltar term, country, ou term tiver menos de 3 caracteres, ou country não tiver exatamente 2 caracteres, o serviço responde HTTP 400 com {"error": "REQUIRED_INPUT", "description": "validation failed"} ou {"error": "INPUT_TOO_SHORT", "description": "validation failed"}, conforme o caso. Um código de país ISO não reconhecido pela Mapaprop também produz um erro.