Tenant API Permissions – Help Center

1. Tenant API Permissions

The API Permissions section is a central place to manage access to different API groups in the system. Each group covers a particular area, like customer data, payment processing, or product management, and contains related API endpoints. Administrators can control if an API group is available and whether it is enabled for a specific tenant. By grouping APIs into clear categories with permission toggles, the platform provides secure and flexible access control that is specific to each tenant.

Go to Administration
Click on Admin Settings
Click on Tenant API Request under Admin Settings Action

2. Tenant API Overview

The image shows the API Permissions panel, which helps you manage access to different APIs for various business functions. Each API category—like SALES_ORDER, CUSTOMER, PAYMENT, or PRODUCT—groups related API endpoints under one name. For example, the SALES_ORDER category includes APIs for creating, updating, deleting, or downloading sales orders. This grouping makes it easier to control access and manage permissions for specific tasks, simplifying the auditing of API usage.
Within each API category, there are two key toggle controls: Available and Enable. The Available toggle determines whether the API group is visible and accessible within the tenant’s environment. If disabled, the entire set of APIs under that category remains inaccessible. The Enable toggle governs whether the APIs can actually be executed. Both toggles must be turned on for an API request to proceed successfully. When a user initiates an API call, the system first verifies that the related API category is both available and enabled. If either condition is not met, the request is denied, and a message is returned indicating that the API permission is not enabled or available.
By organizing APIs into clear categories and checking permissions when requests are made, the system allows only authorized operations. This reduces the risk of misuse and makes administration more efficient.