API Settings

Configure the REST API to enable programmatic access to your SaaS platform. Useful for integrations, automations, and custom applications.

The SaaS module includes a REST API that allows you to programmatically manage tenants, plans, and subscriptions. This is useful for building custom integrations, automating workflows, or connecting with third-party tools.

Accessing API Settings

1. Go to SaaS Management → SuperAdmin Settings

2. Click the API Settings tab

Enabling the API

Toggle the API ON to enable REST API access. When enabled, you can:

• Create/manage tenants programmatically

• Manage plans and subscriptions

• Query tenant usage and status

• Automate onboarding workflows

API Authentication

The API uses token-based authentication. After enabling the API:

1. Generate an API token in the API Settings

2. Include the token in your API requests as a header:

Authorization: Bearer YOUR_API_TOKEN_HERE

Keep your API token secret! Anyone with your API token can manage your entire SaaS platform. Never share it publicly or commit it to a public repository.

When to Use the API

Use Case	Description
Custom signup page	Build your own registration flow and use the API to create tenants
Billing integration	Connect with external billing systems (Chargebee, Paddle, etc.)
Monitoring dashboard	Build a custom dashboard showing tenant metrics
Automation	Automatically provision tenants based on events (e.g., Zapier, webhook)
Mobile app	Build a mobile app that manages your SaaS platform

For detailed API endpoints and examples, see the API Reference.

Configuration complete! You've now configured all the essential settings for your SaaS platform. Head over to Managing Tenants to learn how to manage your customers.