Introducing API v2.0

Updated On 28 Jan 2021
3 Minutes To Read

Print
Share
Dark

Light

Overview

Since January 2021, version 2 of Mambu's powerful REST API is out of beta and officially on general release. While we will continue to add new features and functionality to the API, we are pleased that as of the time of API 2 coming out of beta, our customers can benefit from:

More than 95% of the endpoints available in API 1.0, now available in API 2.0 as well
Over 20 new endpoints in API 2.0, that are not present in API 1.0
Increased performance and flexibility
Living documentation - updated every time we make even the smallest change
Idempotency for POST/PATCH operations
A versioning mechanism for future growth, ensuring a strong policy for backwards compatibility and running versions in parallel
While JSON remains the standard content type, API 2.0 also supports binary for file transfers and yaml for configuration as code, which helps you roll out new instances or, for example, set up custom fields, organization settings, and roles in new sandboxes faster and easier from version controlled config files.

API 2.0 is enabled by default for everyone, and we encourage you to check it out and consider that if you would like to benefit from newer features, such as Cards, these are available here.

For further details on API v1.0 vs API v2.0, please consult the FAQ, below. If you have additional questions, please contact us at support@mambu.com and we will be happy to assist you.

Frequently Asked Questions

Where can we find the documentation for API version 1.0 and 2.0?

Documentation for API v1.0: REST APIS Overview
Documentation for API v2.0: Mambu API 2.0 Reference

Your Sandbox also contains API v2.0 documentation, which includes information on Custom Fields for your tenant. It is available at the following URLs:
https://[tenant].sandbox.mambu.com/apidocs
https://[tenant].sandbox.mambu.com/apigeneralstandards

Our sandbox documentation also allows you to authenticate yourself using your Mambu credentials and directly make requests against the API via the documentation portal.

Please note

Replace [tenant] above with the name of your organization's Mambu tenant.

How do I know which API version is enabled for me?

You can check the API versions available for your instance by navigating to Administration in the UI and checking under 'Available Features' for:

API v1.0 Access
API v2.0 Access

Since January 2021 API v2 is available for all customers and will be enabled by default.

Will API v1.0 be deprecated entirely in the future or I will still be able to use it? How much time will I have for testing and changing my settings because of that?

We will keep both API v1.0 and v2.0 available in parallel for a rather long time (at least 1 year) to allow to make appropriate adjustments in any integrations. A concrete date for decommisioning API v1 will be communicated during 2021 and customers will be given enough time to fully transition to our improved API v2 endpoints.

Can we use API v2.0 in parallel with API v1.0?

Yes, API v2.0 can be used in parallel with API v1.0 as they are not conflicting functionalities. i.e. one does not really replace the other, but is a new, enhanced addition. In fact, you can use API v1.0 alongside API v2.0 and transition at your own pace.

There is no need for existing clients to transition any calls using API v1.0 at the moment, these will continue to work, however, we would advise using API v2.0 for any new feature development and to opportunistically switch over to using API v2 endpoints exclusively when making changes to existing code.

Your Sandbox should offer the perfect environment to test . For new customers we recommend using API v1.0 only for certain endpoints that are not supported yet via API v2.0.

How is versioning supported for Mambu API requests?

The versioning is supported in API requests via the “Accept” header.
Example - Accept: application/vnd.mambu.v2+json or Accept: application/vnd.mambu.v2+yaml
Please note that an header Accept must be included in the request for API v2.0.

If you have a question about how anything works or have come across something you haven't seen explained here, get in touch with our community of fellow users and Mambuvians where someone will lend a hand.

Ask a question about our REST APIs

* If you don't already have an account you will be prompted to create one when you first visit the site.

Was This Article Helpful?

On this page

Current password

New password

Confirm password