Welcome to Octopus API!
Octopus API (also known as Maximizer.Web.Data) is a web service that provides access to Maximizer CRM data in JSON format. This API allows you to seamlessly integrate Maximizer CRM data into any web application, custom tab in Maximizer Web Access, desktop application, or mobile app. It’s available for both cloud and on-premise customers, offering flexible data access across platforms.
For any questions or support, please reach out to us via Forums.
Steps to using the API
Step 1: Get Postman collection
To get familiar with Octopus API, we recommend using Postman:
- Download Postman desktop client or use Web-version.
- You can fork or export our Octopus API Postman collection or download it from our GitHub.
- Open the collection in your Postman client.
- Export and adjust the Postman environment to make API requests.
Step 2: Get authenticated
To access Octopus API, you will need to obtain an access token. There are two ways to accomplish this, but we recommend starting with the first one:
- Create a long-living Personal Access Token (more details about PAT) within your Maximizer account (for On-Premise only available starting 2024R1):
- Log in to your Maximizer account.
- Click on your profile photo to open the drop-down menu.
- Select "Personal Access Tokens" and follow the prompts to create a new PAT.
- Enter the name of the token, choose the expiration date and click "Save".
- Copy your token to a secure location.
- Authenticate by using
/authenticateendpoint (see Authentication section) - By using OAuth2
Step 3: Get familiar with our object relationships schema
Check out our object relationships schema to identify which objects are relevant to your needs and how they relate to each other. More detailed information about our domain schema and use cases can be found in our Objects documentation.
Step 4: Get your data
Once you have identified the objects and fields you are interested in, you can access your data using Octopus API. Each object in the Postman collection has the following structure:
- Metadata: Provides a comprehensive list of all available fields and options for that object.
- FieldOptions: Discover the available options for specific fields, allowing you to understand the possible values.
- Object CRUD: examples of typical Create, Read, Update and Delete operations.
- HowTo's: examples of popular use cases.
HTTP Response Codes
200 OK - Octopus API has completed your request (check the response body for more details).
401 Unauthorized - Octopus API cannot authorize the request based on the provided credentials. Ensure that you have included a valid Bearer token in the request header.
408 Request Timeout - Octopus API could not complete the request within the server's allotted timeout period. Please check your request, simplify it and try again. Please, see the Request Limits section below.
429 Too Many Requests - Octopus API received an excessive number of requests from your client in a short period. To avoid exceeding the rate limit, please check the response header for the "Retry-After" time and wait until that time has elapsed before sending more requests. Please, see the Request Limits section below.
5xx Internal Server Error - Octopus API encountered an unexpected error while processing your request. Please try again later or contact support for assistance.
Request Limits
Octopus API enforces two types of limits to ensure better availability for our clients:
- Rate Limit: The number of requests allowed per minute per user. If exceeded, API responds with a 429 HTTP code.
- Request Duration: The maximum time allowed per request. If exceeded, API responds with a 408 HTTP code.
These limits vary by product edition:
Base Edition:
- Rate Limit: 30 requests per minute
- Request Duration: 10 seconds
SLE/FAE:
- Rate Limit: 90 requests per minute
- Request Duration: 30 seconds
Enterprise/Private Cloud:
- Custom limits
- Custom duration limits