Suggestions API
El objetivo de este tercer endpoint, Suggestions, es devolver las coordenadas geográficas a partir de una dirección proporcionada en la propia URL.
Para realizar la solicitud a Suggestions es necesario enviar la solicitud utilizando el método GET al siguiente endpoint:
La URL enviará todos los parámetros para obtener las coordenadas geográficas y las direcciones sugeridas.
Para direcciones fuera de Brasil, tendrá que añadir el query param globalSearch en la URL, como sigue: https://api.maplink.global/geocode/v1/suggestions?globalSearch=true
Lista de parámetros
Parámetro obligatorio
q– Informar de la dirección o parte de ella.
Parámetros opcionales
globalSearch– Definir si la investigación será global o sólo en Brasil. Valores posibles: true o falsetype– Limita el tipo de investigación. Sólo para direcciones en Brasil y si no se introduce el parámetroglobalSearch. Valores posibles:ZIPCODE– Código postal;STATE– Estado;CITY– Ciudad;DISTRICT– Barrio.
center– Coordenadas de referencia para la búsqueda de resultados. Formato:center=-23.552088765,-46.6341653162;radius– Especifica el radio de búsqueda, en metros, desde el punto central establecido encenter. Si no se introduce, el valor por defecto es 5.000.000 metros (5.000 Km).
Ejemplo 1 – Búsqueda de sugerencias a partir de texto libre
En este ejemplo, queremos obtener sugerencias para el texto "Alameda Campinas, 01404100, Jardim Paulista". La solicitud figura a continuación:
Nota: Cuando se utiliza texto libre para buscar sugerencias en las que no se proporciona type, es aconsejable describir la dirección con toda la información posible, ordenando los elementos más importantes, y sin abreviaturas para que la API pueda comparar mejor el texto buscado con los resultados.
En la respuesta, se devuelve la siguiente información:
found– Número de registros devueltos.results– Array de objetos con todos los resultados encontrados:id– Identificador de la dirección introducida en la solicitud;address– Objeto con información sobre la dirección:road– Nombre de la ruta;district– Barrio;zipCode– Código postal;city– Ciudad;state– Estado;mainLocation– Coordenadas geográficas enlatitude/longitude;
type– Indica el mejor elemento encontrado en la base cartográfica para devolver la coordenada geográfica;score– Puntuación de referencia para el resultado del proceso de geocodificación;label– Dirección completa encontrada utilizada en el proceso de geocodificación.
Nota: Cuanto más alto sea el score mayor será la relevancia del resultado para la dirección solicitada.
A continuación encontrará la respuesta completa:
{
"found": 11,
"results": [
{
"address": {
"road": "Alameda Campinas",
"district": "Jardim Paulista",
"zipCode": "01404100",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.5665,
"lon": -46.65382
}
},
"type": "ZIPCODE",
"score": 37.228725,
"label": "Alameda Campinas, Jardim Paulista, 01404100, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas",
"district": "Jardim Paulista",
"zipCode": "12947480",
"city": "Atibaia",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.1410185925,
"lon": -46.5576962537
}
},
"type": "ZIPCODE",
"score": 25.78013,
"label": "Alameda Campinas, Jardim Paulista, 12947480, Atibaia, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas",
"district": "Jardim Paulista",
"zipCode": "01404002",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.57156,
"lon": -46.65871
}
},
"type": "ZIPCODE",
"score": 25.732224,
"label": "Alameda Campinas, Jardim Paulista, 01404002, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas",
"district": "Jardim Paulista",
"zipCode": "01404200",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.5674342,
"lon": -46.65478485
}
},
"type": "ZIPCODE",
"score": 25.732224,
"label": "Alameda Campinas, Jardim Paulista, 01404200, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas",
"district": "Jardim Paulista",
"zipCode": "01404000",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.5665,
"lon": -46.65382
}
},
"type": "ZIPCODE",
"score": 25.13713,
"label": "Alameda Campinas, Jardim Paulista, 01404000, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas",
"district": "Jardim Paulista",
"zipCode": "01404001",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.56767,
"lon": -46.65498
}
},
"type": "ZIPCODE",
"score": 24.93925,
"label": "Alameda Campinas, Jardim Paulista, 01404001, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas",
"district": "Jardim Paulista",
"zipCode": "01404003",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.5727386,
"lon": -46.65995255
}
},
"type": "ZIPCODE",
"score": 24.93925,
"label": "Alameda Campinas, Jardim Paulista, 01404003, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas 150",
"district": "Jardim Paulista",
"zipCode": "01404900",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.5658,
"lon": -46.65323
}
},
"type": "ZIPCODE",
"score": 24.005688,
"label": "Alameda Campinas 150, Jardim Paulista, 01404900, São Paulo, São Paulo, SP"
},
{
"address": {
"road": "Alameda Campinas 433",
"district": "Jardim Paulista",
"zipCode": "01404901",
"city": "São Paulo",
"state": {
"code": "SP",
"name": "São Paulo"
},
"mainLocation": {
"lat": -23.5658,
"lon": -46.65323
}
},
"type": "ZIPCODE",
"score": 24.005688,
"label": "Alameda Campinas 433, Jardim Paulista, 01404901, São Paulo, São Paulo, SP"
}
]
}
