GUÍA ISPCube

API REST

ISPCube cuenta con un API Rest para listar, editar y crear Clientes y Tickets.

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

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.

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.

customers/{id}/debt: actualiza la deuda del cliente.

  • 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