zeroq-sdk
v2.3.8
Published
SDK que abstrae las tareas mas comunes de comunicacion con la API de ZeroQ
Downloads
482
Keywords
Readme
#Herramienta para simplificar la interacción con la API de ZeroQ.
Instalacion
Puede importarse como un módulo de npm de la siguiente forma:
npm install --save zeroq-sdk # o yarn add zeroq-sdk
También se puede importar directamente en el HTML:
<!-- para importar una versión en específico -->
<script src="https://cdn.zeroq.cl/sdk/zeroq-sdk-v1.1.6.js"></script>
<!-- para importar la última versión -->
<script src="https://cdn.zeroq.cl/sdk/zeroq-sdk-latest.js"></script>
Proceso de obtención de tickets
Para obtener un ticket, el usuario debe haber seleccionado:
- Una oficina
- Una línea (o trámite) dentro de esa oficina
Obtener el listado de oficinas
import ZeroQ from 'zeroq-sdk'
// En el caso del bundle: const zq = new ZeroQ.default({token:"1234"});
const zq = new ZeroQ({ token: '1234' })
// o por medio de vanilla
//<script src="https://cdn.zeroq.cl/sdk/zeroq-sdk-v1.1.4.js"></script>
const zeq = new ZeroQ.default({ token: '1234' })
// Obtiene todas las oficinas
const offices: Promise<Array<Office>> = zq.getOffices()
Ejemplo de filtrar una oficina
const offices = await getOffices()
const aguasAndinasOffice = offices.filter(
(o) => o.officeSlug === 'aguas-andinas'
)
El arreglo de oficinas puede ser mapeado a una lista de elementos HTML entre los que el usuario podrá elegir (como referencia, ver las oficinas en https://zeroq.cl/search?category=demos)
Cada oficina cuenta con un método getLines()
para obtener un arreglo
de líneas.
const lines: Array<Line> = office.getLines()
Crear un ticket
El ticket siempre estará vinculado a una línea. Al llamar al
método pickTicket()
, se obtiene un ticket para dicha línea:
line.pickTicket({
onSuccess(t) {
console.log('ticket was picked', t)
},
onCall(t) {
console.log('ticket was called', t)
},
onError(e) {
console.error('an error occurred', e)
},
})
Internamente, la librería espera que se gatille el evento de confirmación de un ticket, lo que es representado en el código por una función callback que se ejecuta cuando se recibe este evento.
Es importante diferenciar, tanto para tickets como para reservas, los eventos de creación y confirmación:
Creación: la API en la nube reconoce la intención de un usuario de obtener un ticket en una oficina y guarda este registro en su base de datos. En este momento, el ticket todavía no es válido para ser atendido.
Confirmación: la API se comunica exitosamente con el local y este guarda un ticket o reserva para ser atendido.
// Obtiene las reservas del usuario
const reservations: Promise:<Array<Reservation>> = zq.getUserReservations();
// Obtiene las líneas (trámites) de la oficina
const lines: Array<Line> = office.getLines();
// Se suscribe a los eventos de creación de ticket, error y llamada
// del ticket
line.pickTicket({
onSuccess(t) { console.log("ticket was picked", t) },
onCall(t) { console.log("ticket was called", t) },
onError(e) { console.error("an error occurred", e) }
});
// Obtiene los bloques horarios
const blocks: Array<TimeBlock> = line.getTimeBlocks(new Date())
// Efectúa una reserva y se suscribe
blocks[0].reserve({
onSuccess(t) { console.log("ticket was picked", t) },
onCall(t) { console.log("ticket was called", t) },
onError(e) { console.error("an error occurred", e) }
});
Ejecutar ejemplo
git clone https://github.com/rafael180496/example-sdk-call.git
npm install
npm start
Consumir Bundle Local
npm install -g http-server
cd dist/
http-server ./
<script src="http://127.0.0.1:8080/bundle.js" type="text/javascript"></script>