La API Locality_Arg_Database le permitirá validar una localidad del territorio de la República Argentina.
Partiendo del dato conocido que es la localidad, podrá conocer el ID del Paraje donde esta se encuentra, el ID del Código Postal de 4 dígitos y el ID del CPA (Código Postal Argentino).
A partir de estos resultados puede obtener más información si los valida utilizando alguna de nuestras otras APIS de datos geográficos.
Para poder utilizar esta API se debe realizar una llamada con un metodo GET conformándose por:
- Endpoint: https://cont1-virtual1.certisend.com/web/container/api/v1/database/data/ar/geov1/locality
Parámetros: - token-susc: Token obtenido al momento de la suscripción a nivel empresa.
- token-api: Token obtenido al momento de la suscripción a nivel API.
- id_department: ID del departamento en el que se encuentra la localidad (obtenido de la API Department_Arg_Database).
- locality: Nombre o parte del nombre de la localidad (Obligatorio).
- internalid: Parámetro opcional en donde se puede enviar un id interno para su identificación por parte del cliente.
La llamada quedaría de la siguiente manera:
https://cont1-virtual1.certisend.com/web/container/api/v1/database/data/ar/geov1/locality?token-susc=TOKENSUSC&token-api=TOKENAPI&id_department=178&locality=carlos&internalid=114
Una vez realizada la llamada van a recibir los siguientes parámetros:
- state: Tendrá el valor 0 para un parámetro faltante y un 1 en el caso de que se encuentre información.
- desc: Descripción del parámetro "state" recibido.
- data: Conjunto de información recibida.
- id_locality: ID de la localidad (puede usarlo para filtrar los resultados en la API Streets_Arg_Database).
- locality: Nombre de las localidades encontradas.
- id_department: ID del departamento encontrado (el mismo puede ser reutilizado para filtrar resultados en la API Locality_Arg_Database colocando el ID en el parámetro "id_department").
- department: Nombre del departamento donde se encuentra la localidad.
- id_cpa: ID del CPA correspondiente a la localidad (el mismo puede ser reutilizado para averiguar la latitud y longitud del CPA en la API CPA_Arg_Database).
- id_cp: ID del CP correspondiente a la localidad.
- id_province: ID de la provincia a la que pertenece la localidad.
- province: Nombre de la provincia de la localidad consultada.
- cpa: Descripción del CPA (Código Postal Argentino).
- cp: Detalle del Código Postal.
- id_internal: Id interno ingresado por el cliente.
Respuestas de Ejemplo:
Negativa:
{"state":"0","desc":"localidad requerida.","id_internal":"0"}
Positiva:
{"state":"1","desc":"localidades encontradas.","data":[{"id_locality":"40174","locality":"RIO TURBIO","id_department":"442","department":"GUER AIKE","id_cpa":"0","id_cp":"0","id_province":"20","province":"SANTA CRUZ","cpa":null,"cp":null}],"id_internal":""}
Se encuentra a disposición para consultar la documentación técnica, revisar los parámetros de entrada/salida y evaluar las respuestas de la api accediendo a nuestro API-Doc. Así mismo si se registra gratuitamente en nuestro sistema, puede acceder a generar sus Token de Prueba e ingresar a nuestro portal API-Test