API de Geocodificación Versión 2
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.
Geocodificación de direcciones
GET http(s)://api.lupap.co/geocoder/v2/{country}/{city}?address={address}&criteria={criteria}
| 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.
|
| address |
(Obligatorio) Representa la dirección a buscar.
Importante: La dirección debe ser
codificada.
|
|
criteria
|
(Opcional)
Representa el criterio de búsqueda su valor por defecto es geocode.
Este párametro solo es valido para Colombia
- geocode Valor por defecto, busca la dirección exacta y retorna sus resultados si existen.
|
Geocodificación reversa
GET http(s)://api.lupap.co/geocoder/v2/reverse?lon={longitude}&lat={latitude}
| Parámetro |
Descripción |
| lon |
(Obligatorio) Representa la longitud del punto (coordenada) a buscar.
|
| lat |
(Obligatorio) Representa la latitud del punto (coordenada) a buscar.
|
Encabezados de respuesta
| Encabezado |
Descripción |
| x-geoapps-credits |
Define el número de créditos utilizados en la petición.
|
| x-geoapps-credits-total |
Define el total de créditos de tu aplicación. Este encabezado se omite si tu aplicación tiene créditos ilimitados
|
| x-geoapps-credits-remaining |
Define el total de créditos disponibles de tu aplicación. Este encabezado se omite si tu aplicación tiene créditos ilimitados
|
| x-geoapps-credits-used |
Define el total de créditos utilizados por tu aplicación. Este encabezado se omite si tu aplicación tiene créditos ilimitados
|
| x-geoapps-credits-reset |
Define los segundos restantes para que los créditos de tu aplicación puedan ser utilizados. Este encabezado se omite si tu aplicación tiene tiempo ilimitado
|
Respuesta de Geocodificación
La respuesta tiene un formato GeoJSON y pueden haber dos posibilidades:
Respuestas con un solo resultado:
{
"response" : {
"type" : "Feature",
"geometry" : {
"type" : "Point",
"coordinates" : [
-74.00000, //longitud
4.0000 //latitud
]
},
"properties" : {
"country" : "CODIGO DE GEOCODIFICACION DEL PAIS",
"city" : "CODIGO DE GEOCODIFICACION DE LA CIUDAD",
"attribution" : "geoapps O osm",
"commonName" : "NOMBRE COMUN DE LA DIRECCION",
"address" : "DIRECCION ESTANDARIZADA",
"postcode" : "CODIGO POSTAL",
"admin1" : "DIVISION ADMINISTRATIVA DE 1 NIVEL, POR EJEMPLO PAIS",
"admin2" : "DIVISION ADMINISTRATIVA DE 2 NIVEL, POR EJEMPLO ESTADO",
"admin3" : "DIVISION ADMINISTRATIVA DE 3 NIVEL, POR EJEMPLO CIUDAD",
"admin4" : "DIVISION ADMINISTRATIVA DE 4 NIVEL, POR EJEMPLO LOCALIDAD/COMUNA"
"admin5" : "DIVISION ADMINISTRATIVA DE 5 NIVEL, POR EJEMPLO BARRIO",
}
}
}
Respuestas de múltiples resultados:
{
"response" : {
"type" : "FeatureCollection",
"features" : [ // arreglo de objetos de tipo Feature
{
"type" : "Feature",
"geometry" : {
"type" : "Point",
"coordinates" : [ -74.0460522178427, 4.739304039357506 ]
},
"properties" : {
"country" : "CODIGO DE GEOCODIFICACION DEL PAIS",
"city" : "CODIGO DE GEOCODIFICACION DE LA CIUDAD",
"attribution" : "geoapps O osm",
"commonName" : "NOMBRE COMUN DE LA DIRECCION",
"address" : "DIRECCION ESTANDARIZADA",
"postcode" : "CODIGO POSTAL",
"admin1" : "DIVISION ADMINISTRATIVA DE 1 NIVEL, POR EJEMPLO PAIS",
"admin2" : "DIVISION ADMINISTRATIVA DE 2 NIVEL, POR EJEMPLO ESTADO",
"admin3" : "DIVISION ADMINISTRATIVA DE 3 NIVEL, POR EJEMPLO CIUDAD",
"admin4" : "DIVISION ADMINISTRATIVA DE 4 NIVEL, POR EJEMPLO LOCALIDAD/COMUNA"
"admin5" : "DIVISION ADMINISTRATIVA DE 5 NIVEL, POR EJEMPLO BARRIO",
}
}
... // mas objetos de tipo Feature
]
}
}
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
