This article describes the steps you take in the Ringba user interface to generate an API token. An API 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.

This article is for admin, publisher, and buyer users. Using the API requires coding ability.

API Tokens

Every API request requires an API token for authentication. Ringba API tokens never expire, and admin users can delete them at any time.

Generating an API Token

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

Use the following steps to generate an API token:

1. Navigate to Security > API Access Tokens.
   
   The Manage API Access Tokens screen appears.
2. Click the Add API Access Token button to display the form.
   
3. Enter a Name for the token, and then click ADD.
4. You may need to confirm your username and password and enter your multi-factor authentication code. Enter the requested information and click Confirm.
   A window appears containing the newly created API token.
   
   IMPORTANT: You must copy the API token from this window and save it. You cannot display this token again once you close the window.
5. Click Copy Token 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, select the I have copied the token confirmation box and click Cancel.

Use this token for any future API requests. 

What's Next

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

In the examples in the API documentation, the API token you just created replaces

{apiToken} 

in the header

Authorization: Token {apiToken}