API Keys

Generating API Keys

To access and execute the APIs, you need credentials in the form of API key.

Generate the API keys using the following steps;

Step-1

Sing in to the platform with the registered email address and navigate to the Admin section and select the Generate an API Key option.

Admin Panel on the platform

Admin Panel on the platform

Step-2

Give a name to your API Key ( for eg; "First API Key") & click on Save & Add.

Step-3

The API Keys will be saved in the Admin section for future reference and can be used to see the status of the API.

The Admin Control page consisting of all the API Keys

The Admin Control page consisting of all the API Keys


Organization Settings

General Settings

General settings include the following options

  1. Owner: Owner Email address
  2. Organisation Name
  3. Country of Operation
  4. Industry

Notification Settings

The following menu can be used to toggle various notification and edit the email address receiving the notification

Members

A merchant organization has two types of user roles:

User RolesPrivileges
Admin*create credentials, create invitations, assign members to organizations, delete credentials, delete invitations, read credentials, read invitations
Membermember of a merchant organization

*Only admin users can add new admins or members using the Invite New User feature.

Inviting new users

To invite a new user, complete the following steps:

  1. Log in to the Bureau Platform.
  2. In the left panel, expand the Settings menu and select Organisation Settings. Open the Members page.
  1. Click + Invite New User. The Invite New User dialog opens.
  2. To invite a new user into your Bureau Dashboard, enter the Email address.
  3. Select any one, or both, of the following options for user Role:
    1. Admin - to provide new users with admin privileges
    2. Member - to provide new users with only member privileges
    3. Both Admin and Member: to provide new users with both admin and member privilege
  4. Click Invite. A Success confirmation box appears indicating that the system successfully sent the invitation to the provided email address.
  5. Click OK. _The Users page appears and displays the email address of the newly invited user. The Status of the user will remain Pending till the user opens the email and follows the instructions to join your organization in Bureau Dashboard.

Searching users

You can use the Search bar to find users from the list of users. To search for users, complete the following steps:

  1. In the left panel, expand the Admin menu and select Users. The Users page opens.
  2. Place the cursor in the Search bar.
  3. Type the complete email address or part of the email address.
  4. Press the Enter key. The system displays results that are similar to the string that you entered in the Search bar.

Editing user roles

An admin user can modify user roles of existing users in an organization. An admin can modify user roles only for users whose Status is Accepted. To edit user roles, complete the following steps:

  1. In the left panel, expand the Admin menu and select Users. The Users page opens.
  2. Locate the required user or email address. You can also use the Search bar to locate the email address.
  3. Move the cursor over the email address and select the three vertical dots succeeding the user Status.
  4. Select Edit. The Edit User dialog opens.
  5. If required, change the user Role.
  6. Click Save. A Success confirmation box appears indicating that you successfully updated user details.
  7. Click OK.

Troubleshooting

The following are some troubleshooting solutions in case you see any errors:

  • Ensure that you enter the correct email address to receive the invitation.
  • You will see a warning if the email address has already been invited.
  • The search works dynamically. If it does not, press the Enter key. If it still does not work, check your Internet connection.
  • In the Edit feature, the Save button gets enabled only if you make some changes.
  • You cannot edit users who have not yet accepted their invitations.

The following animated GIF image shows how to add users, search users, and edit user roles:


What’s Next

Learn to create workflows