Administration functionalities
Introduction
The Admin Functionalities section in ApiShare is accessible from the main menu and provides tools for managing platform-wide configurations. This section is available only to Owners and allows administration of entities such as Tags, Categories, Integration Patterns, Roles, and Notifications.
Managing tags
Creating a tag
Prerequisites:
Users must have Administrator or equivalent permissions.
Steps:
Navigate to Admin Functionalities > Tags.
Click + to open the New Tag modal.
Enter the Tag Name (required) and Description (optional).
Click Save.
Post-Conditions:
The tag is created and can be assigned to various entities.
Editing a tag
Steps:
Select a tag from the list.
Click Edit and modify the details.
Click Save.
Post-Conditions:
The tag updates immediately across the platform.
Deleting a Tag
Steps:
Select a tag from the list.
Click Delete and confirm.
Post-Conditions:
The tag is permanently removed from all associated entities.
Managing categories
Creating an API or App category
Prerequisites:
Requires Administrator or equivalent permissions.
Steps:
Navigate to Admin Functionalities > Categories.
Choose API or App category.
Click + to create a new category.
Enter the Category Name and Description (optional).
Click Save.
Post-Conditions:
The category is created and can be assigned to API Products, API Assets, or Apps.
Editing a category
Steps:
Select a category from the list.
Click Edit and update the details.
Click Save.
Post-Conditions:
The category is updated and immediately reflected in the platform.
Deleting a category
Steps:
Select a category from the list.
Click Delete and confirm.
Post-Conditions:
The category is permanently removed from all associated entities.
Managing integration patterns
Creating an integration pattern
Prerequisites:
Requires Administrator or equivalent permissions.
Steps:
Navigate to Admin Functionalities > Integration Patterns.
Click + to create a new integration pattern.
Enter the Name, Description, and select if the pattern is Productizable.
Click Save.
Post-Conditions:
The integration pattern is created and can be assigned to API Assets.
Editing an integration pattern
Steps:
Select an integration pattern from the list.
Click Edit and update the details.
Click Save.
Post-Conditions:
The integration pattern updates immediately in the platform.
Deleting an integration pattern
Prerequisites:
The integration pattern must not be assigned to any API Asset.
Steps:
Select an integration pattern from the list.
Click Delete and confirm.
Post-Conditions:
The integration pattern is permanently removed.
Cloning an integration pattern
Steps:
Select an integration pattern from the list.
Click Clone.
Enter the New Name and Description.
Click Save.
Post-Conditions:
A duplicate of the integration pattern is created.
Managing roles and permissions
Creating a role
Prerequisites:
Requires Administrator or equivalent permissions.
Steps:
Navigate to Admin Functionalities > Roles.
Click + to create a new role.
Enter the Role Name and Description.
Click Save.
Post-Conditions:
The role is created and available for assignment.
Editing role permissions
Steps:
Select a role from the list.
Click Edit Permissions.
Modify Environment and Entity permissions.
Click Save.
Post-Conditions:
The role’s permissions are updated.
Assigning roles to users
Steps:
Navigate to Organizations & Groups.
Select the target Organization and Group.
Click the Role Dropdown next to the user’s name.
Select a new role.
Post-Conditions:
The user’s role is updated immediately.
Managing notifications
Viewing notifications
Steps:
Navigate to Admin Functionalities > Notifications.
Select an entity from the list to see related notifications.
Post-Conditions:
The notifications for the selected entity are displayed.
Enabling or disabling a notification receiver
Steps:
Select a notification from the list.
Click Edit to modify receiver settings.
Enable or disable push/email notifications.
Click Save.
Post-Conditions:
The notification settings for the receiver are updated.
Pausing or resuming notifications
Steps:
Select a notification from the list.
Click Pause to stop notifications or Play to resume.
Confirm the action.
Post-Conditions:
The notification is paused or resumed accordingly.
Adding a notification reminder
Steps:
Select a notification related to a deadline (e.g., API deprecation).
Click Edit.
Add a new Reminder Slot.
Click Save.
Post-Conditions:
A reminder notification is set before the main event.
Deleting a notification reminder
Steps:
Select a notification.
Click Edit.
Remove a Reminder Slot.
Click Save.
Post-Conditions:
The reminder notification is removed.
Managing visibility settings
Configuring API visibility
Steps:
Navigate to Admin Functionalities > Visibility.
Select API visibility settings.
Choose access type:
Full Access (public, including guests).
Custom Access (restricted by organization type, category, or specific organizations).
Click Save.
Post-Conditions:
API visibility is updated based on the selected criteria.
Configuring documentation visibility
Steps:
Navigate to Admin Functionalities > Visibility.
Select Documentation visibility settings.
Choose access type and configure restrictions.
Click Save.
Post-Conditions:
Documentation visibility is updated.