Objetivo

MARKETING WIFI como solución para la comunicación, marketing y autenticación en zonas WiFi e independiente de la arquitectura implementada en sitio (APs, controladoras, etc.) para el funcionamiento de las Zonas WiFi, cuenta con un API para el acceso a la información almacenada y relacionada con su cuenta, se presenta a continuación la documentación requerida para el despliegue e interacción de los datos disponibles en MARKETING WIFI.

Notas de implementación

Tenga en cuenta que con anterioridad debe solicitar la activación/desactivación para el acceso al API, así como el API Key vía correo mesa de ayuda indicando su número de cuenta(s) (NIT, contrato, etc.) de esta forma se garantizará el acceso a la información relacionada con su contrato.

Ejemplos de estructura del API DATAWIFI:

La URL oficial para acceder será suministrada junto con el api_key vía correo electrónico o a través del sistema de tickets (help desk).

Método

A continuación, se lista el método disponible para la consulta de información almacenada y relacionada con su cuenta

Variables

Las siguientes son las variables disponibles para el acceso a la información disponible con su cuenta

 EJEMPLO  

"id": 556,

"nombre_dispositivo": "DATAWIFI @ETB.MINTIC",

"MAC": "00:00:00:00:00:00",

"marca": "Huawei AP",

"descripcion_dispositivo": "Datawifi",

"latitud": "4.6666667",

"longitud": "-79.25",

"id_zona": 0,

"id_cliente": 2000000000,

"ubicacion": "{"latitud":4.667,"longitud":-79.25,"ciudad":"Anzou00e1tegui","pais":"Colombia"}",

"clima": "{"clima":"","fecha":"2018-10-24 12:00:00"}",

"tipo": "AP"

Ejemplo de uso

http://api.datawifi.co/api/v2/APP-Datawifi/_table/dispositivos? api_key=API KEY

Método

A continuación, se lista el método disponible para la consulta de información almacenada y relacionada con su cuenta

Variables

Las siguientes son las variables disponibles para el acceso a la información disponible con su cuenta

EJEMPLO

"mac": "000000000000",

"nombre": "Juan Romero",

"correo": "operaciones@datawifi.co",

"celular": "3133664203",

"edad": "35-44",

"genero": "Masculino",

"os": "android",

"tipo_dispositivo": "smarthphone",

"navegador": "chrome",

"identificacion": "103061500",

"validacion_correo": 1,

"tipo_identificacion": "Cedula",

"cumpleanos": "07-01",

"idioma": "es_MX",

"pais": "",

"foto_facebook": null,

"validacion_celular": null

Ejemplo de uso

http://api.datawifi.co/api/v2/APP-Datawifi/_table/informacion_usuarios? api_key=API KEY

Método

A continuación, se lista el método disponible para la consulta de información almacenada y relacionada con su cuenta

Variables

Las siguientes son las variables disponibles para el acceso a la información disponible con su cuenta

EJEMPLO

"id": 0000001,

"fecha": "2017-03-14 00:00:45",

"enunciado": "Tienes hijos?",

"respuesta": "NO",

"portal": 50,

"mac_dispositivo": 00:00:00:00:00:00,

"mac_usuario": "F48E940F0E0",

"id_cliente": 0000012

Ejemplo de uso

http://api.datawifi.co/api/v2/APP-Datawifi/_table/respuestas?api_key=API KEY 

Método

A continuación, se lista el método disponible para la consulta de información almacenada y relacionada con su cuenta

Variables

Las siguientes son las variables disponibles para el acceso a la información disponible con su cuenta

 EJEMPLO

"id": 0000000,

"fecha": "2018-12-01 15:22:29",

"enunciado": "Califica los servicios de nuestra tienda",

"servicio": "Tiempo de atención",

"valor": 5,

"portal": "1 OPERACIONES",

"mac_dispositivo": "00100f1dccc0",

"mac_usuario": "b800000038c6",

"id_cliente": 00001

Ejemplo de uso

http://api.datawifi.co/api/v2/APP-Datawifi/_table/respuestas_valoraciones?api_key=API KEY 

Método

A continuación, se lista el método disponible para la consulta de información almacenada y relacionada con su cuenta

Variables

Las siguientes son las variables disponibles para el acceso a la información disponible con su cuenta

EJEMPLO

"id": 3,

"nombre_zona": "DataWifi sencillo",

"descripcion_zona": "Portal Sencillo",

"id_cliente": 1234,

"id_portal": 246,

"nombre_plan": "datawif@andresgom",

"ruta_imagen": "1234/Normales/5fbcb612110ee5725a6ac593cc5acf2d.jpeg",

Ejemplo de uso

http://api.datawifi.co/api/v2/APP-Datawifi/_table/zonas?api_key=API KEY

Método

