From Bright Pattern Documentation
Jump to: navigation, search
(Created page with "= How to Give a User API Access = The following tutorial describes the two components required for any Bright Pattern Contact Center (BPCC) user to be able to use the variou...")
 
 
Line 1: Line 1:
 +
<translate>
 
= How to Give a User API Access =  
 
= How to Give a User API Access =  
  
Line 76: Line 77:
 
<li>Click “Apply.”<br></li>
 
<li>Click “Apply.”<br></li>
 
</ol>
 
</ol>
 +
</translate>

Latest revision as of 16:27, 3 August 2021

• 5.8

How to Give a User API Access

The following tutorial describes the two components required for any Bright Pattern Contact Center (BPCC) user to be able to use the various BPCC APIs: privileges and API secrets.

Privileges

User roles and permissions are a necessary part of granting access to the Bright Pattern system. Certain privileges are required in order to use certain APIs. For example, in order to write to a list, the user must first have the Manage Lists privilege. This privilege lets the user populate the list records, and the API secret key will allow the system to execute further actions on behalf of the user via API.

  1. Login to Bright Pattern’s Contact Center Administrator.
  2. Click Users & Teams on the left menu.
  3. Click Users.
  4. Choose a user from your user list that has the role you wish to use selected.
  5. In this example, we have picked a user that has Agent and Supervisor.
    1. Note: Many users create a special Admin user just to manage lists.
    2. You are creating a user that the API call will later impersonate. This is done so that the program may execute actions on this user’s behalf.
      1. Example: This user will be used to pass information from the website form to the API. This is why this user must have access rights to populate the list records via Manage Lists under Service and Campaign Administration.
  6. Click “Apply.”



Any user with the appropriate permissions is acceptable. Alt: Screenshot of the User Role page with Supervisor highlighted


  1. Go to “Users & Teams” on the left menu.
  2. Click “Roles.”
    1. In this example, we’ve chosen the role Supervisor.
  3. Go to the “Properties” tab on the right hand side.
  4. Scroll down to “Service and Campaign Administration.”
  5. Verify that the roles you’ve chosen for the user all have Manage Lists checked.
  6. Click “Apply.”



Whichever role you assign your user that will be implemented for the API processes, make sure that they have Manage Lists checked.


Generating an API Secret

The API secret is required for any user who will be making API requests. The user will also need related privileges in order to pass into the Bright Pattern system.

  1. Login to Bright Pattern’s Contact Center Administrator.
  2. Click Users & Teams on the left menu.
  3. Click Users.
  4. Choose a user from your user list that has the appropriate roles with the correct permissions selected.
  5. Click the “Person” tab on the right hand pane.
  6. Locate the blank “API secret” field. There will be a “Generate” button to the right.



Screenshot of the Bright Pattern Contact Center Admin User Person pane with the API Secret generate highlighted


  1. Click the Generate button.



Screenshot of the Bright Pattern Contact Center Admin User Person pane with the API Secret now generated and highlighted


  1. This will generate an API secret number for you to pass in a script later.
  2. Click “Apply.”
< Previous | Next >