Qué es Colppy API?
...
Cómo realizo una petición?
La url de Colppy REST API para realizar pruebas es http://staging.colppy.com/lib/frontera2/service.php. El punto de acceso a Colppy API en su versión Producción es https://login.colppy.com/lib/frontera2/service.php. Para poder generar una petición debemos ejecutar HTTP POST Request a una de las urls en donde se encuentra el servicios, ya sea de produccion o testing con JSON que tiene el siguiente formato:
...
{...
"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": "SujetoDePrueba","password": "SujetoDePruebaContraseña"},"service": {"provision": "Usuario","operacion": "iniciar_sesion"},"parameters": {"sesion": {"usuario": "UsuarioTest","password": "ContraseñaTest"},}
}
Una vez que ejecutamos la HTTP POST Request con nuestro JSON, Colppy REST API nos va a responder con un mensaje informándonos si el requerimiento se realizó con éxito o no.
...