A continuación, se lista el método disponible para la consulta de información almacenada y relacionada con su cuenta

Variables

Las siguientes son las variables disponibles para el acceso a la información disponible con su cuenta

EJEMPLO

"id": 1,

"numero_promocion": 1,

"nombre_promocion": "Básico",

"codigo_bono": "AndresGomez1",

"fecha": "2017-03-13 11:29:26",

"id_portal": 2,

"id_zona": 3,

"usuario": "111111111111",

"id_cliente": 1234,

"estado": 2

Ejemplo de uso

http://api.datawifi.co/api/v2/APP-Datawifi/_table/Bonos?api_key=API KEY

Método

A continuación, se lista el método disponible para la consulta de información almacenada y relacionada con su cuenta

Variables

Las siguientes son las variables disponibles para el acceso a la información disponible con su cuenta

EJEMPLO

"id": 16,

"id_cliente": 1234,

"numero_pregunta": 1,

"tipo_pregunta": "unica_respuesta",

"enunciado": "Cuál es el principal uso que le das a Internet?",

"opcion": "Trabajo",

"estado": 1,

"orden": null

Ejemplo de uso

http://api.datawifi.co/api/v2/APP-Datawifi/_table/Preguntas?api_key= API KEY

Método

A continuación, se lista el método disponible para la consulta de información almacenada y relacionada con su cuenta

Variables

Las siguientes son las variables disponibles para el acceso a la información disponible con su cuenta

EJEMPLO

"id": 00001,

"mac": "aa005fc1cfe",

"sms_fecha": "2018-05-16 18:00:07",

"mensaje": "Hola bienvenido a Datawifi!",

"servicio": "twilio",

"id_cliente": "000000001",

"id_zona": 202,

"nombre": "Juan Romero",

"celular": "+573133664203"

Ejemplo de uso

http://api.datawifi.co/api/v2/APP-Datawifi/_table/Sms?api_key=API KEY 

Método

A continuación, se lista el método disponible para la consulta de información almacenada y relacionada con su cuenta

Variables

Las siguientes son las variables disponibles para el acceso a la información disponible con su cuenta

EJEMPLO

"id": 1,

"usuario": "A08D1688B405",

"id_cliente": 19002453641,

"registro": "[["0","2018-02-19 18:49:07"],["143","2018-02-20 12:26:56"]]"

Ejemplo de uso

 http://api.datawifi.co/api/v2/APP-Datawifi/_table/registro_terminos_condiciones?api_key=API KEY

Método

A continuación, se lista el método disponible para la consulta de información almacenada y relacionada con su cuenta

Variables

Las siguientes son las variables disponibles para el acceso a la información disponible con su cuenta

EJEMPLO

id": 1,

"fecha_creacion": "2018-02-19 19:00:00",

"nombre": "Terminos y condiciones DataWifi",

"descripcion": "",

"id_cliente": "1234",

Ejemplo de uso

 http://api.datawifi.co/api/v2/APP-Datawifi/_table/terminos_condiciones?api_key=API KEY

Método

A continuación, se lista el método disponible para la consulta de información almacenada y relacionada con su cuenta

Variables

Las siguientes son las variables disponibles para el acceso a la información disponible con su cuenta

Ejemplo de uso

 http://api.datawifi.co/api/v2/APP-Datawifi/_table/crm_registrousuarios?api_key=API KEY
 

Anotaciones.

Siguientes datos. 

Al terminar la primera visualización la cual cuenta con 1000 datos se percatará que al final de la página aparece un mensaje el cual dice

"meta": {

    "count": 2101080,

    "next": 1000

  }

Count: es la cantidad de datos los cuales contiene su usuario

Next: siguientes mil datos.

Para acceder a la siguiente página “o siguientes mil datos “de debe incluir la siguiente orden en la url”.

Ejemplo de uso

 http://api.datawifi.co/api/v2/APP-Datawifi/_table/NOMBRE DE LA TABLA ?api_key=API KEYY + &OFFSET=#

Recomendaciones de uso

El Usuario (y quienes estén como destinatarios en este documento a la hora de la entrega del api_key y URL) se comprometen a seleccionar, usar y conservar su llave de conformidad con lo establecido en las siguientes recomendaciones:

-   Las llaves de acceso (API KEY), son personales e intransferibles y son asignadas en atención a las condiciones personales y particulares de cada cliente. El cliente se compromete a hacer un uso diligente de las llaves, así como a no prestar, informar o poner a disposición de terceros sus llaves de acceso.

-   En caso de detección de uso indiscriminado al acceso a la información provista, será restringido el acceso temporalmente con fines de análisis y revisión por parte del equipo de seguridad e ingeniería de DATAWIFI, estas acciones se tomarán de manera preventiva y serán notificados los resultados del análisis posterior levantamiento de la restricción.