Skip to main content
Use an API Key (also called an API token) for long-lived API access. An API Key is always bound to an Application. Create an Application first, then generate an API Key under that Application.

​
Core Concepts

​
Application

An Application represents your own business application. You choose a unique name and can add an optional description. The application name must be unique across the system.
Note: You must create an Application before you can create an API Key.

​
API Key (API Token)

An API Key is a string credential bound to an Application. It is valid for 1 year and is used for long-term API calls, without requiring repeated login. Requests should include an Authorization header containing the word Bearer followed by the API Key.

​
Create an Application and API Key

​
Step 1: Create an Application

  1. Log in to the portal.
  2. Open the Account page and find the API Portal entry.
  3. Click to add an Application.
  4. Enter a unique application name and a description, then save.

​
Step 2: Generate an API Key

  1. Find the Application you just created.
  2. Click the + icon next to that Application to generate an API Key.
  3. The API Key is valid for 1 year.

​
Step 3: Download the Credential

  1. Download the credential file.
  2. Retrieve the string key and use it as the Bearer token when calling Silicon Data APIs.

​
Delete an Application and API Key

​
Step 1: Delete API Keys

Delete all API Keys under the Application first.

​
Step 2: Delete the Application

After all keys under the Application have been removed, you can delete the Application.
Note: An Application cannot be deleted until all of its API Keys have been cleared.

​
If an API Key Is Leaked

  1. Delete the compromised API Key.
  2. Create a new API Key under the same Application.
  3. Update your integrations to use the new key.

​
Contact and Support

For additional information or technical support, please contact: