Overview

🖖

We provide two public APIs:

• The Ferret API is built on top of the Octopus API and operates using the REST protocol. It is user-friendly and straightforward to utilize, making it an excellent choice for getting started. If you need basic functionality and ease of use, the Ferret API is the way to go.
• The Octopus API is a GraphQL-like API (previously known as Maximizer.Web.Data). It allows you to fully access all of Maximizer's capabilities, enabling you to manipulate any data from Maximizer efficiently.

If you find that the Ferret API does not offer enough functionality for your needs, you can switch to the Octopus API. Both APIs share the same entities and approach, so anyone familiar with the Ferret API can easily work with the Octopus API, and vice versa.

Object relationships schema

Check out our object relationship schema—based on the Edition you’re using—to identify which objects are relevant to your needs and how they relate to one another. More detailed information about our domain schema and use cases can be found in our Octopus API documentation.

Request Limits

Both Ferret API and Octopus API enforce two types of limits to ensure better availability for our clients:

1. Rate Limit: The number of requests allowed per minute per user. If exceeded, API responds with a 429 HTTP code.
2. 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