Clarisa ofrece una API que le permite a su sistema integrarse y hacer el consumo de las ciudades del mundo.
Las indicaciones para realizar la consulta de las ciudades se hacen a través de una petición HTTP descrita a continuación:
CABECERAS:
| CABECERAS | VALOR |
| Content-Type | application/json |
| Authorization | token de usuario |
METODO: "GET"
Parámetros de URL (QueryParam):
| LLAVE | VALOR | DESCRIPCIÓN |
| nombre | Tunja | Nombre de la Ciudad. |
| codigoPais | COL | Código Alfa 3 del País |
Ejemplo
https://central.clarisacloud.com:8443/comun/rest/api/v1/ciudades?nombre=Tunja&codigoPais=COL
CUERPO:
| Nombre | Tipo dato | Descripción |
|---|---|---|
| nombre | Alfanumérico | Nombre de la ciudad a buscar |
| codigoPais | Alfanumérico | Código Alfa 3 del Pais |
Puedes descargar el siguiente archivo de excel con las ciudades de Colombia
Respuesta:
| Nombre | Tipo dato | Descripción |
|---|---|---|
| success | Booleano | Determina si la operación fué exitosa o no |
| titleResponse | Alfanumérico | Título de la respuesta |
| textResponse | Alfanumérico | Texto de la respuesta |
| lastAction | Alfanumérico | Nombre de la acción bajo la cual se respondió esta respuesta |
| data | Arreglo de las ciudades que encajan con el nombre buscado | |
| id | Numérico | Identificador de la ciudad |
| codigoDian | Numérico | Código DANE de la ciudad. Este código solo existe para ciudades colombianas. |
| ciudad | Alfanumérico | Nombre de la ciudad |
| departamento | Alfanumérico | Nombre del departamento |
| pais | Alfanumérico | Nombre del país |
| codigoPaisAlfa3 | Alfanumérico | Código Alfa 3 del país |
En caso de que no se pueda obtener la información de la ciudad se debe tener en cuenta la variable success y los valores de title_response y text_response para poder mostrar los mensajes respectivos al usuario. La variable title_response contiene el código del error y la variable text_response contiene la descripción del error la cual debe ser mostrada al usuario. Si es errores por validación de datos en data se retorna el total de errores y un array con los errores.
Respuesta TOKEN
Tiene una vigencia de 12 horas, por favor
recuerde utilizar el token asignado en el login, para poder acceder a la API de ciudades.
Correcto
En caso de que la petición se ejecute sin errores se devolverá la siguiente respuesta:
CÓDIGO HTTP: 200
Incorrecto
Si la solicitud no es correcta, recibirá la siguiente respuesta:
CÓDIGO HTTP: 400
Los comentarios están cerrados.