El objetivo de este primer endpoint es devolver las coordenadas geográficas de una dirección completa o parcial.

• Lista de parámetros
• Ejemplo 1 – Búsqueda de coordenadas a partir de la dirección
• Ejemplo 2 – Búsqueda de coordenadas a partir del código postal
• Ejemplo 3 – Búsqueda de direcciones internacionales

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

• https://api.maplink.global/geocode/v1/geocode – POST

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

Lista de parámetros

Parámetros obligatorios

Es obligatorio informar al menos a uno. No es necesario informar todos. 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.

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 coordenadas a partir de la dirección

En el siguiente ejemplo, solicitaremos las coordenadas de la dirección "Alameda Campinas, 579, São Paulo - SP, CEP 01404-100". La solicitud completa figura a continuación:

{    
    "road": "Alameda Campinas",
    "number": 579,
    "city": "São Paulo",
    "state": "SP",   
    "zipcode": "01404100" 
}

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 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.

A continuación encontrará la respuesta completa:

{
    "found": 1,
    "results": [
        {
            "id": "2342cca0-f4bf-44fb-89da-fae4632d7ff6",
            "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": 66.25707,
            "label": "Alameda Campinas, Jardim Paulista, 01404100, São Paulo, São Paulo, SP"
        }
    ]
}

Nota: Cuanto más alto sea el score mayor será la relevancia del resultado para la dirección solicitada. Por ejemplo, si la solicitud tiene todos los elementos de dirección rellenados y se han encontrado en la base cartográfica, se espera una puntuación más alta. Si la solicitud sólo contiene un código postal, por ejemplo, la puntuación será más baja.

Ejemplo 2 – Búsqueda de coordenadas a partir del código postal

En este ejemplo, vamos a realizar una solicitud utilizando únicamente el código postal 01014-000:

{
    "zipcode": "01014000"
}

A continuación encontrará la respuesta completa:

{
    "found": 1,
    "results": [
        {
            "address": {
                "road": "Rua Boa Vista",
                "district": "Centro",
                "zipCode": "01014000",
                "city": "São Paulo",
                "state": {
                    "code": "SP",
                    "name": "São Paulo"
                },
                "mainLocation": {
                    "lat": -23.6424087754,
                    "lon": -46.5619422622
                }
            },
            "type": "ZIPCODE",
            "score": 24.653545,
            "label": "Rua Boa Vista, Centro, 01014000, São Paulo, São Paulo, SP"
        }
    ]
}

Ejemplo 3 – Búsqueda de direcciones internacionales

Para buscar direcciones en otros países, deberá añadir el parámetro globalSearch a la URL, como se indica a continuación: https://api.maplink.global/geocode/v1/geocode?globalSearch=true

A continuación se muestra una solicitud de la dirección "Av. Córdoba 5869, CABA, Argentina":

{
    "road": "Av. Córdoba",
    "number": 5869,
    "city": "CABA",
    "country":"Argentina"
}

A continuación encontrará la respuesta completa:

{
    "found": 1
    "results": [
        {
            "address": {
                "road": "Avenida Córdoba",
                "district": "Palermo",
                "zipCode": "C1188AAQ",
                "city": "Buenos Aires",
                "state": {
                    "code": "",
                    "name": "Ciudad Autónoma de Buenos Aires"
                },
                "country": "Argentina",
                "mainLocation": {
                    "lat": -34.5977459,
                    "lon": -58.4198975
                }
            },
            "score": 26.520788,
         "label": "Avenida Córdoba, Palermo, Buenos Aires, Argentina"
        }
   ],
}