Introducing API v2.0
  • Updated on 10 Apr 2019
  • 3 minutes to read
  • Print
  • Share
  • Dark
    Light

Introducing API v2.0

  • Print
  • Share
  • Dark
    Light

Overview

Mambu is currently developing a new and improved version of its API, referred to as API 2.0. It will eventually replace the current API (v 1.0), once they have reached functional parity. For the time being, however, both APIs will be available concurrently. API 2.0 is currently in Beta, with some resources more mature than others and there may be non-backwards compatible changes.

For further details on API 1.0 vs API 2.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.

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

Documentation for API 1.0:

https://developer.mambu.com

Documentation for API 2.0:

https://api.mambu.com

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

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

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

You can check the API version in the UI by going to Administration and checking under 'Available Features' for:

  • API 1.0 Access
  • API 2.0 Access (Beta)

Q: Can we be a part of this roll out into Production?

Response: Absolutely - customers should contact their CSM if they’re interested in using APIs 2.0 to discuss their use case and be informed about any differences between current ‘beta’ availability and ‘general availability’.

Q: How can we enable API 2.0 in Production?

API 2.0 needs to be enabled by the MyMambu team. Tenants can raise a request to their CSM or raise a support ticket.

Q: API 2.0 is marked as beta. How does this impact use?

The new generation of the API is still a beta feature, not yet fully developed and not yet considered "live". This means that new functionality will continue being added, as well as the currently available endpoints are subject to changes - including ones that are not backwards compatible. Any changes made will be communicated in the Release Notes.

Please note
Typically we advise using API 2.0 only when it's out of Beta or to cover missing functionality that is not supported with API 1.0. Your Sandbox should provide the perfect instance for testing.

Q: Will API 1.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?

Once API 2.0 is completely ready, it will be announced by our Product team in a separate notification and enough time will be given to all our tenants to make the required adjustments before we completely deprecate version 1.0.
We will keep both API 1.0 and 2.0 available in parallel for a rather long time (at least 1 year) to allow to make appropriate adjustments in the integration.

Q: Can we use API 2.0 in parallel with API 1.0 ?

Yes, API 2.0 and can be used in parallel with API 1.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 1.0 along API 2.0 and transition at your own pace. Since this API 2.0 is still Beta, we don't recommend to transition all your calls at this moment. Sandbox should be the perfect instance to test though. In production, we recommend using API 2.0 only for certain new endpoints that are not supported via API 1.0.

Q: 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
Please note that the header Accept "application/vnd.mambu.v2+json" must be included in the request for API 2.0.

Q: When will be API 2.0 available to use in production officially? i.e. When will be API 2.0 out of beta?

API 2.0 is currently available as beta feature, but we don't have a timeline for its official Production release. Our product team will send a separate official notification when API 2.0 is out of Beta and can be used in Production, officially.

Was this article helpful?