BETA

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ónRequerida (Token de API, Bearer)
HTTP MethodGET
ResponseJSON
Version1

URL del recurso

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

Parámetros

KeyTypeRequiredDescripción
termstringyesTérmino de búsqueda, mínimo 3 caracteres
countrystringyesCódigo ISO del país (2 caracteres). Constantes
excludestringnoLista de códigos de zona separados por coma, a excluir de los resultados
limitintnoCantidad 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).

ObjetoCampoTipoRequeridoDescripción
Response(root)Array of ZoneyesArray de zonas coincidentes
ZonecountryintyesID del país
descriptionstringyesDescripción completa de la zona (ciudad, partido, provincia)
localCodestringyesCódigo local de la zona (jerarquía interna)
seoUrlstringyesSlug de la zona para URLs
codestringyesCó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.