API Group
Was this helpful?
Was this helpful?
Path: Client Management > API Group
API Group is for creating and maintaining API groups. APIs with the same authentication type can be placed in the same group here; APIs in this group will correspond to authorizable client permissions according to the security levels originally set; when selecting the API Scope, a group is used as the unit and authorized at once. This function is usually used to authorize API clients.
Take the figure below for example. The Module list has three groups /A, /B and C, in which group C contains the four APIs #C1, #C2, #C3 and #C4. If users need to use them, all four APIs in the group will be authorized for them at once.
Click Create Group to access the group creation page.
Fill in the data or make selections as instructed below. The fields marked with “*” are required.
Group name*: Cannot be changed.
Group alias: Alias to help identify the group.
Allowed access duration*: Number of days valid for this group; it will become invalid once expired.
If set to 0, it means there are no limits.
Number of allowed access times*: The maximum number of times this group of APIs can be authorized; it can no longer be used after the number of times has exceeded.
If set to 0, it means there are no limits.
Authentication type: Authentication type is required for the APIs in this group; multiple choices allowed.
Security level*: Security levels include A~F; the security level must correspond to the security level of the client’s account.
Simply select the default system security for the security level.
If C is selected as the security level for the client, security levels A and B cannot be found here at API Group. For more information, refer to Security level.
Description:Description or remarks of the group.
API Module: Enter to select the API module currently mounted on the digiRunner platform.
Further instructions for completing the fields.
API Module: Click Select to enter and select the API module currently mounted on the digiRunner platform.
Access the selection page and search for the module to add with the search field, then click Select to the left to add it into the module list. To cancel, click Delete to the right side of the selected module; make sure to click Apply when finished selecting.
At this time, module is added but not API. It is only added to the group name, but there is nothing inside. Click Select API to complete adding API to the module.
After selecting the API to add, click Apply.
If the group is created with no API added to the module, this module will not be added to the group. Take the figure below for example. APIs are added to /UserManual, and no API is added to /UserManualDgrcGet2. Upon clicking Create, only /UserManual will be saved to the group and not /UserManualDgrcGet2.
Click Create to save and exit.
To search for a group, enter the keywords or the authentication type or security level here to search for related groups.
The information in Details can only be viewed and not edited.
To add modules and APIs, the method is the same as to create a group.
Modify the desired fields, and click Update to save and exit.
Click Delete to delete the group and exit.
Delete the group in the Delete group page, the warning prompt for deletion will NOT appear.
If this group is set as available to a client in API Client > Security > API Group, the error “1417 - Group has been used by Client” will appear, meaning that this group is in use and cannot be deleted.
Authentication type:Click on the icon to access and select from the authentication list; multiple choices allowed as mentioned above.
Search for the group to view details, and click on theicon to access the group details page.
Search for the group to modify, and click theicon to access the update page.
Search for the group to delete, and click on the icon to proceed.
