{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"13102f4c-899d-4169-bdce-72c6c5f82475","name":"Colppy API","description":"**Colppy** esta construido en base a una API propia. Esta API es el nexo entre el sitio web de Colppy y sus servidores. Como desarrolladores podemos usar este nexo para crear nuestras propias aplicaciones contables o automatizar nuestros sistemas de gestión aprovechando el potencial contable que ofrece Colppy. \n\nPara empezar a trabajar con **Colppy API** primero debemos ingresar a la web de desarrollador de Colppy, registrar un usuario y contraseña.\n\nLuego, ingresar a la documentación de las provisiones y operaciones disponibles de Colppy API.\n\nRecuerda que para poder utilizar el ambiente de prueba Staging una vez creado el usuario DEV tarda 24 horas en habilitarse.\n\n**Qué es Colppy API?**\n\nLa 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. \n\n**Cómo empiezo?**\n\nEl 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).\n\n**Cómo realizo una petición?**\n\nLa url de Colppy API para realizar pruebas es https://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 producción o testing con JSON que tiene el siguiente formato:\nEl JSON se divide en tres partes **auth, service y parameters**.\n\n`{\n   \"auth\":{\n      \"usuario\":\"usuario_API\",\n      \"password\":\"Clave MD5\"\n   },\n   \"service\":{\n      \"provision\":\"Usuario\",\n      \"operacion\":\"iniciar_sesion\"\n   },\n   \"parameters\":{\n      \"usuario\":\"Usuario_Colppy\",\n      \"password\":\"Clave MD5\"\n   }\n}`\n\nEn **auth** van tus credenciales, con las 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:\n\n`{\n      \"auth\": {\n            \"usuario\": \"SujetoDePrueba\",\n            \"password\": \"d0edfe89f30a78ef45ab9a22bd0f826b\"\n      }\n}`\n\nEl md5 de la cadena **\"SujetoDePruebaContraseña\"** es  la cadena **\"d0edfe89f30a78ef45ab9a22bd0f826b\"**.\nEn **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\n\n`{\n   \"service\": {\n            \"provision\": \"Usuario\",\n            \"operacion\": \"iniciar_sesion\"\n      },\n}`\n\nNota 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.\n\nEn el nuestro ejemplo el JSON final quedaría de la siguiente manera:\n\n`{\n   \"auth\":{\n      \"usuario\":\"Usuario Desarrollador\",\n      \"password\":\"Password Desarollador\"\n   },\n   \"service\":{\n      \"provision\":\"Usuario\",\n      \"operacion\":\"iniciar_sesion\"\n   },\n   \"parameters\":{\n      \"usuario\":\"UsuarioColppy\",\n      \"password\":\"ContraseñaColppy\"\n   }\n}`\n\nUna 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.   \n\nEjemplo de una respuesta de éxito:\n\n`{\n   \"service\":{\n      \"provision\":\"Usuario\",\n      \"operacion\":\"iniciar_sesion\",\n      \"version\":\"1_0_0_0\",\n      \"response_date\":\"2014-24-06 17:10:19\"\n   },\n   \"result\":{\n      \"estado\":0,\n      \"mensaje\":\"La operaci\\u00f3n se realiz\\u00f3 correctamente\"\n   },\n   \"response\":{\n      \"success\":true,\n      \"message\":\"La operacion se realizo con exito.\",\n      \"data\":{\n         \"claveSesion\":\"b5a97564ad59e624a6ba545ecd3ca112\"\n      }\n   }\n}`\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"2675876","team":60962,"collectionId":"13102f4c-899d-4169-bdce-72c6c5f82475","publishedId":"T17Dg8xk","public":true,"publicUrl":"https://apidocs.colppy.com","privateUrl":"https://go.postman.co/documentation/2675876-13102f4c-899d-4169-bdce-72c6c5f82475","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-08-11T20:01:04.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"sandbox","id":"dd6e71f2-8af6-442c-b628-5a27ba1a7dd9","owner":"2675876","values":[{"key":"BASE_URI","value":"https://staging.colppy.com","enabled":true},{"key":"PATH","value":"/lib/frontera2/service.php","enabled":true},{"key":"API_USERNAME","value":"<API_USERNAME>","enabled":true},{"key":"API_PASSWORD","value":"<API_PASSWORD_MD5>","enabled":true},{"key":"SESSION_TOKEN","value":"","enabled":true},{"key":"SESSION_USERNAME","value":"<COLPPY_USERNAME>","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/89bbd23b759be3c978c3c4852c4c82acc6c7ffdf13b88a6a6cadc71640dec38b","favicon":"https://res.cloudinary.com/postman/image/upload/v1704738065/team/evzupjth3f1onekd8vos.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"sandbox","value":"2675876-dd6e71f2-8af6-442c-b628-5a27ba1a7dd9"}],"canonicalUrl":"https://apidocs.colppy.com/view/metadata/T17Dg8xk"}