Skip to main content
Version: v2

Deposit products

warning

Please use these APIs with caution, otherwise, you may damage your Mambu instance! The purpose of these APIs is to extract, maintain or move your product configuration between environments - for example as part of a CI/CD pipeline. The create product API is designed to create a product using the information of a previously extracted product as the payload - not to create a product from scratch as there are too many interdependent parameters.

When working with products via API we suggest the following approach:

  1. Create or amend the product using the Mambu UI following the Setting up New Deposit Products or Managing Deposit Products articles in our User Guide.
  2. Get the current product configuration by making a GET request and saving the response in a JSON file.
  3. Edit the JSON file, including removing any fields where the value will be generated by the system, for example, creationDate, lastModifiedDate and encodedkey.
  4. Use the PUT or POST API endpoints to create or update the product configuration.

We recommend using Git as a version control system to track changes to your product configurations. Using a Git hosting provider such as GitHub or GitLab will allow you to create a robust workflow around your product configuration files including retaining a full history of changes, the ability to collaborate and comment and allow for peer reviews and sign-offs before changes are finalised.