Customize Your Expert Knowledge-sharing Platform with AnswerHub

Welcome to our documentation site where you can learn how to import/export data, integrate with third party applications, and write custom AnswerHub user interfaces.

Get Started

Grant the Use API Permission to an AnswerHub 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, follow these steps:

1. Log in to AnswerHub

Log in with a user who can access the Administration page. To login as an administrator, click Sign In in the top right and enter your username and password.

2. Go to the Administration Dashboard

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

3. Go to Users & Groups to Manage Users

Select the Manage tab under the Users and Groups section.
Result: The Users, Groups, Custom Roles drop-down is displayed.

4. Choose One of Two Ways to find a User

There are two ways to find the user to update their permissions.
a. Scroll through and find the user within the Users pane
Result: The Permissions: [User] page is displayed.

  • Click the Wrench icon next to the user you wish to have the Use API permission and select Permissions.

b. Using the search field, you can start typing in the name that you want and then select the user.
Result: You will arrive at the user account information section.

  • Click the Wrench icon and select Edit Permissions.
    Result: The Permissions: [User] page is displayed.

5. Open Advanced Settings in Site Permissions

Within the Site Permissions column, click the Wrench icon and select Advanced.
Result: The Advanced Editor is displayed with multiple roles options.

6. Go to Other Roles in the Advanced Editor

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

7. The USE API permission should be enabled

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 an AnswerHub User

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