{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"aced0a45-5d59-491a-9ea5-6db0c5d82922","name":"Octorate Integration Central (Public API)","description":"<h2>Introduction</h2>\n\n  \nThe Octorate Api is made up by REST calls.  \nOur API follows common predictable resource-oriented URLS, accept query params bodies and returns JSON-encoded response.  \n  \n\nIt uses these following standard verbs:\n\n- POST\n    \n- DELETE\n    \n- PATCH\n    \n- GET\n    \n\nAnd the usually given HTTP Response code (200, 404, etc.., **check glossary of common errors for details**)\n\nYou can use our Api in test mode, that means that interacting with them doesn't effect the listings or the content of the user.\n\nThe Authentication according to the agreement you've got with us is usually performed through an Oauth code that has a limited temporary expiration.  \nAs secondary authentication method we may accept also an \"Api Key\".  \nThe authentication must be provided in every http calls you made inside the HEADER.\n\n<h2>Manual And tutorials</h2>\n\n  \nPlease refer to the upper link\n\n<a href=\"./\">Integration Central</a>\n\nto see tutorial, FAQ and quick start guides  \n  \n\n<h2>Glossary of commons errors</h2>\n\n<p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><p></p><table><tbody><tr><td><div>Code</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Full Name</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Detailed description</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Way to fix it</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><b>Category 400 - Errors in your request</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>400</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Bad Request</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Generic Bad request errors that means that content you've given to the server was rejected either by the server or the application server.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Check the format of your request and whether you're providing the right content-type headers.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>400</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>ApiParamsExemption</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Application server accepted the call, but the validation of the params failed, means that you're presenting you're request to the right endpoint and with the right format, but the content is the issue there and you're missing some required param or the value is not acceptable..</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Check carefully the details to check what's missing or not set corretcly, recheck examples.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>400</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>JsonParseExemption</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Probably the endpoint is right, the content type is right, but you've given a malformed json, check in a json validator online if your json structure is right..</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Use an online tool to validate your json and check where was malformed.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>400</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>ApiValidationFailed</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>You're request is good, your content is good, all required params are given, but it failes our internal constraints (For instance this call can be wellformed but you missed some required calls before)</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Please check the content inside or push the other content that misses.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><b>Category 401 - Permission issues</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>401</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>ApiKeyMissing</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>You've not given the access key at all</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Check the headers of your call</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>401</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>ApiKeyInvalid</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>You're presenting the api key, but this api key is wrong</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Check whether the api key provided is the right one (or the access token)</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><b>Category 403 - Access Forbidden</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>403</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>ApiSecurityException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>You have not the permission to access the requested resource (i.e. you're trying to get access of the resource not owned by the provided property)</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Check if the resource is the wanted you want to access. If it is a new customer you may ask the user with oauth to the auth to access this resource</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>403</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>ApiQuotaException</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>You've reached your quota limits</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Wait for new quota, optimize your calls in order to do as few as you can</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>403</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>WrongEnviroment</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>You are trying to execute a production call in sandbox or viceversa or in the wrong enviroment</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Check where are you trying to execute your call</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><b>Category 404 - Resource not found/available</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>404</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>NotFound (no json details provided)</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>This error tells you that you're trying to call a link that doesn't exists. It can also means that the sandbox env. is not reacheable</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Try in a few minutes if you're working on sandbox. Check the link you're calling, the slash, the endpoint and the typos.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>404</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>ApiResourceMissing</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>This error tells you a specific resource doesn't exist. It's possible that the resource has been moved or deleted, or that there's a typo in your request.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Make sure the resource exists.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>404</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>ApiResourceEmpty</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Used in content in order to allow you to understand that the relative object/resource was never filled at tall</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Try pushing the resource.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><b>Category 405 - Method not allowed</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>405</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>MethodNotAllowed</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The requested method and resource are not compatible. See the Allow header for this resource's available methods. This error means that the requested resource does not support the HTTP method you used.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Find out which methods are allowed (GET,POST,etc...) for each resource in the API Reference</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><b>Category 422 - Unprocessable entity</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>422</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>ApiResourceMissing</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The request was well-formed but was unable to be followed due to semantic errors.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><b>Category 5xx - Application/Server issues</b></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>500</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>InternalServerError</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>An unexpected internal error has occurred.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Please contact Support for more information.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>550</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>ApiPartnerServerError</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>One of our partner that was called to take in charge the request has failed to execute it.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>please check the details to try to understand why, feel free to contact the partner or octorate at second stage.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\nContact Support:  \nEmail: [tech@octorate.com](https://mailto:tech@octorate.com)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12991460","team":1561719,"collectionId":"aced0a45-5d59-491a-9ea5-6db0c5d82922","publishedId":"2s93RKzb52","public":true,"publicUrl":"https://documenter-api.postman.tech/view/12991460/2s93RKzb52","privateUrl":"https://go.postman.co/documentation/12991460-aced0a45-5d59-491a-9ea5-6db0c5d82922","customColor":{"top-bar":"1f2643","right-sidebar":"303030","highlight":"00B0B9"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2023-03-22T07:59:21.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Octorate Production","id":"cc8ce5c6-881a-41ac-a046-fd8beb89ff7d","owner":"12991460","values":[{"key":"octorate","value":"https://api.octorate.com","enabled":true,"type":"default"},{"key":"baseUrl","value":"{{octorate}}/connect","enabled":true,"type":"default"},{"key":"octorate_client_secret","value":"secret_832803bdf434411f8fc41d6f5d503fefEOHNNXJEXC","enabled":true,"type":"secret"},{"key":"octorate_client_id","value":"public_64801e6b005e4794ad255bf6ab0392ea","enabled":true,"type":"secret"},{"key":"token","value":"7d63be173dd441278b47f16a111715ccBXFOWXNNLC","enabled":true,"type":"secret"},{"key":"test_bearer_token","value":"ae23cfea78154bcb9070324130f3f3abLNYLKMDURW","enabled":true,"type":"default"},{"key":"octorate_api_login","value":"","enabled":true,"type":"default"},{"key":"airbnb_secret","value":"","enabled":true,"type":"secret"},{"key":"airbnb_user","value":"","enabled":true,"type":"secret"},{"enabled":true,"key":"stripe_username","value":"","type":"default"}],"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/b3d1d80199b5b9d449302c3bd4743928059233f07856029bccd91f0ef6aacf6d","favicon":""},"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":"Octorate Production","value":"12991460-cc8ce5c6-881a-41ac-a046-fd8beb89ff7d"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s93RKzb52"}