Octorate Integration Central

Business Operations
Download This Spec

About this spec

<h2>Introduction</h2> The Octorate Api is made up by REST calls. Our API follows common predictable resource-oriented URLS, accept query params bodies and returns JSON-encoded response. It uses these following standard verbs: - POST - DELETE - PATCH - GET And the usually given HTTP Response code (200, 404, etc.., <b>check glossary of common errors for details</b>) You can use our Api in test mode, that means that interacting with them doesn't effect the listings or the content of the user. The Authentication according to the agreement you've got with us is usually performed through an Oauth code that has a limited temporary expiration. As secondary authentication method we may accept also an "Api Key". The authentication must be provided in every http calls you made inside the HEADER. <h2>Manual And tutorials</h2> Please refer to the upper link <a href="./">Integration Central</a> to see tutorial, FAQ and quick start guides <h2>Glossary of commons errors</h2> <table style="width: 100%; margin-top:10px"> <tr style="background-color: #c5c5c5"> <td>Code</td><td>Full Name</td><td>Detailed description</td><td>Way to fix it</td></tr><tr style="background-color: #c5c5c5"> <td colspan="4" style="alignment: center"><b>Category 400 - Errors in your request</b></td></tr><tr> <td>400</td><td>Bad Request</td><td>Generic Bad request errors that means that content you've given to the server was rejected either by the server or the application server. </td><td>Check the format of your request and whether you're providing the right content-type headers.</td></tr><tr> <td>400</td><td>ApiParamsExemption</td><td>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.. </td><td>Check carefully the details to check what's missing or not set corretcly, recheck examples.</td></tr><tr> <td>400</td><td>JsonParseExemption</td><td>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.. </td><td>Use an online tool to validate your json and check where was malformed.</td></tr><tr> <td>400</td><td>ApiValidationFailed</td><td>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) </td><td>Please check the content inside or push the other content that misses.</td></tr><tr style="background-color:#c5c5c5"> <td colspan="4" style="alignment: center"><b>Category 401 - Permission issues</b></td></tr><tr> <td>401</td><td>ApiKeyMissing</td><td>You've not given the access key at all</td><td>Check the headers of your call</td></tr><tr> <td>401</td><td>ApiKeyInvalid</td><td>You're presenting the api key, but this api key is wrong</td><td>Check whether the api key provided is the right one (or the access token)</td></tr><tr style="background-color: #c5c5c5"> <td colspan="4" style="alignment: center"><b>Category 403 - Access Forbidden </b></td></tr><tr> <td>403</td><td>ApiSecurityException</td><td>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) </td><td>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 </td></tr><tr> <td>403</td><td>ApiQuotaException</td><td>You've reached your quota limits</td><td>Wait for new quota, optimize your calls in order to do as few as you can</td></tr><tr> <td>403</td><td>WrongEnviroment</td><td>You are trying to execute a production call in sandbox or viceversa or in the wrong enviroment</td><td>Check where are you trying to execute your call</td></tr><tr style="background-color: #c5c5c5"> <td colspan="4" style="alignment: center"><b>Category 404 - Resource not found/available</b></td></tr><tr> <td>404</td><td>NotFound (no json details provided)</td><td>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 </td><td>Try in a few minutes if you're working on sandbox. Check the link you're calling, the slash, the endpoint and the typos. </td></tr><tr> <td>404</td><td>ApiResourceMissing</td><td>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. </td><td>Make sure the resource exists.</td></tr><tr> <td>404</td><td>ApiResourceEmpty</td><td>Used in content in order to allow you to understand that the relative object/resource was never filled at tall </td><td>Try pushing the resource.</td></tr><tr style="background-color: #c5c5c5"> <td colspan="4" style="alignment: center"><b>Category 405 - Method not allowed</b></td></tr><tr> <td>405</td><td>MethodNotAllowed</td><td>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. </td><td>Find out which methods are allowed (GET,POST,etc...) for each resource in the API Reference</td></tr><tr style="background-color: #c5c5c5"> <td colspan="4" style="alignment: center"><b>Category 422 - Unprocessable entity</b></td></tr><tr> <td>422</td><td>ApiResourceMissing</td><td>The request was well-formed but was unable to be followed due to semantic errors.</td><td></td></tr><tr style="background-color: #c5c5c5"> <td colspan="4" style="alignment: center"><b>Category 5xx - Application/Server issues</b></td></tr><tr> <td>500</td><td>InternalServerError</td><td>An unexpected internal error has occurred.</td><td>Please contact Support for more information.</td></tr><tr> <td>550</td><td>ApiPartnerServerError</td><td>One of our partner that was called to take in charge the request has failed to execute it.</td><td>please check the details to try to understand why, feel free to contact the partner or octorate at second stage. </td></tr></table> Contact Support: Email: tech@octorate.com

About Versori

Versori has established itself as the third generation of Integration Platform as a Service (iPaaS). Versori builds custom integrations for its customers using an intuitive visual user interface.

Versori’s connector engine means there is no dependency on an existing library of apps, all you need to start is the documentation of the app or system you want to integrate to.

How can I integrate with this spec?

Upload your spec

Drag and drop the Open API Spec into Versori's connector engine to create a new connector in minutes.

Build your workflow

Build out visual integration workflows with powerful data tools on an intuitive canvas UI.

Deploy instantly

Deploy your automated workflow instantly and maintain your integrations with ease.

Issue with this spec?

Is there something wrong with this spec? Let us know and Versori's engineering team will improve the quality of the spec based on your feedback.

Report This Spec
Built for Security & Scale

How developers maximise their time & productivity with Versori

Easily map complex data fields

Automatically match and transform data fields between systems with precision, reducing manual effort and errors.

Build, integrate & deploy faster

Design integrations visually, test workflows instantly, and deploy seamlessly—accelerating your time to value.

Create any custom connector in minutes

Drag and drop API specifications to build custom integrations, unlocking endless connectivity with minimal setup.

Start building today

Ready to start integrating?

Google Ads
Batch
Dropbox
Airtable
Asana
Calendly
Filter