¿Cuáles son las URL?
Produccion: https://login.colppy.com/lib/frontera2/service.php
Staging: https https://staging.colppy.com/lib/frontera2/service.php
Para poder generar una petición debemos ejecutar HTTP POST Request a alguna de las URLs con un JSON de inicio de sesión.
¿Cuál es el JSON de inicio de sesión?
El JSON se divide en tres partes auth, service y parameters.
| Code Block | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
{
"auth":{
"usuario":"xxxx@colppy.com", // Usuario registrado en dev.colppy.com.
"password": "egewew6ewg6ew6363" // Contraseña del usuario registrado en dev.colppy.com en formato MD5.
},
"service":{
"provision":"Usuario",
"operacion":"iniciar_sesion"
},
"parameters":{
"usuario":"xxxx@colppy.com", // Usuario de Colppy.
"password":"egewew6ewg6ew6363" // Contraseña del usuario de Colppy en formato MD5.
}
} |
El JSON se divide en tres partes auth, service y parameters.
En auth van tus credenciales, tu usuario con las el que te registraste en la web de desarrolladores 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:
El md5 de la cadena "SujetoDePruebaContraseña" es la cadena "d0edfe89f30a78ef45ab9a22bd0f826b".dev.colppy.com y la contraseña en formato MD5.
En service se especifica que es lo que deseo hacer con en la petición. Cada alta, baja y modificación de colppy están en diferentes Provisiones y cada una de estas en diferentes operaciones. La Provisiones hacen referencia sobre cual de los módulo Colppy deseo trabajar, y la operación hace referencia a lo que deseo hacer con ese módulo. Existe un Índice con las distintas Provisiones y Operaciones que soporta Colppy. Por ejemplo si lo que quiero hacer es iniciar sesión en Colppy lo que tengo que hacer es modificar el campo provision con el nombre del modulo al que quiero acceder en este caso Usuario, luego me fijo en el índice de provisiones y operaciones de Colppy y verifico que exista la operaciones iniciar_sesion, Entonces en el campo operaciones lo cambio a iniciar_sesion. Entonces el JSON quedaría de la siguiente manera
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:
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"auth": {
"usuario": "Usuario Desarrollador",
"password": "PasswordDesarollador"
},
"service": {
"provision": "Usuario",
"operacion": "iniciar_sesion"
},
"parameters": {
"usuario": "UsuarioColppy",
"password": "ContraseñaColppy"
}
} |
la provisión y la operación que deseo hacer. Se pueden ver en todas las opciones aquí. El nombre de las provisiones y operaciones son sensibles a mayúsculas.
En parameters van los parámetros que espera la operación para poderse ejecutar. Estos parámetros varían dependiendo la operación que necesitemos hacer.
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:
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"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"
}
}
} |
De esta respuesta nos quedamos con la "claveSesion" que es obligatoria para realizar otras operaciones.