{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c4b72b19-70f5-475d-ab40-4af3570a4c20","name":"Audaces Idea :: Integration Service","description":"# **Overview**\n\nThis document describes a REST API that you should provide in order to integrate your ERP system with Audaces Idea.\n\nAs you can see on the diagram below, our application acts as an HTTP CLIENT, which makes HTTP requests to a web-service following this spec.\n\nThis intermediary service is the cornerstone of this integration. Communication between Audaces IDEA and the server takes place by exchanging messages using a request-response pattern. Audaces IDEA basically sends a service request and the server returns a responds.\n\n<img src=\"https://content.pstmn.io/7b8cc2e5-c6ab-4229-b20a-3f9cc165734a/QXVkYWNlcyBJREVBICgxMjAwwqDDl8KgODAwwqBweCkgKDE4MDDCoMOXwqA4MDDCoHB4KS5wbmc=\" width=\"622\" height=\"309\">\n\n**Important:** The Communication Link described as API in the image above is a service that has to be implemented by the ERP supplier company or by outsourced developers hired by the end customer to perform this service. ​Audaces does not offer this service.\n\nAudaces only provides the developed webservice template, leaving the ERP responsible for communicating with the database, standard API or data tables. In this way, any and all communication with and changes that the user requests, it is the responsibility of this third party to carry out the necessary changes in the ERP and Audaces IDEA integration.\n\n# Authentication\n\nThe authentication method is a Bearer Token, which must be generated and validaded by your web-service.\n\nUsing the \"login\" endpoint, the client application will send you the user credentials and expects to receive a token as a response.\n\nThis token will be sent on every other request that is made by the client.\n\nIt is up to the web-service to provide means to generate and validate tokens.\n\n# Error Codes\n\nEvery request has means to provide error messages. Please check each one of them individually for more information.\n\n# Rate limit\n\nOn a tipical use case, your web-service will be receiving requests for 20 or 30 client applications - so you probably won't need to worry with \"heavy loads\" of requests.\n\n# How to test?\n\nWe strongly recommend that you test using the Postman desktop application.\n\nJust click at the button \"Run In Postman\" and you will get further instructions.\n\nEvery request has examples to demonstrate how the response should look like. When you do a request using Postman, the response will be tested according to our specification - so it will be quite easy to understand if your response is okay or if there's something missing.\n\nIf you'd like to interact with a real server, that follows the current specification, please feel free to try with this one:\n\n\\* URL: [http://audaces-idea-erp-service.azurewebsites.net](http://audaces-idea-erp-service-dev.azurewebsites.net)  \n\\* PORT: 80\n\nIt provides a reference implementation, developed by Audaces, that you can even use from Audaces Idea application, to get a grasp of what exactly the end users will get.\n\nYou can find instructions for this setup at our helpdesk:\n\n\\* [http://share.audaces.com](http://share.audaces.com)\n\n# Pagination\n\nIt is not necessary to forward the pagination definition when submitting many items, this pagination is managed by Audaces IDEA.\n\n# Transfer Type\n\nCurrently the client side does not handle chunked transfer encoding, so you have to make sure that the \"content-length\" field is always present on the responses, indicating the total amount of bytes of the reply.\n\n# About Audaces Idea\n\nIf you are curious to understand how the Audaces Idea application is used, this short video might be helpful:\n\n\\* [https://audaces.com/en/audaces-360/idea/](https://audaces.com/en/audaces-360/idea/)\n\n# Additional questions?\n\nIf you need further assistance, please get in touch with us trought our support center:\n\n\\* [http://share.audaces.com/](http://share.audaces.com/)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"21046231","team":678623,"collectionId":"c4b72b19-70f5-475d-ab40-4af3570a4c20","publishedId":"UyxnF5SP","public":true,"publicUrl":"https://documenter-api.postman.tech/view/21046231/UyxnF5SP","privateUrl":"https://go.postman.co/documentation/21046231-c4b72b19-70f5-475d-ab40-4af3570a4c20","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-05-19T16:40:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/65f29db19895a0be8c3ffc9d8b0b5626ae13fb79bf48a14fbebf2e7cd0919747","favicon":"https://res.cloudinary.com/postman/image/upload/v1580475452/team/vvg8kksm1fwqh2pj9fpv.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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UyxnF5SP"}