API

API

¿Qué es el módulo API?
Sirve para integrarse con sistemas de la información, realizar validación, preguntado datos, verificando, relacionarlos con las bases de datos por medio de una función de llamada.  
¿Cómo visualizar el módulo API?
1. Para llegar al módulo se debe identificar en el menú que se encuentra a mano izquierda la pestaña llamada módulos, en ella debe hacer click, al hacerlo se desplegara una serie de sub pestañas en las que debe ubicar la llamada API y hacer click en esta.


Este módulo permite realizar una petición sencilla tipo GET a una API y dependiendo de su respuesta realizar una acción, importante resaltar que dicha API debe responder en formato JSON y que los filtros que se realicen sobre la respuesta que se devuelve deben ser de datos en un primer nivel.


2. Para crear una nueva conexión de API, haremos click en el botón de AGREGAR API



Se desplegará el siguiente formulario:



Este se debe completar con los siguientes datos:

  • Nombre del API: El enunciado que se mostrara al usuario para que realice la validación del API

  • URL del API: ENDPOINT del API, dicha API debe ser público y el método debe ser GET, aquí debe colocarse el ENDPOINT completo. EJEMPLO: http://api.mypagina.com/validacion

  • Hash del API: La mayoría de APIS suelen recibir un atributo como el validador de que el servicio está siendo solicitado por un usuario, por eso exigen el SECRET o ID_CLIENT para que la petición sea válida. En dado caso de que no se utilice así en el servicio que se configura, se pueden colocar cualquier par de datos. Este campo se compone de dos partes:

    • Nombre del atributo: Es el nombre con el que la API recibe este campo. EJEMPLO: secret

    • Hash del API: Es el valor de dicho atributo, suelen ser cadenas de caracteres. EJEMPLO: 1w2e3r4t4trw

  • Nombre atributo a enviar: El atributo que se enviara para que la API haga su proceso, esta primera parte es el nombre con el que recibe dicho atributo. EJEMPLO: cedulaCliente

  • Texto del botón de interacción: El texto que tendrá el botón que ejecutara la API. EJEMPLO: Validar!

  • Texto del botón de no interacción (Opcional): El texto del botón con el que el usuario saltara esta validación y continuara con el comportamiento normal del portal. 

  • Selecciona la pregunta: La pregunta que recogerá el valor que se enviara junto con el nombre del atributo a la API. Se presentarán de la siguiente manera:

    • Si es una pregunta de única respuesta, selección múltiple o lista desplegable. Se presentará como una lista desplegable

    • Si es una pregunta tipo comentario o cualquiera de las demográficas (Nombre, Correo, Celular, Identificación) Se presentará como un campo de texto para llenar. Este suele ser el más utilizado.

Después de completar estos datos básicos, se procederá a configurar el como actuar ante las respuestas del API, así se dará click en AGREGAR OPCIÓN

- Se desplegará una fila abajo con los siguientes campos:
KEY: El nombre del atributo que buscaremos en el JSON que responda la API
VALOR: El valor con el cual filtraremos dicho atributo
ACCION: El recurso que mostraremos si dicha validación de atributo y su valor se cumplen. Aquí existen dos acciones básicamente:

- Mostrar un recurso, ya sea pregunta, texto, imagen, video o aplicar un plan de navegación
- Redirigir a otro portal cautivo a través de la opción de REDIRECCION PERSONALIZADA, esta opción esta de últimas. Si se usa esta función se debe configurar en la zona donde se muestre el portal la función de ZONAS AVANZADAS (por favor buscar esta sección en nuestra base de conocimientos)

EJEMPLO: Configuraremos una conexión API que pedirá el número de cédula del usuario, enviara la API y nos dirá si esa cédula existe (true) o no (false). Si dicha cédula existe le mostrara una imagen y si no existe lo redirigirá a otro portal cautivo.


La respuesta del API se debe generar en formato JSON en una dimensión, de tal manera que el nombre del atributo coincida con el configurado en el módulo (KEY).
Teniendo el cuenta el ejemplo mostrado, la respuesta JSON debería ser del siguiente modo
{"existe": true}
ó
{"existe": false}
3. Guardaremos cambios y nuestra conexión API será creada. Para asignarla a un portal cautivo debemos:
4. Dirigirnos al portal donde queremos se active esta API


5. Ir a la sección de CONFIGURACION AVANZADA y en la opción de CONFIGURAR API seleccionar la API que creamos. Después de esto dar click en GUARDAR CAMBIOS.

Y así es como se visualizara en el portal


    • Related Articles

    • API - MANUAL

      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 ...

    • SMS Proximidad

      ¿Qué es el módulo de SMS Proximidad? Este módulo permite realizar campañas de marketing dirigidas a los usuarios que transiten cerca de los Acces Points con el WI-FI encendido, el uso de este módulo puede generar costos adicionales y solo es ...

    • DIRECCIONES WALLED GARDEN

      Para el óptimo funcionamiento del portal cerciorase tener en la configuración del access point las siguientes direcciones de walled garden  *.datawifi.co res.cloudinary.com  app-dw-img.datawifi.co cdn.datawifi.co *.cloudflare.com *.weglot.com ...

    • Funcionalidades del portal cautivo

      El portal cautivo permite integrar validaciones con métodos externos y personalizar la experiencia de manera que se ajuste a las necesidades, para esto se cuenta con recursos dentro de las configuraciones para este. Estas configuraciones se ...

    • RUCKUS CLOUD V2024

      MANUAL DE CONFIGURACIÓN DE RUCKUS CLOUD REQUISITOS PREVIOS Debido a que Datawifi ya se encuentra registrado como partner oficial de portal cautivo en RUCKUS CLOUD, los parámetros necesarios se llenarán automáticamente. CONFIGURACIÓN EQUIPO Creación ...