Skip to main content

API Access Tokens

Amanda Cross
Updated

An API access token is a unique string that you include in your API code to prove your identity. Ringba uses this value to authenticate your code before allowing it to make changes to your account. You create an API access token in the Ringba Portal.

This feature is available to admin, publisher, and buyer users. It is included in all Ringba subscription plans: Business, Professional, and Enterprise. Using the API requires coding ability.

API Access Tokens Screen

You navigate to the API Access Tokens screen by clicking Security > API Access Tokens.

A table appears with a row for each API access token.

API_Access_Tokens_screen

The table contains the following columns:

  • Name: The name you entered when you created the API access token.
  • Date (Last Use): The date and time when an API request used this API access token.
  • Resource (Last Use): The resource used by this API access token's most recent API request.
  • IP (Last Use): The IP address this API access token's most recent API request came from.
  • Actions: Click the button with three dots in this column to show a menu of actions you can perform on this API access token. See the following section.

You can click the column headers to sort the table by the value in that field. Click the header again to reverse the sort, and click it a third time to remove the sort. You can use the icons in the Actions column to perform other operations on API access tokens.

Available Actions

Click the button in the Actions column to open a menu of actions you can use to manage your API access tokens.

API_Access_Tokens_actions

Click the items in the Actions column list to perform the following actions:

  • Token Usage Details: Open a drawer of information about all the times this API access token has been used.
  • Delete: Delete this API access token. Any API requests that try to use a deleted access token fail.

How to Create an API Access Token

You must have a Ringba account to perform this procedure. You sign in to the Ringba Portal to complete these steps.

Use the following steps to create an API access token:

  1. Navigate to Security > API Access Tokens.

    api_access_tokens_nav.png


    The API Access Tokens screen appears.

  2. Click the Add API Access Token button to open the drawer.

    API_Access_Tokens_create_drawer
  3. Enter a Name for the token. You may need to confirm your username and password and enter your multi-factor authentication code.

  4. Click Add.
    The newly created API access token appears.

    API_Access_Tokens_token


    IMPORTANT: You must copy the API access token and save it. You cannot display this token again once you close the drawer.

  5. Click the copy icon to copy the token to your computer's clipboard.
  6. Paste the token into a separate secure location to use later.
  7. When you are sure you have the token securely stored, you can close this drawer.

Use this token for any future API requests.

Using an API Access Token in API Requests

You can find documentation and examples of the methods, objects, and properties in the Ringba API Documentation.

In the examples in the API documentation, the API access token you just created replaces the following placeholder string:

{apiToken}

This string appears in the following header:

Authorization: Token {apiToken}

API Access Tokens FAQ

What should I do if I need help?

If you have any questions or need additional help, please reach out to our support team via chat or email at support@ringba.com.

Related articles