Management API

Management API Benefits

Management API introduces API endpoints that let you perform account-related operations connected with:

• Projects,
• Users,
• Metadata schemas,
• Custom event schemas,
• Stacking rules,
• Webhooks,
• Branding,
• Templates.

All of the above-mentioned endpoints must be sent to the following URL: https://{cluster}.voucherify.io/management/v1/.

The three main advantages of the Management API are:

1. Automation: Streamline the process of creating new projects, configuring them, and adding users, among other tasks.
2. Accelerated Delivery: Experience faster delivery times for new projects.
3. Reduced Error Risk: By leveraging standardized API calls, the Management API lowers the risk of human error in project configuration, ensuring consistency and reliability.

📘

The Management API is an Enterprise feature. Contact Voucherify Sales Team for more details.

🚧

Beta Version

The Management API is still in beta. Voucherify developers are working on improving the endpoints.

Management API Keys

The new tab within Team Settings becomes accessible once it is unlocked for your organization. From there, you can generate Management API keys to facilitate various operations.

Each organization can generate a maximum of 5 managament API keys. You have the flexibility to delete, edit, and add new keys at your discretion. However, any modification triggers a cache refresh (deletion).

If you require more than 5 keys, reach out to Voucherify support team for assistance.

The actions performed via the Management API are not logged in the audit log for privacy and security reasons.

🚧

After creating a new Managemet API key, you have 15 minutes to copy the token.

Write your secret keys down and keep them in a safe place.

Tracking Management API Usage

To monitor the usage of Management API calls, navigate to the Team Settings tab. You will find a comprehensive chart located alongside other usage metrics, allowing you to stay informed about your organization's activity.