API tokens are unique identifiers that allow third-party services to securely communicate with an application or system. API tokens are used frequently in integration scenarios where you need to establish communication between the Staffbase platform and third-party applications or systems. You can create API tokens in the Studio for third-party services to establish communication with the Staffbase platform. You can then use the tokens to request access to the Staffbase platform. You can create API tokens with different levels of access permissions.

Creating an API Token

You can create an API token by specifying the required access level. In addition, you can define specific Internet Protocol (IP) addresses or Classless Inter Domain Routing (CIDR) ranges that are allowed to use the API token. This setting allows you to restrict token exposure and reduce the risk of unauthorized use. 

1. In the Studio, navigate to open Settings > API Access.
2. Click Create API token.
   The  API Tokens page opens.
3. Click Create API token.
   The Create API token dialog opens.
4. In the Token Name field, provide a name.

5. Select an access level. 

   The level of access required for the API depends on the business use case. For example, Restricted Read-only access is sufficient for RSS feeds, whereas advanced integrations require Administrative access. 
6. Optionally, expand Advanced to define allowed IP ranges.
7. In the Allowed IP Ranges field, enter IP addresses or CIDR ranges that are permitted to use this token.
8. Click Create.
   The API token is created. The API Tokens overview page opens.
   You have successfully created an API. Now, you can retrieve the token you created.
    

Retrieving the API Token

Once you have created the API token, you need to retrieve it. Then in order to use it, you can copy it to your clipboard.

1. In the Studio, navigate to Settings > API Access.
   The API Tokens page opens.

2. Click the copy icon next to the API token to copy it to your clipboard.

   

   
   You have copied an API token. You can use the copied API token to establish communication between third-party services and the Staffbase platform.