Geocode

Multi Geocode API

El objetivo de este último endpoint es devolver las coordenadas geográficas de varias direcciones, ya sean completas o parciales.

Para realizar la solicitud a Multi Geocode es necesario enviar la solicitud utilizando el método POST al siguiente endpoint:

Lista de parámetros

Parámetros obligatorios

  • id – Texto con el identificador de la dirección buscada.

Debe introducirse al menos uno de los siguientes parámetros. No es necesario informar a todo el mundo. No obstante, cuanta más información facilite, más preciso será el resultado.

  • road – Nombre de la calle o parte de ella;
  • number – Número de la calle. NO introduzca los datos del complemento.
  • city – Nombre de la ciudad;
  • state – Estado;
  • country – País;
  • district – Nombre del barrio;
  • zipcode – Código postal.

Para las direcciones fuera de Brasil, deberá añadir el query param globalSearch en la URL, como sigue:
https://api.maplink.global/geocode/v1/geocode?globalSearch=true

Parámetro opcional

  • type – Limita el tipo de investigación. Sólo para direcciones en Brasil y si no se introduce el parámetro globalSearch. Valores posibles:
    • ZIPCODE – Código postal;
    • STATE – Estado;
    • CITY – Ciudad;
    • DISTRICT – Barrio.

Nota: Hay un límite de 200 puntos por enviar la misma solicitud.

Ejemplo 1 – Búsqueda de las coordenadas de dos o más direcciones en la misma solicitud

En este ejemplo vamos a buscar dos direcciones diferentes en la misma petición. Para ello, debemos identificar cada dirección con el parámetro id.

El primero será "Address1" y el segundo "Address2". La solicitud completa puede verse a continuación:

[
    {
        "id": "Address1",
        "road": "Leopoldo Hess",
        "number": 75,
        "district": "São João",
        "zipcode": "88304-260",
        "city": "Itajai",
        "state": "SC"
    },
    {
        "id": "Address2",
        "road": "Alameda Campinas",
        "number": 579,
        "zipcode": "01419-001",
        "city": "São Paulo",
        "state": "SP"
    }
]

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 pista;
      • district – Barrio;
      • zipCode – Código postal;
      • city – Ciudad;
      • state – Estado;
      • mainLocation – Coordenadas geográficas en latitude/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 mayor es el score, mayor será a relevancia del resultado para la dirección solicitada.

A continuación encontrará la respuesta completa:

{
    "found": 2,
    "results": [
        {
            "id": "Address1",
            "address": {
                "road": "Rua Leopoldo Hess",
                "number": "75",
                "district": "São João",
                "zipCode": "88304260",
                "city": "Itajaí",
                "state": {
                    "code": "SC",
                    "name": "Santa Catarina"
                },
                "mainLocation": {
                    "lat": -26.90314282963394,
                    "lon": -48.68023153051618
                }
            },
            "type": "ROAD",
            "score": 154.34358,
            "label": "Rua Leopoldo Hess, 75, São João,Itajaí, Santa Catarina, SC"
        },
        {
            "id": "Address2",
            "address": {
                "road": "Alameda Santos",
                "district": "Cerqueira César",
                "zipCode": "01419001",
                "city": "São Paulo",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
                "mainLocation": {
                    "lat": -23.568495,
                    "lon": -46.650085
                }
            },
            "type": "ZIPCODE",
            "score": 48.98619,
            "label": "Alameda Santos, Cerqueira César,São Paulo, São Paulo, SP"
        }
    ]
}