Lupap Developers

Autenticación

Para utilizar nuestros servicios de geocodificación solo debes registrarte, obtener una clave y una contraseña y hacer los siguientes llamados a nuestra API vía http.

Recuerda que todos los llamados deben hacer uso de la autenticación básica por http.

Gecodificación (Versión 2)

Gecodificación de direcciones

GET http(s)://api.lupap.co/v2/{country}/{city}?a={address}&[key={WEB_TOKEN}]

Parámetro Descripción
country (Obligatorio) Código de dos letras que representa el país de la dirección a buscar.
city (Obligatorio) Representa la ciudad del país de la dirección a buscar.

  • selecciona un país
address (Obligatorio) Representa la dirección a buscar.
Importante: La dirección debe ser codificada.

key (Opcional) Representa un token de acceso para applicaciones (preferiblemente) web. Por ejemplo para hacer llamados desde javascript (jquery, angular, etc) directamente a nuestro API se puede incluir este parámetro. Los web tokens estan asociados a un API KEY y API SECRET y se pueden crear en el dashboard de administración de tu cuenta.

Gecodificación Reversa

GET http(s)://api.lupap.co/v2/reverse?lon={lon}&lat={lat}&[key={WEB_TOKEN}]

Parámetro Descripción
lon (Obligatorio) Representa la longitud del punto (coordenada) a buscar.
lat (Obligatorio) Representa la latitud del punto (coordenada) a buscar.
key (Opcional) Representa un token de acceso para applicaciones (preferiblemente) web. Por ejemplo para hacer llamados desde javascript (jquery, angular, etc) directamente a nuestro API se puede incluir este parámetro. Los web tokens estan asociados a un API KEY y API SECRET y se pueden crear en el dashboard de administración de tu cuenta.

Respuesta

La respuesta tiene un formato GeoJSON y pueden ser de dos tipos: Las respuestas de un solo resultado seran representadas por un objeto GeoJSON de tipo Feature. Las respuestas de multiples resultados seran representadas por un objeto GeoJSON de tipo FeatureCollection. Cada Feature se define de la siguiente forma: 

// respuesta simple:
{
    "response": {
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [
                -74.04659813699993,
                4.720145423000076
            ]
        },
        "properties": {
            "accuracy": "rooftop",
            "country": "co",
            "city": "bogota",
            "attribution": "geoapps",
            "commonName": "AVENIDA SANTA BARBARA",
            "address": "AK 19 # 135 - 30",
            "postcode": "110121",
            "admin1": "Colombia",
            "admin2": "Bogotá D.C.",
            "admin3": "Bogotá D.C.",
            "admin4": "Usaquen",
            "admin5": "El Contador"
        }
    } 
}

// respuesta múltiple:
{
   "response" : {
      "type" : "FeatureCollection",
      "features" : [ // arreglo de objetos de tipo Feature
          {
              "type" : "Feature",
              "geometry" : {
                  "type" : "Point",
                  "coordinates": [
                      -74.04659813699993,
                      4.720145423000076
                  ]
              },
              "properties" : {
                 "accuracy": "rooftop",
                 "country": "co",
                 "city": "bogota",
                 "attribution": "geoapps",
                 "commonName": "AVENIDA SANTA BARBARA",
                 "address": "AK 19 # 135 - 30",
                 "postcode": "110121",
                 "admin1": "Colombia",
                 "admin2": "Bogotá D.C.",
                 "admin3": "Bogotá D.C.",
                 "admin4": "Usaquen",
                 "admin5": "El Contador"
             }
          }
	 
      ... // mas objetos de tipo Feature

      ]
   }
}
Atributo Descripción
geometry.type Point define el tipo de geometría, para nuestro caso siempre será un punto
geometry.coordinates Una arreglo de dos posiciones con la longitud y la latitud de la dirección [longitud, latitud]
properties.accuracy Representa la exactitud de la ubicación de la dirección. rooftop indica que el punto es ubicado a nivel de la casa, edificio o lote. line_interpolation indica que el punto es una aproximación a nivel de la calle o del frente de manzana
properties.country Representa el código del país
properties.city Representa el código de la ciudad
properties.attribution Representa el tipo de atribución de los datos, puede ser lupap|geoapps|osm
properties.commonName Representa el nombre de la dirección, por ejemplo AVENIDA BOYACA para la AK 72 en Bogotá, Colombia
properties.address Representa la dirección estandarizada.
properties.postcode Representa el código postal, este valor puede ser null
properties.admin1 Representa el nombre del país
properties.admin2 Representa el nombre del departamento
properties.admin3 Representa el nombre del municipio o ciudad
properties.admin4 Representa el nombre de la comuna o localidad. este valor puede ser null
properties.admin5 Representa el nombre del barrio. este valor puede ser null

Estados de respuesta

Código Mensaje Descripción
200
 La consulta fue satisfactoria y se retornaron los resultados
401
 Need authentication Se requiere el tokenKey y el tokenSecret para autenticar la consulta
400
 Verify the parameters Algunos de los paráametros obligatorios no fueron definidos
404
 Application not found El tokenKey no corresponde a una aplicación valida
401
 Not authorized application El tokenKey y/o el tokenSecret no son validos para hacer la consulta
400
 Transactions out of date Las transacciones asignadas a un periodo de tiempo se han vencido.
400
 Not available transactions No hay transacciones disponibles para hacer consultas
404
 Result not found El resultado consultado no se ha encontrado
500
 Hubo un error interno del sistema. En caso de presentarse por favor reportarlo a info@lupap.com

Licencia de datos

Términos y Condiciones de uso  |  2015 -2022© Lupap  - Made with ♥ in Colombia.