API Keys

Generate API Key

ICT allows developers to generate a user API Key and communicate with the Sentiance Backend:

1. Login to Insights Control Tower

2. Navigate to the "Developer" tab

3. Under "API Keys", click on button "Create API Key"

4. Choose a name for this new API Key, the name is for visual purposes only and has no operational impact. Choose a name that would help you identify the key.

5. Select the permission scopes. These scopes define what operations an API Key can perform.

   Scope name	Scope description
   USER_READ	Use this scope to read user data.
   USER_DELETE	Use this scope to delete a user along with all historical data.
   USER_LINK	Use this scope to perform User Creation & Authentication.
   OFFLOADS_READ	Use this scope to list Offloads available for download.
   OFFLOADS_GENERATE_URL	Use this scope to generate URLs at which offloads can be downloaded.
   FAKE_DATA_INSERT	Use this scope to inject fake. Engagement platform only!

6. Click on create API Key.

7. The API key is now available for copy or download. Please copy and store it securely. For security reasons, this API key is displayed only once and cannot be viewed again.

8. After creation success, store your API Key in a safe environment and update your backend system to include the newly created API Key

Do NOT share your API Keys and keep your credentials in a secure environment. Never include your API Keys in you client side application