Qué es Colppy API?
...
{"auth": {"usuario": "USUARIO_API","password": "USUARIO_PASSWORD"},"service": {"provision": "Nombre_del_Provisión","operacion": "Nombre_de_la_operación"},"parameters": {"sesion": {"usuario": "UsuariodeColppy","claveSesion": "claveSesionGeneradaPorOperacion iniciar_sesion"},"otros parametros": {}}
}
...
El JSON se divide en tres partes auth, service y parameters.
En auth van tus credenciales, con las que te registraste en la web de desarrolladores de Colppy, tu usuario de Colppy y el MD5 de la contraseña que utilizaste para registraste. Por ejemplo si mi nombre usuario como desarrollador es SujetoDePrueba y mi contraseña SujetoDePruebaContraseña, el JSON quedaría de la siguiente forma:
...
{...
"service": {"provision": "Usuario","operacion": "iniciar_sesion"},
...
}
NOTA importante sobre el nombre de las provisiones y operaciones son sensible a mayúsculas. Siempre tener el índice de provisiones y operaciones a mano. En parameters van los parametros que espera la operacion para poderse ejecutar. Estos parámetros varían de provisión en provision y de operación en operacion. En este caso estamos tratando de iniciar sesion en Colppy, si nos fijamos en el índice de provisiones y operaciones en la sección de la provisión sesion, podemos ver los parámetros que espera la operación en el JSON.
En el nuestro ejemplo el JSON final quedaría de la siguiente manera:
{
"auth": {
"usuario": "Usuario Desarrollador",
"password": "Password Desarollador"
},
"service": {
"provision": "Usuario",
"operacion": "iniciar_sesion"
},
"parameters": { "sesion": {
"usuario": "UsuarioColppy",
"password": "ContraseñaColppy"},
}
}
Una vez que ejecutamos la HTTP POST Request con nuestro JSON, Colppy API nos va a responder con un mensaje informándonos si el requerimiento se realizó con éxito o no.
Ejemplo de una respuesta de éxito:
{
"service":{
"provision":"Usuario",
"operacion":"iniciar_sesion",
"version":"1_0_0_0",
"response_date":"2014-24-06 17:10:19"
},
"result":{
"estado":0,
"mensaje":"La operaci\u00f3n se realiz\u00f3 correctamente"
},
"response":{
"success":true,
"message":"La operacion se realizo con exito.",
"data":{
"claveSesion":"b5a97564ad59e624a6ba545ecd3ca112"
}
}
}
...