Para el inicio de sesión, se utiliza la operación iniciar_sesión dentro de la provisión Usuario. Esta función recibe como parámetros el nombre de usuario y la contraseña cifrada en MD5. Como resultado, se genera una claveSesion, que se emplea para autenticar todas las operaciones posteriores.
En entornos de prueba, la validación de sesión generalmente está desactivada, mientras que en producción se realiza de manera obligatoria.
La duración de la sesión es de 60 minutos, y cada vez que se utiliza la claveSesion en una solicitud, se renueva automáticamente por 60 minutos adicionales.
Petición
{
"auth": {
"usuario": "USUARIO_API", // Ingresar el usuario dado de alta en dev.colppy.com
"password": "USUARIO_PASSWORD" // Contraseña en MD5 de usuario de dev.colppy.com
},
"service": {
"provision": "Usuario",
"operacion": "iniciar_sesion"
},
"parameters": {
"usuario": "user@colppy.com",// Usuario de Colppy.
"password": "Clave del usuario Colppy en MD5"
}
}
Posibles errores:
El usuario y/o la contraseña no son válidas.
Respuesta (éxito)
{
"service": {
"provision": "Usuario",
"operacion": "iniciar_sesion",
"version": "1_0_0_0",
"response_date": "2013-07-08 17:10:19"
},
"result": {
"estado": 0,
"mensaje": "La operación se realizó correctamente"
},
"response": {
"success": true,
"message": "La operacion se realizo con exito.",
"data": {
"claveSesion": "b5a97564ad59e624a6ba545ecd3ca112"
}
}
}
Este valor devuelto claveSesion se utilizará para el resto de las operaciones, junto con el id del usuario.
En cada operación que se ejecute, se validan estos datos (ver en las peticiones de cada operación). Si se tuvo éxito, el usuario indicado es el que se usa para las validaciones siguientes. Esto es, si en la sesión se envío el usuario "test@test.com" y este tiene sesión válida, las operaciones que se ejecuten validarán los datos con el usuario "test@test.com".
Por ejemplo, leer una empresa verificará que "test@test.com" sea dueño del id de empresa que se intenta leer.
Para cerrar sesión, se utiliza la operación cerrar_sesión de la provisión Usuario. Esta operación sólo recibe el par usuario y claveSesion. Si la sesión es válida, entonces lo que hace es invalidarla.
Petición:
{
"auth": {
"usuario": "ColppyAPI",
"password": "9410c05b7bfadea3ab7b573180862222"
},
"service": {
"provision": "Usuario",
"operacion": "cerrar_sesion"
},
"parameters": {
"sesion": {
"usuario": "gabriel.cavecedo@colppy.com",
"claveSesion": "372059d45f3b3aaeb802e5aaead35223"
}
}
}
Errores posibles:
La sesión no es válida.
Respuesta (éxito)
{
"service": {
"provision": "Usuario",
"operacion": "cerrar_sesion",
"version": "1_0_0_0",
"response_date": "2013-07-17 16:00:02"
},
"result": {
"estado": 0,
"mensaje": "La operación se realizó correctamente"
},
"response": {
"success": true,
"message": "La operacion se realizo con exito."
}
}
Al hacer esto, la sesión quedará inválida, y nadie podrá utilizarla para ejecutar operaciones.
Por cualquier duda o consulta podes ponerte en contacto con nosotros vía e-mail a: soporte@colppy.com