sta-report v1.1.4

Guía de utilización

El módulo se puede utilizar de dos maneras, haciendo login con un usuario, o pasándole un token de un usuario.

Para pedir un reporte, se deben seguir los siguientes pasos:

• Lanzar funcion init
• Lanzar función getReport (la cantidad de veces que sea necesaria)
• Lanzar funcion end (si se realizo un login con user-password y se desea hacer logout)

init(config, user, callback)

Llamada para inicializar el paquete. Se recomienda hacerla antes de pedir el reporte (ya que hace un login a la API, por el momento no tiene método de validación para mantener vivo el token).

Parámetros:

config

Configuración de conexión

• Si utilizamos los reportes usando un token, el único campo requerido es "socket".

let config = {
    api: 'http://myapi.test.com:3000', // Direccion de la API con puerto incluido
    socket: 'http://mysocket.example.com:1515', // Direccion del SOCKET con puerto incluido
    basicToken: 'kajfkadf981asg', // Basic token de la network
    debug: true, // Debug true/false
    timeout: 60000 // Opcional. Tiempo maximo de espera desde que se pide el reporte hasta que se obtiene
}   

user

Datos para utilizar el reporter.

• Usando un user y password: los cambios username y password son obligatorios; y no se debe enviar el campo token.
• Usando un token: se debe otorgar únicamente el campo token.

// Utilizando user-password
let user = {
    username: 'user@example.com', // email del usuario
    password: '123456', // contraseña del usuario
}
// Utilizando un token
let user = {
    token: 'AKSJDKJSAKJDASJKDSAKJDSAKJD' // token del sistema
}

callback

getReport(petition)

Llamada para solicitar reporte. Para realizarla primero se debe realizar la función init().

Parámetros:

petition

Petición específica para el cube-server

let petition = {
	// Toda la petición al reporter.
}

end(callback)

Llamada para realizar logout del sistema y que el token deje de ser válido. No es necesaria, pero es recomendada.

Parámetros:

callback

Código de ejemplo

const report = require('sta-report');

let config = {
    api: 'http://myapi.test.com:3000',
    socket: 'http://mysocket.example.com:1515',
    basicToken: 'kajfkadf981asg',
    debug: true
};
let user = {
    username: 'user@example.com',
    password: '123456'
};

report.init(config, user, function(error) {
    if (error) {
        console.log("Error init", error);
        return;
    }

    let p = {
        // ... report petition
    };

    report.getReport(p, function(error, report) {
        if (error) {
            console.log("Error getReport", error);
            return;
        }

        console.log("Report", report);

        report.end(function() {
            console.log("End");
        })
    });
})