Esta sección aborda la autenticación.

GET /sessions/{session}

Este método obtiene el nombre del usuario al que pertenece la sesión proporcionada o error en caso de que la sesión no exista.

Parámetros de solicitud:

    • company [obligatorio]: nombre o Id. de la empresa.
    • session [obligatorio]: el identificador de la sesión.

Respuesta:

    • status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
    • data: devuelve el código del usuario al que pertenece la sesión en caso de éxito o el enlace a la ayuda de la solicitud en caso de error.
    • message: "Success" en caso de éxito o una información descriptiva del error en cualquier otro caso.

Ejemplo:

Request:

{"type":"get",

"url":"sessions/neQXoKWYLALJ1yVjr5d2ANOhZrwp52p5qeyM7WdzAi96rJ5QKmGHsIyF5tzV",

"data":"company=testco"}


Reponse (success):

{"status":"0",

"data":"ADMIN",

"message":"Success"}


Reponse (error):

{"status":"1007",

"data":"<a href='http:\/\/127.0.0.1:8080\/edinnM2\/help\/en\/API_Sessions.html'>for additional information follow this link<\/a>",

"message":"Session not stablished"}

POST /sessions

Este método crea una nueva sesión, le permite iniciar sesión en la API. Deberá proporcionar sus credenciales y el método le devolverá una Id. de sesión. Necesitará esta Id. para usar todos los demás recursos de la API.

Si su compañía no se encuentra en ese servidor, se le especificara el servidor correcto en el mensaje de la respuesta.

Parámetros de solicitud:

    • company [obligatorio]: nombre o Id. de la empresa.
    • user [obligatorio]: la Id. del usuario.
    • password [obligatorio]: la contraseña del usuario.
    • device: la Id. del dispositivo.

Respuesta:

    • status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
    • data: devuelve el código de la sesión en caso de éxito o el enlace a la ayuda de la solicitud en caso de error.
    • message: "Success" en caso de éxito o una información descriptiva del error en cualquier otro caso.

Ejemplo:

Request:

{"type":"post",

"url":"sessions",

"data":"company=testco&user=admin&password=1234&device=init"}


Reponse (success):

{"status":"0",

"data":"neQXoKWYLALJ1yVjr5d2ANOhZrwp52p5qeyM7WdzAi96rJ5QKmGHsIyF5tzV",

"message":"Success"}


Reponse (error):

{"status":"1004",

"data":"<a href='http:\/\/127.0.0.1:8080\/edinnM2\/help\/en\/API_Sessions.html'>for additional information follow this link<\/a>",

"message":"Incorrect credentials"}

DELETE /sessions/{session}

Este método elimina una sesión específica, le permite desconectar la API.

Atributo de solicitud:

    • session [obligatorio]: el código de la sesión a eliminar.

Parámetros de solicitud:

    • company [obligatorio]: el nombre o Id. de la compañía.

Respuesta:

    • status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
    • data: verdadero si la sesión se ha eliminado correctamente.
    • message: "Success" o una información descriptiva del error en cualquier otro caso.

Ejemplo :

Request:

{"type":"delete",

"url":"sessions/neQXoKWYLALJ1yVjr5d2ANOhZrwp52p5qeyM7WdzAi96rJ5QKmGHsIyF5tzV",

"data":"company=testco"}


Reponse:

{"status":"0",

"data":true,

"message":"Success"}