SetUp Staffbase Client

Generating an API Token

1. In the Studio open the platform Settings.

2. In the menu, under the section System click API Access.

3. Click Create API token.
   The dialog to create the API token opens.
   

   

4. Enter a title.

5. Select read access as access level.

6. Click Create.
   The API token is generated.

Retrieving the API Token

To use the API token you have created, you can copy it to a clipboard.

1. In the Studio navigate to the platform Settings.

2. Under the section System, click API Access.

3. Click on the required API token to copy it to the clipboard.
   You can use the copied API token to establish communication between third-party services and the Staffbase API.

4. Share the API token with amber.

5. Reference: https://support.staffbase.com/hc/en-us/articles/360015755691-Generating-an-API-Token

Setting up OAuth client

• In the Studio open the platform Settings.

• In the menu, under the section System click OAuth Clients

• Click Create OAuth Client

• From the client options, select WEB, and proceed to next step.

• In the WEB interface, we have to carefully fill the fields:

  • Client Name - Give a name to the client app

  • Scopes - Defines the rights to which scope we have access. Needs to follow the format:

    • users:read:all spaces:read:all offline_access

  • Redirect URI - This is the callback URI we have in our system:

    • https://customerName.ambersearch.de/api/auth/staffbase/callback

    • Keep in mind to replace customerName accordingly

  • Allowed CORS Origins - Base of callback URI:

    • https://customerName.ambersearch.de

    • Keep in mind to replace customerName accordingly

• After filling the requirements, click Create.

• Now the client is created, and the Client Secret is visible.

  IMPORTANT: Before clicking Confirm, make sure you have copied the Client Secret, as it will not be able to be copied again, and you have to create another OAuth Client.

• After clicking Confirm, we can see the last OAuth Client App is the one we created.

  A couple more fields are shown:

  • Client ID - Identification of the OAuth Client App

  • Authorize URI/Token URI - URIs used for Authorization

• At this point the Client OAuth app is created and Staffbase client accepts OAuth logins.

  Share Client ID and Secret with amber.

Reference: https://developers.staffbase.com/guides/create-oauth-client-access/#creating-new-oauth-client-access