ISPCube cuenta con un API Rest para:
- Listar (visualizar) Clientes
- Cargar cobranzas.
- Crear Tickets.
- Listar (visualizar) movimientos de Caja.
- Clientes y Teléfonos de un Nodo.
- Obtener link de pago de MercadoPago.
Es necesario recordar que todas las peticiones deben contener en su header:
Content-Type:application/json
api-key: clave de aplicación otorgada por ISPCube.
api-token: clave de usuario devuelta por ISPCube al momento del login. Es necesario que su aplicación, tras logearse correctamente, guarde esta clave para ser utilizada en todas las siguientes peticiones. En la única petición que no sera obligatorio este campo sera en el login.
Las url son las siguientes:
GET:
sudominio.com/tickets
- page: numero de pagina.
- limit: cantidad de registros por pagina.
- q: palabra clave que se desea buscar.
- ejemplo: sudominio.com/tickets/page=1&limit=50&q=garcia
sudominio.com/customers
- page: numero de pagina.
- limit: cantidad de registros por pagina.
- q: palabra clave que se desea buscar.
- ejemplo: sudominio.com/customers/page=1&limit=50&q=garcia
sudominio.com/tickets/{id}
- id: id del ticket que se desea obtener.
sudominio.com/tickets/{id}/items
- id: id del ticket del cual se desea obtener el historial.
sudominio.com/customers/{id}/connections
- id: id del cliente del cual se desea obtener sus conexiones.
- Datos Devueltos:
- idconn: id de la conexión.
- idcustomer: id del cliente.
- queue: si utiliza cola simple (0: No, 1:Si)
- pppoe: si utiliza pppoe (0:No, 1:Si)
- hotsp: si utiliza hotSpot (0:No, 1:Si)
- dhcp: si utiliza dhcp (0:No, 1:Si)
- radius: si utiliza radius (0:No, 1:Si)
- queuetree: si utiliza queuetree (0:No, 1:Si)
- olt: si utiliza OLT (0:No, 1:Si)
- startdate: fecha de instalación.
- idplan: código de plan de Internet (relación con Planes)
- idnode: código de Nodo (relación con Nodos)
- ip: dirección IP.
- ipremote: dirección IP remota (pppoe)
- pppid: usuario de pppoe
- ppppass: contraseña de pppoe
- hotid: id de hotspot
- hotpass: contraseña de hotspot
- mac: dirección mac.
- address: domicilio de la conexión.
- postalcode: código postal de la conexión (relación con Códigos Postales)
- dhcppool: pool dhcp
- con815type: tipo de conexión 815 (0: Ip Fija, 1 DHCP)
- smartolt_sync: conexión sincronizada con SmartOlt (0: No, 1: Si)
- name: Nombre del Plan de Internet
- price: Precio del plan.
sudominio.com/entities/paymentmethodslist
- Devuelve el listado de entidades de pago disponibles. Es un campo requerido en el alta del cliente, específicamente en su campo medio.
sudominio.com/postalcode/list
- Devuelve el listado de ciudades disponibles. Es un campo requerido en el alta del cliente, específicamente en su campo postalcod.
sudominio.com/operators/list
- Devuelve el listado de operadores disponibles. Es un campo requerido en el alta del cliente, específicamente en su campo collector.
sudominio.com/ticketscateg/list
- Devuelve el listado de categorías de tickets. Es un campo requerido en el alta del ticket, específicamente en su campo category.
sudominio.com/ticketsstatus/list
- Devuelve el listado de estados de tickets. Es un campo requerido en el alta del ticket, específicamente en su campo status.
sudominio.com/cashs/cashlist
- Devuelve el listado de cobranzas.
- limit: cantidad de registros por pagina.
- datefrom: fecha inicio consulta formato AAAAMMDD.
- dateto: fecha fin consulta formato AAAAMMDD
- ejemplo: sudominio.com/cash/cashlist?limit=500&datefrom=20181201&dateto=20181220
sudominio.com/nodes
- Devuelve el listado de Nodos.
- Datos devueltos:
- idnode (código de nodo. Útil para consultas posteriores)
- comment (nombre o descripción del Nodo).
- ip (dirección ip del nodo)
-
EjemploDescargar
sudominio.com/nodes/{id}/customers
- id: Código de Nodo, el cual, se desea consultar.
- Devuelve el listado de cliente de determinado nodo.
- Datos devueltos:
- idcustomer (código de cliente).
- name (nombre del cliente).
- debt (deuda total del cliente).
- duedebt (deuda vencida del cliente).
- phone (teléfono del cliente).
-
Ejemplo Descargar
sudominio.com/mercadopago/button
- idcustomer: id del Cliente (habitualmente 6 digitos completados por ceros delante. Ej: 001030)
- price: importe del pago del cliente. Permite entero o dos decimales. (Ej: 100 ó 100.20)
- Datos devueltos:
- url de pago de mercado pago. (string)
- Mensajes de Error:
- Mercado Pago sin Configurar: Debe configurar los datos de Mercado Pago en ISPCube (Varios / Pagos Automáticos)
- Mercado Pago Cliente código con longitud errónea (16 caracteres): El valor del parámetro Client no tiene el largo necesario. Revisar en Varios / Pagos Automáticos.
- Mercado Pago Secret con longitud errónea (32 caracteres): El valor del parámetro Secret no tiene el largo necesario. Revisar en Varios / Pagos Automáticos.
- Importe no Valido: Debe ser un numero positivo mayor a 0 y menor a 200000.
- Cliente no Encontrado: El cliente no se encuentra en el sistema.
-
Ejemplo Descargar
POST:
sudominio.com/users/login
- user: código de usuario
- password: contraseña.
sudominio.com/customers
- name: nombre del Cliente.
- address: domicilio del Cliente.
- phone: telefono del Cliente.
- mail: correo electrónico del Cliente.
- medio: id del medio de pago.
- postalcod: id de la ciudad.
- collector: id del operador cobrador.
- id: Nro de DNI/CUIT del cliente. La validación del mismo es responsabilidad del sistema cliente.
- extra1: información extra.
- extra2: información extra.
- startdate: fecha de creación del cliente con formato yyyy-mm-dd.
- debt: deuda total del cliente con formato decimal separado por punto. Ej: 100.55
- duedebt: deuda vencidad del cliente con formato decimal separado por punto. Ej: 100.55
sudominio.com/tickets
- idcustomer: id del Cliente.
- details: detalle del Ticket.
- idcategory: categoria del Ticket.
- idconnticket: (no obligatorio) id de la conexión del Cliente a la cual se vinculará el ticket. Si no envía dicho valor el ticket quedará registrado al cliente pero no tendrá ninguna conexión relacionada.
subdominio.com/cashs
- idcustomer: id del Cliente (habitualmente 6 digitos completados por ceros delante. Ej: 001030)
- amount: importe del pago del cliente. Permite entero o dos decimales. (Ej: 100 ó 100.20)
- comment: este valor es opcional. Si lo envía se registrará como el comentario del pago, caso contrario se establecerá un comentario genérico.
PUT:
sudominio.com/tickets/{id}
- id: id del Ticket.
- idcustomer: id del Cliente.
- details: detalle del Ticket.
- idcategory: id de la categoria del Ticket.
- idassignment: id del operador a quien se desea asignar el ticket.
- idstatus: id del estado del Ticket.
En el siguiente link de descarga podrán ver y utilizar un cliente de ejemplo.