Eventos API personalizados - WispHub.net

Eventos API personalizados

Los eventos API personalizados en el router permiten conectarse a sistemas en los cuales tengan administrando servicios de televisión o telefonía y por de medio de sus APIs realizar acciones desde WispHub como activar y desactivar los servicios mencionados.

Para configurar los eventos API personalizados se debe seguir los siguiente pasos:

1Elegir un router

Ingresamos al listado de routers y damos click en editar un router, de preferencia que se un router en donde tenga sus clientes a los cuales quiera asignarles servicios de televisión o telefonía.

2Activar los eventos de api personalizados

Una vez seleccionado el router debemos dar click en la pestaña con el texto Eventos API personalizados y posteriormente activamos la opción Activar api personalizada

 

Al activar esta opción ya podrá activar ó desactivar servicios de telefonía y televisión con el tipo de corte por Método Address list mas detalles de este tipo de servicios en el siguiente manual: Metodo Address list, también una vez activado le mostrara un formulario para configurar sus eventos los se explicaran en el paso 3

3Configurar los eventos de API

Ahora procederemos a llenar las siguientes secciones del formulario:

  1. Ingresa tu domonio: Es la url base de la API del sistema en donde tenga sus servicios de telefonía o televisión la cual nos servira para hacer las petición HTTP a la API.

    Ejemplo: http://prueba.adminolt.com/

  2. Plataformas externas: Son configuraciones ya establecidas de sistemas que administran servicios de telefonía y televisión, esto quiere decir que si selecciona una de estas opciones llenara en automático el resto del formulario y unicamente tendrá que poner la llave de autenticación en el campo API Key para poder autenticarse esto solo si la API lo requiere.

    NOTA:

    Si selecciono una de las opciones de Plataformas externas bastara con ingresar la llave de autenticación de su sistema en el campo API Key de este formulario esto solo si su sistema lo requiere, por ultimo solo tiene que guardar los cambios, una vez hecho esto ya NO es necesario que seguir los siguientes pasos de este manual.

    Actualmente solo hay 3 configuraciones establecidas de 3 sistemas los cuales son: AdminOLT, SmartOLT y Xtream UI, si el sistema que usa es otro a los ya mencionados tendrá que consultar la documentación de API de su sistema para poder completar este formulario.

  3. Header: Es formato el cual usara para autenticarse con la API del sistema que usa, Ejemplo: Token {api_key}, el tag {api_key} solo puede ser usado en este campo y valor de este tag lo tomara de lo que defina en API Key el cual es el siguiente campo del formulario, si la API no requiere método de autenticación dejar vació este campo.
  4. API key: Es la llave de la API para poder hacer la autenticación.
  5. Content Type: Es el tipo de contenido el cual retornara la API, Ejemplo: application/json
  6. Parametros(payloads): Son los datos que se requieran enviar a través de la API, Ejemplo: onus_external_ids={sn_onu},actualmente puede usar los siguientes tags en el payloads:

    {sn_onu}: devolvera los numero(s) de serie de las ONUs de sus servicio de Telefonía o Televisión
    {username_sistema}: devolverá el usuario del servicio de Telefonía o Televisión
    {password_sistema}: devolverá la contraseña del servicio de Telefonia o Televisión
    {external_id}: devolverá el id externo del servicio de Telefonía o Televisión

La valor para estos tags los tomara de los servicios de telefonía o televisión que le asigne a sus clientes desde WispHub, para saber como agregar servicios puedes revisar el siguiente manual: Agregar Servicios de Telefonía o Televisión

La mayoría de esta información para llenar en esta sección la obtendrá de la documentación de API del sistema que este usando.

La siguientes secciones a llenar en el formulario son: Activar Servicio y Desactivar Servicio las cuales son muy similares por lo que bastara con explicar solo la sección de Activar Servicio.

  1. URL para activar: Es la URL con Ia cual se hara la petición HTTP para activar los servicios de telefonia o de televisión, esto lo podra saber con mas detalle en la documentación del sistema en donde este administrando sus servicios, si metodo que se utilizara es post defenirlo con el siguiente parametro metodo_wisphub=post  si es get metodo_wisphub=get esto seguido del carácter &.

    En la siguiente imagen se mostrara un ejemplo de como prodria ser una URL para activar:

    De igual forma si necesita enviar mas parámetros en la url los puede agregar y también usar los siguientes tags:

    {sn_onu}: devolverá los numero(s) de serie de las ONUs de sus servicio de Telefonía o Televisión
    {username_sistema}: devolverá el usuario del servicio de Telefonia o Televisión
    {password_sistema}: devolverá la contraseña del servicio de Telefonia o Televisión
    {external_id}: devolverá el id externo del servicio de Telefonía o Televisión

  2. Respuesta esperada de la API al desactivar: Esta es la respuesta que se espera que retornara la url para activar que se definio en el campo anterior al momento de hacer petición  para activar un servicio de telefonía o televisión. Esta información lo sabras consultando a la documentacion de la API del sistema que estes usando.

4Guardar cambios

Finalmente damos click en el botón Guardar conservar nuestra configuración.

Una vez configurado su router con los Eventos de API personalizados ya podrá configurar sus servicios de telefonía o televisión para que se activen o desactiven mas detalles sobre esto en el siguiente manual: Configuración para corte del servicio


25 de Abril de 2023 a las 14:27 - Visitas: 2252