Skip to main content

General Notes

Backward compatibility information​

Manna solutions are continuously updated to deliver additional features, security patches, and bug fixes. All versions remain backward compatible, within reasonable limits, ensuring the durability of integrations after each Manna solution update.

Partner integrations must:

  • handle the introduction of additional fields in API responses.
  • support additional values in enumeration or constant fields.

HTTPS​

API connections are only allowed over HTTPS, ensuring end-to-end encryption.

Authentication​

Manna relies on OAuth 2.0, implemented through Okta/Auth0, to authenticate and authorize client access. All APIs require clients to have specific permissions or scopes for read or write access.

Rate limits​

All endpoints are protected by rate limits — each endpoint has a dedicated section displaying its rate limit.

API return codes​

Connections use standard HTTP return codes. The success or failure of a request can be verified through the HTTP status codes.

Success codes:

  • 200 OK Request succeeded.
  • 201 Created Request succeeded and a resource was created.
  • 202 Accepted Request accepted for processing.
  • 204 No Content Request succeeded but does not return any content.

Error codes:

  • 400 Bad Request Invalid use of the resource.
  • 401 Unauthorized Authentication is required or has failed.
  • 403 Forbidden The client is authenticated but does not have permission to access the resource.
  • 404 Not Found The requested resource could not be found.
  • 405 Method Not Allowed The HTTP method used is not allowed for this resource.
  • 406 Not Acceptable The requested response content type is not available for this resource.
  • 415 Unsupported Media Type The entity content type sent to the server is not supported.
  • 500 Internal Server Error The server encountered an unexpected error.

Content type

Manna APIs are only available in JSON format (except for some resources dedicated to downloads).

:::info HTTP Set the Request header Content-Type and the Response header Accept to application/json. :::

Undocumented properties​

At times, the API might include extra data beyond what is documented.
This data is unsupported and may change without notice, so do not depend on it.

UTF-8 Encoding​

All text data is encoded using UTF-8 character encoding.

Date formats​

The API may return dates in formats compliant with ISO 8601:

  • date-time with the pattern YYYY-MM-DDThh:mm:ss[.SSS]±hh:mm
    The offset +00:00 can be replaced by Z (the zero UTC offset).
    Milliseconds may be omitted if equal to .000
  • or date-time-without-timezone

Components:

  • YYYY years
  • MM months
  • DD days
  • T delimiter
  • hh hours
  • mm minutes
  • ss seconds
  • SSS milliseconds
  • ±hh:mm refers to an offset from UTC

:::info Note Manna uses UTC Coordinated Universal Time / GMT Greenwich Mean Time as the reference time zone. GET requests require date-time values to be URL-encoded. :::

Offset pagination & sort​

Some APIs support offset pagination.