TeamHub REST API

Grant the Use API Permission to a TeamHub User

After the REST API is enabled in the site administration page, you must then give yourself the USE API permission.

Notes:

  • Each call made to the REST API must be authorized with a username and password pair that belongs to a user with permission to use the API.
  • This permission could also be applied more generally to a group of users (for example, the Super Users group).
    • Setting permissions by group will grant access to the REST API for all users in the selected group.

To grant API permissions to a user ("answerhub," in the Theme Simulator, if you want to be able to use our example requests as they appear in this guide), follow these steps:

  1. Log in with a user who can access the Administration page. (In the case of the Theme Simulator the user is "answerhub" and the password is "answerhub").

  2. Click on your Avatar icon at the top right of the AnswerHub page and select Administration.
    Result: The Dashboard tab of the TeamHub Administrator Dashboard is displayed.

  3. Select the Users & Groups tab.
    Result: The Users & Group Summary page is displayed.

  4. Within the the Users pane, select Manage Users.
    Result: The Manage Users page is displayed.

  5. Click the Gear icon next to the user you wish to have the Use API permission (in the Theme Simulator "answerhub") and select Permissions.
    Result: The Permissions - [User] page is displayed.

  6. Click the Gear icon in the column of the site you wish to send API requests to (for the Theme Simulator, the column is labeled as AnswerHub SDK) and select Advanced.
    Result: The Advanced Editor is displayed.

  7. Within the Advanced editor, scroll down to the Other Roles section and in the Status dropdown menu, next to Use API, select Grant.

  8. Click Ok
    Result: The Use API permission should now be displayed in green in the column you chose in step 6.

Grant the Use API Permission to a TeamHub User

After the REST API is enabled in the site administration page, you must then give yourself the USE API permission.