{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3056143b-f63e-4844-8c56-ca98bbf1d053","name":"365 business API","description":"The 365 business API allows you to programmatically access to functions provided by 365 business with ease.\n\nThe easiest way to get started with the API is to click the \"Run in Postman\" button present at the top of the documentation page and use the [Postman](https://www.postman.com/) App to send requests.\n\n# What is an API?\nAPI stands for [application programming interface](https://en.wikipedia.org/wiki/API). It can be helpful to think of the API as a way for different apps to talk to one another. For many users, the main interaction with the API will be through API keys, which allow other apps to access your account without you giving out your password.\n\n## What is an API Key?\nAPI keys grant full access to your 365 business API account and should be protected the same way you would protect your password. In particular, there are a few common scenarios to keep in mind when working with API keys.\n\n# Overview\n1. You need a valid API Key to send requests to the API endpoints. To get your free trial key contact us via  [info@365businessdev.com](mailto:info@365businessdev.com).\n\n2. The 365 business API will only respond to secured communication done over HTTPS. HTTP requests will be sent a `301` redirect to corresponding HTTPS resources.\n\n3.  The API calls will respond with appropriate [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) for all requests. A `200 OK` indicates all went well, while `4XX` or `5XX` response status codes indicate an error from the requesting client or our API servers respectively.  \n\n4. **Each \"v1\" API endpoints is obsolete, please do not use these endpoints anymore.**\n\n5. \"v2\" Endpoints: Response to every API request is sent in [JSON format](https://en.wikipedia.org/wiki/JSON). In case the API request results in an error, it is represented by `HTTP status code` different than `200 OK` and a `\"message\": {}` key in the JSON response.\n\n5. \"v2\" Endpoints: Each response contains a `status` and `processingTimeInMilliseconds` element. In case of a successful request, the  `status` element returns `Ok`, otherwise there was a problem while processing your request.\nThe `processingTimeInMilliseconds` field indicates how long your request took to be processed.\n\n# Authentication\nAn API Key is required to be sent as part of every request to the 365 business API. The 365 business API accepts the API Key when it is sent as `key` URL query parameter.\n<br>\n\n**Note:** If you do not have an API Key, you can contact [info@365businessdev.com](mailto:info@365businessdev.com) to get your free trial key.\n<br>\nAn API Key tells our API server that the request it received came from you.\n\n## API Key related error response\nIf an API Key is missing, malformed, or invalid, you will receive a `401 Unauthorized` response HTTP status code and the following JSON response:\n\n    {\n    \t\"message\": \"Access denied!\"\n\t}\n\n# Support\nFor help regarding accessing the 365 business API you can also drop in a line at [info@365businessdev.com](mailto:info@365businessdev.com).\n\n# Terms of Use\nFor information on API terms of use and privacy, refer to our policy document at our website.\n## License Agreement (EULA)\nOur license agreement can be found [here](https://www.365businessdev.com/365-business-api-license-agreement-eula/).\n## Privacy Statement\nOur privacy statement can be found [here](https://www.365businessdev.com/365-business-api-privacy-statement/).\n\n# API Reference\n\n## The `file` object\n\nSome \"v2\" Endpoints (e.g Barcode, PDF, DocumentRecognition) will return a `file` object. This object always contains 2 fields:\n* `mime` - the [MIME Type](https://en.wikipedia.org/wiki/Media_type) of the file.\n* `data` - [Base64](https://en.wikipedia.org/wiki/Base64) encoded file.\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"10249213","team":677698,"collectionId":"3056143b-f63e-4844-8c56-ca98bbf1d053","publishedId":"SzKN33de","public":true,"publicUrl":"https://api-doc.365businessdev.com","privateUrl":"https://go.postman.co/documentation/10249213-3056143b-f63e-4844-8c56-ca98bbf1d053","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2020-03-18T13:49:15.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"[Documentation] 365businessdev","id":"ee447657-7a2e-48f2-b67b-c51e5dbf739b","owner":"10249213","values":[{"key":"url","value":"https://365businessapi.azurewebsites.net","enabled":true},{"key":"apiKey","value":"[YOUR_API_KEY]","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/5087cd4c869ca89845750879283c17693254637f8d6fc303c891b044710f6b1a","favicon":"https://res.cloudinary.com/postman/image/upload/v1611573987/team/mf51kxvg5j6nrt0b0n2f.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":"[Documentation] 365businessdev","value":"10249213-ee447657-7a2e-48f2-b67b-c51e5dbf739b"}],"canonicalUrl":"https://api-doc.365businessdev.com/view/metadata/SzKN33de"}