El propósito de este tercer endpoint, Suggestions, es devolver coordenadas geográficas desde una dirección proporcionada en la propia URL.

• Lista de parámetros
• Ejemplo 1 – Búsqueda de sugerencias basadas en texto libre

Para realizar una solicitud a Suggestions API es necesario enviar la solicitud mediante el método GET al siguiente endpoint: 

• https://api.maplink.global/geocode/v2/suggestions – GET

Todos los parámetros para obtener las coordenadas geográficas y sugerencias de direcciones se enviarán en la propia URL.

Nota: Actualmente regresa solo a direcciones ubicadas en Brasil.

La Suggestions API se actualizó a la versión 2. El endpoint https://api.maplink.global/geocode/v1/suggestions continuará funcionando, pero se recomienda utilizar el nuevo endpoint  para obtener una mayor precisión de los resultados y porque las nuevas funciones serán exclusivas de la nueva versión.

Lista de parámetros

Parâmetro obrigatório

• q – Introduzca la dirección, o parte de ella.

Parámetros opcionales

• center – Coordenadas de referencia para los resultados de la búsqueda. Formato: center=-23.552088765,-46.6341653162;
• radius – Especifica el radio de búsqueda, en metros, desde el punto central definido en el centro. Si no se informa, el valor por defecto es 500.000 metros (500 km);
• limit – Limita el número de resultados devueltos. Por ejemplo: https://api.maplink.global/geocode/v2/suggestions?limit=1

Ejemplo 1 – Búsqueda de sugerencias basadas en texto libre

En este ejemplo, queremos recibir sugerencias para el texto "Alameda Campinas, 01404100, Jardim Paulista". La solicitud está a continuación:

https://api.maplink.global/geocode/v2/suggestions?q=Alameda%20Campinas,%2001404100,%20Jardim%20Paulista

Nota: Se recomienda describir la dirección con mayor cantidad de información, ordenando los elementos más importantes (Calle, Número, Código Postal, Barrio, Ciudad, Estado) y sin abreviaturas para mayor asertividad de 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 proporcionada en la solicitud;
  • address – Objeto con información de dirección:
    • road – Nombre de la carretera;
    • district – Bairro;
    • zipCode – Código postal;
    • city – Ciudad;
    • state – Estado;
    • mainLocation – Objeto con las coordenadas geográficas del punto:
      • lat – Latitud;
      • lon – Longitud;
  • type – Indica el mejor elemento encontrado en la base de datos cartográfica para devolver la coordenada geográfica;
  • score – Puntuación de referencia del resultado del proceso de geocodificación;
  • label – Dirección completa encontrada utilizada en el proceso de geocodificación.

Nota: Cuanto mayor sea la score, mayor será la relevancia del resultado para la dirección solicitada.

La respuesta completa se puede ver a continuación:

