Qué es Colppy API?
La API de Colppy utiliza el protocolo HTTPS para hacer las pegadas a la API. Colppy API permite mediante una solicitud en formato json; iniciar sesión, realizar altas y bajas de facturas, leer datos de empresas o cliente entre otras funcionalidades.
Cómo empiezo?
El primer paso para empezar a desarrollar es registrar usuario y contraseña en la Web de desarrolladores de Colppy. Para realizar una petición podemos o generar un script en php que utilice Curl o utilizando alguna herramienta que puedan ejecutar HTTP POST Request (Por ej. httprequester para Firefox o PostMan para Chrome).
Cómo realizo una petición?
La url de Colppy API para realizar pruebas es https://staging¿Cuáles son las URL?
Produccion: https://login.colppy.com/lib/frontera2/service.php. El punto de acceso a Colppy API en su versión Producción es
Staging: https://loginstaging.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:
...
(Demora 24 Hs desde la creación del usuario en la web de desarrolladores en estar disponible).
¿Cuál es el JSON de inicio de sesión?
Operación iniciar_sesion
| 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, con las que te registraste en la web de desarrolladores de Colppyes decir, 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:
{"auth": {"usuario": "SujetoDePrueba","password": "d0edfe89f30a78ef45ab9a22bd0f826b"},....}
El md5 de la cadena "SujetoDePruebaContraseña" es la cadena "d0edfe89f30a78ef45ab9a22bd0f826b".
...
{...
"service": {"provision": "Usuario","operacion": "iniciar_sesion"},
...
}
NOTA importante sobre el con el que te registraste en dev.colppy.com y la contraseña en formato MD5.
En service se especifica la provisión y la operación que deseo hacer. Se pueden ver todas las opciones aquí. El nombre de las provisiones y operaciones son sensible sensibles a mayúsculas. Siempre tener el índice de provisiones y operaciones a mano.
En parameters van los parametroslos parámetros que espera la operacion para operación 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": {"usuario": "UsuarioColppy",
"password": "ContraseñaColppy"}
}
dependiendo la operación que necesitemos hacer.
Una vez que ejecutamos la HTTP la petición 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:
...
:
Response
| 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" |
...
...
...
} |
...
} |
...
} |
Del response nos quedamos con la "claveSesion" que es obligatoria para realizar otras operaciones.