api/web/docs

Flowdat 3

Flowdat - Cliente JavaScript para Flowdat

API REST V1 para Flowdat.

• API version: 1.0.0

Instalación

Para Node.js

Pruebas locales

Instalación de las dependencias.

npm install

Por último realizar un link de código, se debe reemplazar /path/to/<JAVASCRIPT_CLIENT_DIR> por el path absoluto donde se encuentra el fuente.

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Ejemplos (Descargar)

Dentro de la carpeta test/examples se encuentran los ejemplos comentados para ejecutar las consultas. Para que la librería funcione, se debe modificar el archivo test/examples/baseAuths.js. En este de beben especificar el usuario, password de acceso al sistema de Flowdat y url (https://api.<DOMINIO>) para acceder al servicio.

Ejemplos por curl

Ingresar a https://swagger.<DOMINIO>. Se debe tenen en cuenta que deben ingresarse el usuario y password de Flowdat desde el boton Authorize

API Endpoints

Todas las url son relativas a su dominio. Ejemplo: https://api.<DOMINIO>/api/v1/

Clase	Método	HTTP request	Descripción

Flowdat.AccessApi | callDelete | DELETE /radius/access | Eliminar un acceso.

Flowdat.AccessApi | create | POST /radius/access | Creación de un acceso.

Flowdat.AccessApi | getById | GET /radius/access | Obtener un acceso por id.

Flowdat.AccessApi | getList | GET /radius/accesses | Encuentra access por Id, nombre, perfile, cliente o tenencia.

Flowdat.AccessApi | update | PUT /radius/access | Modificación de un acceso.

Flowdat.CablemodemApi | active | GET /cablemodem/cablemodem/active | Activa un cablemodem.

Flowdat.CablemodemApi | callDelete | DELETE /cablemodem/cablemodem | Eliminar un cablemodem.

Flowdat.CablemodemApi | create | POST /cablemodem/cablemodem | Creación de un cablemodem.

Flowdat.CablemodemApi | disable | GET /cablemodem/cablemodem/disable | Desactiva un cablemodem.

Flowdat.CablemodemApi | getById | GET /cablemodem/cablemodem | Obtener cablemodem por id.

Flowdat.CablemodemApi | getList | GET /cablemodem/cablemodems | Encuentra cablemodem por Id, client, modelo, mac, nodo, perfil o tenencia.

Flowdat.CablemodemApi | supply | GET /cablemodem/cablemodem/supply | Aprovisiona un cablemodem.

Flowdat.CablemodemApi | update | PUT /cablemodem/cablemodem | Modificación de un cablemodem.

Flowdat.CablemodemModelApi | getById | GET /cablemodem/model | Obtener modelos de cablemodem por id.

Flowdat.CablemodemModelApi | getList | GET /cablemodem/models | Obtener modelos de cablemodem por id o nombre.

Flowdat.CablemodemProfileApi | getById | GET /cablemodem/profile | Obtener Perfil por id.

Flowdat.CablemodemProfileApi | getList | GET /cablemodem/profiles | Obtener Perfiles por id, nombre.

Flowdat.ClientApi | active | GET /base/client/active | Habilitar un cliente.

Flowdat.ClientApi | callDelete | DELETE /base/client | Elimina un cliente.

Flowdat.ClientApi | create | POST /base/client | Creación de un cliente.

Flowdat.ClientApi | disable | GET /base/client/disable | Deshabilita un cliente.

Flowdat.ClientApi | getById | GET /base/client | Obtener Clientes por id.

Flowdat.ClientApi | getList | GET /base/clients | Encuentra Clientes por Id, externalID, nombre, companía, email, dirección, estado o tenencia.

Flowdat.ClientApi | update | PUT /base/client | Modificación de un cliente.

Flowdat.FTTHProfileApi | getById | GET /ftth/profile | Obtener Perfil por id.

Flowdat.FTTHProfileApi | getList | GET /ftth/profiles | Obtener perfiles por id, nombre.

Flowdat.NAPApi | getById | GET /ftth/nap | Obtener NAP por id.

Flowdat.NAPApi | getList | GET /ftth/naps | Obtener NAPs por id, id NAP Padre, OLTId, nombre.

Flowdat.NodeApi | getById | GET /cablemodem/node | Obtener Nodo por id.

Flowdat.NodeApi | getList | GET /cablemodem/nodes | Obtener Nodos por id, id Nodo Padre, nombre.

Flowdat.OLTApi | getById | GET /ftth/olt | Obtener OLT por id.

Flowdat.OLTApi | getList | GET /ftth/olts | Obtener las olts.

Flowdat.OLTModelApi | getById | GET /ftth/oltmodel | Obtener modelos de OLT por id.

Flowdat.OLTModelApi | getList | GET /ftth/oltmodels | Obtener modelos de OLT por id, nombre o marca.

Flowdat.ONUApi | callDelete | DELETE /ftth/onu | Eliminar una ONU.

Flowdat.ONUApi | create | POST /ftth/onu | Creación de una ONU.

Flowdat.ONUApi | getById | GET /ftth/onu | Obtener ONU por id.

Flowdat.ONUApi | getList | GET /ftth/onus | Encuentra ONU por Id, externalID, nombre, companía, email, dirección, estado o tenencia.

Flowdat.ONUApi | oNUActive | GET /ftth/onu/active | Aplicar acción sobre ONU.

Flowdat.ONUApi | oNUDisable | GET /ftth/onu/disable | Desactiva una ONU.

Flowdat.ONUApi | oNUSupply | GET /ftth/onu/supply | Aprovisiona una ONU.

Flowdat.ONUApi | update | PUT /ftth/onu | Modificación de una ONU.

Flowdat.ONUModelApi | getById | GET /ftth/onumodel | Obtener modelo de ONU por id.

Flowdat.ONUModelApi | getList | GET /ftth/onumodels | Obtener modelos por Id, nombre o tipo de ruteo.

Flowdat.ONUProfileApi | getById | GET /ftth/onuprofile | Obtener el perfil de onu por id.

Flowdat.ONUProfileApi | getList | GET /ftth/onuprofiles | Obtener los perfiles de onu previamente configurados en al olt por id, nombre o valor.

Flowdat.RadiusProfileApi | getById | GET /radius/profile | Obtiene los datos del perfil.

Flowdat.RadiusProfileApi | getList | GET /radius/profiles | Encuentra perfile por Id, nombre o tenencia.

Flowdat.TenancyApi | getById | GET /base/tenancy | Obtiene los datos de la tenencia según el id que se recibe como parámetro.

Flowdat.TenancyApi | getList | GET /base/tenancies | Lista las tenencias.

Flowdat.VLanProfileApi | getById | GET /ftth/vlanprofile | Obtener perfil de vlan por id.

Flowdat.VLanProfileApi | getList | GET /ftth/vlanprofiles | Obtener el perfil de vlan por id, nombreo valor.