Detalle de la API

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/georef/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.
• locality: Nombre o parte del nombre de la localidad (Obligatorio).
• province: Provincia donde se encuentra la localidad.
• department: Departamento donde se encuentra la localidad.
• municipality: Municipalidad donde se encuentra la localidad.
• census_location: Localidad censal.
• internalid: Id interno ingresado por el cliente.

La llamada quedaría de la siguiente manera:
https://cont1-virtual1.certisend.com/web/container/api/v1/database/data/ar/georef/locality?token-susc=TOKENSUSC&token-api=TOKENAPI&locality=carlos&province=buenos%20aires&department=lujan&municipalitylujan&census_location=Carlos%20keen&internalid=5

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.
  • quantity: Tendrá el valor 0 para un parámetro faltante y un 1 en el caso de que se encuentre información.
  • localities: Localidades encontradas y su información.
    • categoria: Clasificación de la localidad encontrada.
    • centroide: Nexo o centro de la localidad encontrada.
      • lat: Latitud correspondiente al centro.
      • lon: Longitud correspondiente al centro.
    • departamento: Departamento al que pertenece la localidad.
      • id: ID del departamento.
      • nombre: Nombre del departamento.
    • id: ID correspondiente a la localidad.
    • localidad censal:  Datos de la localidad censal.
      • id: ID correspondiente a la localidad censal.
      • nombre: Nombre de la localidad censal.
    • municipio: Municipio al que pertenece la localidad.
      • id: ID del municipio.
      • nombre: Nombre del municipio.
    • nombre: Nombre de la localidad encontrada.
    • provincia: Provincia a la que pertenece la localidad encontrada.
      • id: ID de la provincia correspondiente.
      • nombre: Nombre de la provincia correspondiente.
  • parameters: Parámetros de entrada ingresados en la consulta.
    • departamento: Departamento ingresado.
    • localidad_censal: Localidad censal ingresada.
    • nombre: Nombre de la localidad consultada.
    • provincia: Provincia ingresada.
    • amount: Total de resultados encontrados.
• internalid: Id interno ingresado por el cliente.

Respuestas de Ejemplo:

Negativa:

{"state":"0","desc":"locality required."}

Positiva:

{"state":"1","data":[{"quantity":1,"start":0,"localities":[{"categoria":"Localidad simple","centroide":{"lat":-34.4862819813638,"lon":-59.2180861330698},"departamento":{"id":"06497","nombre":"Luján"},"id":"06497020000","localidad_censal":{"id":"06497020","nombre":"Carlos Keen"},"municipio":{"id":"060497","nombre":"Luján"},"nombre":"CARLOS KEEN","provincia":{"id":"06","nombre":"Buenos Aires"}}],"parameters":{"departamento":"lujan","localidad_censal":"Carlos keen","nombre":"carlos","provincia":"buenos aires"},"amount":1}],"id_internal":"5"}

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

Definición Técnica de la API: