Introducing API v2.0
- Updated on 03 Dec 2019
- 5 minutes to read
-
Print
-
DarkLight
Overview
Mambu is currently developing a new and improved version of its API, referred to as API v2.0. It will eventually replace the current API (v1.0), once it has reached functional parity. For the time being, however, both APIs will be available concurrently. API v2.0 is currently in Beta, with some resources more mature than others and there may be some non-backwards compatible changes.
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?
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
[tenant] above with the name of your organization's Mambu tenant.
How do I know which API version is enabled for me?
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 (Beta)
Can we be a part of this roll out into Production?
Can we be a part of this roll out into Production?
Absolutely - customers should contact their CSM if they’re interested in using API v2.0 to discuss their use case and learn about any differences between current ‘beta’ availability and ‘general availability’.
How can we enable API v2.0 in Production?
How can we enable API v2.0 in Production?
API v2.0 needs to be enabled by the MyMambu team. Tenants can raise a request to their CSM or raise a support ticket.
API v2.0 is marked as beta. How does this impact use?
API v2.0 is marked as beta. How does this impact use?
The new generation of the API will be considered 'beta' until full feature parity with API v1.0 has been met. This means that new functionality will continue to be added, as well as currently available endpoints being subject to change - including ones that are not backwards compatible. Any changes made will be communicated in the Release Notes.
That being said, both new and existing customers will typically benefit by making use of API v2.0 when creating new API-based features and integrations and only falling back to API v1.0 in cases where a needed feature has not yet been rolled out on the new API.
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?
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?
Once API v2.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 begin to gradually phase out version 1.0.
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.
Can we use API v2.0 in parallel with API v1.0 ?
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. 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?
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 v2.0.
When will API 2.0 be available to use in production officially? i.e. When will API v2.0 be out of beta?
When will API v2.0 be available to use in production officially? i.e. When will API v2.0 be out of beta?
API v2.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 v2.0 is out of Beta and can be used in Production, officially.
