INTRODUCCIÓN - Provisiones y Operaciones
El punto de acceso a Colppy API en su versión Producción es https://login.colppy.com/lib/frontera2/service.php, las peticiones al servicio API son mediante un HTTP POST Request en formato JSON. Para generar un entorno de prueba debe hacer el pedido al equipo de Colppy de desarrollo (enviando un mail a alonetto@colppy.com o dev@colppy.com). El objeto JSON envía al servidor tres parámetros auth, service y parameters.
...
Ejemplo de una 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":"Cliente",
"operacion":"alta_cliente"
},
"parameters":{
"sesion":{
"usuario":"usuariodelsistema",
"claveSesion":"xxxxxxxxxxxxxxxxxx"
},
"otros parametros":{}
}
Esta parte del objeto JSON enviado al url que es punto de acceso a Colppy API pide la autorización para ejecutar la provisión-operación con los datos de sesión.
Para obtener claveSesion se debe hacer una petición a la provisión Usuario operación iniciar_sesión de la API. Como se puede ver en el ejemplo el parámetroresponse.data.claveSesion devuelve el valor que deberá ser usado en todas las peticiones subsecuentes a la API.
Petición:
{
"auth":{
"usuario":"ColppyAPIUSUARIO_API", //Ingresar el usuario dado de alta en dev.colppy.com
"password": "9410c05b7bfadea3ab7b573180862222"USUARIO_PASSWORD" //Contraseña en MD5 de usuario de dev.colppy.com
},
"service":{
"provision":"Usuario",
"operacion":"iniciar_sesion"
},
"parameters":{
"usuario":"usuario@prueba.com.ar",
"clave":"350b38cb07adc6c477a76009798c4686"
}
}
Errores posibles
- 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"
}
}
}
Mensajes de Error
...