Servicio de sugerencias de zonas para autocompletar una zona a partir de un término de búsqueda. A diferencia de GET /api/action/mapaprop-chat-ai-v1/zones, no está limitado a las zonas donde el cliente tiene propiedades: busca sobre el catálogo geográfico completo del país indicado.
| Información del recurso | |
|---|---|
| Autenticación | Requerida (Token de API, Bearer) |
| HTTP Method | GET |
| Response | JSON |
| Version | 1 |
URL del recurso
https://mapaprop.app/api/action/mapaprop-chat-ai-v1/zones/suggestions
Parámetros
| Key | Type | Required | Descripción |
|---|---|---|---|
| term | string | yes | Término de búsqueda, mínimo 3 caracteres |
| country | string | yes | Código ISO del país (2 caracteres). Constantes |
| exclude | string | no | Lista de códigos de zona separados por coma, a excluir de los resultados |
| limit | int | no | Cantidad de registros a retornar. Por defecto 10, máximo 100 |
Código de ejemplo
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}
Respuesta
Un array de zonas coincidentes, retornado directamente (sin objeto contenedor).
| Objeto | Campo | Tipo | Requerido | Descripción |
|---|---|---|---|---|
| Response | (root) | Array of Zone | yes | Array de zonas coincidentes |
| Zone | country | int | yes | ID del país |
| description | string | yes | Descripción completa de la zona (ciudad, partido, provincia) | |
| localCode | string | yes | Código local de la zona (jerarquía interna) | |
| seoUrl | string | yes | Slug de la zona para URLs | |
| code | string | yes | Código completo de la zona, con prefijo de país |
Ejemplo de respuesta
[
{
"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"
}
]
Si falta term, country, o term tiene menos de 3 caracteres, o country no tiene exactamente 2 caracteres, el servicio responde HTTP 400 con {"error": "REQUIRED_INPUT", "description": "validation failed"} o {"error": "INPUT_TOO_SHORT", "description": "validation failed"} según el caso. Un código de país ISO no reconocido por Mapaprop también produce un error.