In the Dengage platform, the API Users section under Settings > Identity & Access Management is designed for managing API users who have access to your account.
To navigate to this menu please follow:
API Users
Here, you can view existing API users and add new ones.
API User Listings
1️⃣ Overview
User Defined: This refers to the name or identifier/key of the API user, which helps distinguish between different API users. This user name or key is used as the User ID for logging into our API interface.
Description: Provides additional information or context about the API user, such as the purpose or use case for which the API user was created.
Created At: Indicates the date and time when the API user was created. This can help track the age of the API user and understand how long it has been in use.
2️⃣ Add: This option allows you to add a new API user, specifying details such as the user's name and description to help manage and control access to your account's data via API.
How To add a new API User
To add an API User, click the Add button on the page. This will display the popup shown below.
Adding a new API User.
In the Add New section for API Users within the Dengage settings, you can specify the access permissions and information for a new API user. This section includes the following fields and options:
1️⃣Name and Password: The system will automatically create a name and password for the new API user.
❗️
Important Note: Password display only at once
The password for the new API user will be displayed only once during the creation process and will also be sent to your registered email address. Please ensure you remember the password and store it securely. If you forget the password, you may not be able to retrieve it. Handle this information with care.
2️⃣Description: Provide a brief description of the API user, which can offer context and help differentiate between different API users.
3️⃣Permissions: This section allows you to assign specific permissions to your API User.
Transactional Email: Permission to send and report transactional emails.
Transactional SMS: Permission to send and report transactional SMS messages.
Transactional Push: Permission to send and report transactional push notifications.
Data Space: Permission to create and edit data tables and import data.
Content: Permission to create and edit SMS, email, and push content.
Email: Permission to create and edit email sends.
SMS: Permission to create and edit SMS sends.
Push: Permission to create and edit push sends.
Reports: Permission to get send and event reports.
📘
Permissions Types
Permission -> Read / Manage
Read: This permission enables the API user to read reports or data from the platform but does not allow making changes within that specific section.
Read Permission
Manage: If you grant Manage permission, Read permission is automatically included. Manage permission allows the user to not only access data but also create, edit, and delete within the specific section.
Manage Permission
You can choose the permissions based on the level of access and control you want to grant the new API user. These permissions determine the actions the API user can perform within the Dengage platform.