{
    "results": [
        {
            "id": "6684353bf0662a1541ff6385",
            "address": {
                "road": "ALAMEDA CAMPINAS",
                "district": "JARDIM PAULISTA",
                "zipCode": "01404100",
                "city": "SÃO PAULO",
                "state": {
                    "name": "SÃO PAULO",
                    "code": "SP"
                },
                "mainLocation": {
                    "lat": -23.56631144908,
                    "lon": -46.65360036597
                }
            },
            "type": "ROAD",
            "label": "ALAMEDA CAMPINAS, 01404100, JARDIM PAULISTA, SÃO PAULO, SP",
            "score": 85.4173641545432
        },
        {
            "id": "6684353bf0662a1541ff63a2",
            "address": {
                "road": "ALAMEDA CAMPINAS",
                "district": "JARDIM PAULISTA",
                "zipCode": "01404200",
                "city": "SÃO PAULO",
                "state": {
                    "name": "SÃO PAULO",
                    "code": "SP"
                },
                "mainLocation": {
                    "lat": -23.56714829171,
                    "lon": -46.65440337412
                }
            },
            "type": "ROAD",
            "label": "ALAMEDA CAMPINAS, 01404200, JARDIM PAULISTA, SÃO PAULO, SP",
            "score": 67.51744304384503
        },
        {
            "id": "6684353bf0662a1541ff635d",
            "address": {
                "road": "ALAMEDA CAMPINAS",
                "district": "JARDIM PAULISTA",
                "zipCode": "01404000",
                "city": "SÃO PAULO",
                "state": {
                    "name": "SÃO PAULO",
                    "code": "SP"
                },
                "mainLocation": {
                    "lat": -23.5663551335,
                    "lon": -46.65364273168
                }
            },
            "type": "ROAD",
            "label": "ALAMEDA CAMPINAS, 01404000, JARDIM PAULISTA, SÃO PAULO, SP",
            "score": 67.51744304384503
        },
        {
            "id": "6684353bf0662a1541ff63a3",
            "address": {
                "road": "ALAMEDA CAMPINAS 150",
                "district": "JARDIM PAULISTA",
                "zipCode": "01404900",
                "city": "SÃO PAULO",
                "state": {
                    "name": "SÃO PAULO",
                    "code": "SP"
                },
                "mainLocation": {
                    "lat": -23.56343039334,
                    "lon": -46.6507807755
                }
            },
            "type": "ROAD",
            "label": "ALAMEDA CAMPINAS 150, 01404900, JARDIM PAULISTA, SÃO PAULO, SP",
            "score": 63.98775935173035
        },
        {
            "id": "6684353bf0662a1541ff637b",
            "address": {
                "road": "ALAMEDA CAMPINAS",
                "district": "JARDIM PAULISTA",
                "zipCode": "01404001",
                "city": "SÃO PAULO",
                "state": {
                    "name": "SÃO PAULO",
                    "code": "SP"
                },
                "mainLocation": {
                    "lat": -23.56880844109,
                    "lon": -46.65604091167
                }
            },
            "type": "ROAD",
            "label": "ALAMEDA CAMPINAS, 01404001, JARDIM PAULISTA, SÃO PAULO, SP",
            "score": 62.547320382935666
        },
        {
            "id": "6684353bf0662a1541ff63b9",
            "address": {
                "road": "ALAMEDA CAMPINAS",
                "district": "JARDIM PAULISTA",
                "zipCode": "01404002",
                "city": "SÃO PAULO",
                "state": {
                    "name": "SÃO PAULO",
                    "code": "SP"
                },
                "mainLocation": {
                    "lat": -23.57150846699,
                    "lon": -46.65863824537
                }
            },
            "type": "ROAD",
            "label": "ALAMEDA CAMPINAS, 01404002, JARDIM PAULISTA, SÃO PAULO, SP",
            "score": 62.36442055021014
        },
        {
            "id": "6684353bf0662a1541ff637c",
            "address": {
                "road": "ALAMEDA CAMPINAS",
                "district": "JARDIM PAULISTA",
                "zipCode": "01404003",
                "city": "SÃO PAULO",
                "state": {
                    "name": "SÃO PAULO",
                    "code": "SP"
                },
                "mainLocation": {
                    "lat": -23.5727482959,
                    "lon": -46.65984093151
                }
            },
            "type": "ROAD",
            "label": "ALAMEDA CAMPINAS, 01404003, JARDIM PAULISTA, SÃO PAULO, SP",
            "score": 62.36442055021014
        },
        {
            "id": "66842f7b6969121fb9f0de4e",
            "address": {
                "road": "ALAMEDA CAMPINAS",
                "district": "JARDIM PAULISTA",
                "zipCode": "12947480",
                "city": "ATIBAIA",
                "state": {
                    "name": "SÃO PAULO",
                    "code": "SP"
                },
                "mainLocation": {
                    "lat": -23.141018593,
                    "lon": -46.557696254
                }
            },
            "type": "ROAD",
            "label": "ALAMEDA CAMPINAS, 12947480, JARDIM PAULISTA, ATIBAIA, SP",
            "score": 60.32122203281947
        },
        {
            "id": "6684353bf0662a1541ff6359",
            "address": {
                "road": "ALAMEDA CAMPINAS, 433",
                "district": "JARDIM PAULISTA",
                "zipCode": "01404901",
                "city": "SÃO PAULO",
                "state": {
                    "name": "SÃO PAULO",
                    "code": "SP"
                },
                "mainLocation": {
                    "lat": -23.56550964281,
                    "lon": -46.65281726051
                }
            },
            "type": "ROAD",
            "label": "ALAMEDA CAMPINAS, 433, 01404901, JARDIM PAULISTA, SÃO PAULO, SP",
            "score": 58.74167782919748
        },
        {
            "id": "6684343ef0662a1541f5003c",
            "address": {
                "road": "ALAMEDA SARUTAIÁ",
                "district": "JARDIM PAULISTA",
                "zipCode": "01403010",
                "city": "SÃO PAULO",
                "state": {
                    "name": "SÃO PAULO",
                    "code": "SP"
                },
                "mainLocation": {
                    "lat": -23.5689407,
                    "lon": -46.6549067
                }
            },
            "type": "ROAD",
            "label": "ALAMEDA SARUTAIÁ, 01403010, JARDIM PAULISTA, SÃO PAULO, SP",
            "score": 55.39309246199472
        }
    ],
    "found": 10
}