API Privileges
Overview
API Privileges in the portal refer to the specific permissions and access controls assigned to users regarding the use of the application's API. These privileges determine what actions users can perform through the API, such as creating, reading, updating, or deleting resources. By managing API privileges, administrators can enhance security, ensuring that only authorized users have access to sensitive functionalities and data. This feature is essential for maintaining compliance and controlling the interaction between the portal and other applications or services. Through the API Privileges management interface, administrators can easily configure and adjust permissions based on user roles and organizational requirements.
In this section, you can explore topics such as:
Add new API role
-
Navigate in the Order: Access the Client section option locates on the left side of the portal. From there, locate the API Privileges menu. This section is dedicated to managing roles related to API access and security.
-
Add API Role: Within the API Privileges interface, you will find the option to add a new API role. Clicking this button initiates the process of creating a new role that can be assigned to users, allowing you to tailor their access levels based on specific needs.

- Enter the Role Name & Description: After clicking the Add API Role button, you will be prompted to fill in important details about the new role. Enter a clear and descriptive name for the role, along with a brief description that outlines its purpose. This helps in identifying the role later. Additionally, you will need to assign specific permissions to this role, defining what actions users assigned to this role can perform via the API.


-
Set Full Permissions: If your intention is to grant comprehensive access to all functionalities and data through the API, you can opt for the Full Access option. This setting ensures that users with this role can perform any action available in the API, thereby simplifying management for roles that require extensive capabilities.
-
Assign Specific Roles: Alternatively, if you want to provide more granular control over the API permissions, you can select the option for assigning specific roles. This allows you to define particular permissions rather than granting full access. After selecting this option and specifying the desired permissions, you will then click the Create Role button to finalize the setup.

View API Role
- Navigate in the Order: Access the Client section option locates on the left side of the portal. From there, locate the API Privileges menu. This section is dedicated to managing roles related to API access and security. From this list, select the specific API role that you wish to examine in detail. After selecting the role, click on the "View Role" button. This action prompts the system to retrieve and display comprehensive information about the selected role, including its permissions and settings.

- Selected API Roles: Upon clicking the "View Role" button, the portal will present the details of the chosen API role. This display typically includes important information such as the role name, description, assigned permissions, and any specific constraints or settings associated with the role. By reviewing this information, administrators can assess the capabilities granted to users assigned to this role, ensuring that the API access aligns with organizational policies and security requirements.

Edit API Role
To edit an API role within the portal, follow these detailed steps:
- Navigate in the Order: Begin by accessing the main interface of the portal and navigate to the "Clients" section. Within this section, look for the "API Privileges" option, which allows you to manage the API roles associated with your clients. Once in the API Privileges area, you will see a list of available API roles. Select the specific API role that you wish to edit. After selecting the desired role, click the "View Role" button. This action takes you to a detailed view of the selected API role, where you can review its settings and permissions. From this detailed view, you can then click on the "Edit Role" option to initiate changes to the role's configuration.

-
Edit Role: Upon clicking the "Edit Role" option, the portal will redirect you to the Edit Role screen. This screen is specifically designed for modifying the attributes of the API role, providing fields for you to update the role name, description, and permissions associated with that role. The interface with check boxes , enabling you to make necessary adjustments according to your requirements.
-
Update Role: In the Edit Role screen, you can make the desired changes to the role's details. Whether you're updating the role name, altering permissions, or changing the description, ensure that all modifications reflect the intended access levels and organizational policies. Once you have completed the necessary edits, locate the "Update" button, which confirms and saves your changes. Clicking this button will process the updates you've made to the role.

- Successful updated: After clicking the "Update" button, the portal will process the changes and provide feedback. A notification or confirmation message will typically appear, indicating that the role has been updated successfully. This assurance confirms that the modifications have been saved in the system, and the API role now reflects the updated settings. The updated role will now be applied to all users assigned to it, allowing them to access the API with the revised permissions.

Delete Role
To delete an API role within the portal, follow these detailed steps:
- Navigate in the Order: Begin your process by accessing the admin portal and navigating to the "Clients" section. Within this section, find the "API Privileges" option, which provides access to the management features for API roles assigned to your clients. Once in the API Privileges area, you will see a list of existing API roles that have been created. Select the specific API role you wish to delete from this list. After selecting the appropriate role, look for the option labeled "Delete Role." This option initiates the deletion process for the selected API role.

- Delete confirmation: After selecting the "Delete Role" option, the system will typically prompt you to confirm the deletion. This confirmation step is crucial, as it prevents accidental deletions. A dialog box or confirmation message will appear, asking if you are sure you want to proceed with the deletion of the API role. Review the information provided in the confirmation prompt to ensure that you are deleting the correct role. If you are certain, click the "Delete" button to finalize the removal of the API role.

- Successfully Deleted: Upon clicking the "Delete" button, the system will process your request to remove the API role. Once the operation is complete, you will receive a confirmation message indicating that the selected API role has been successfully deleted. This message confirms that the role is no longer available in the admin portal and that any permissions associated with it have been revoked. As a result, any users who were assigned to that role will lose access to the API features tied to it.
