This article will guide you in accessing Timbre API documentation as well as guiding you in finding the key information to make use of our API.
The Timbre API is a premium feature that is only available to Enterprise level customers.
In order to activate the API features for users, the account admin will have to follow the steps laid out below under the "Activating API permissions" header.
TABLE OF CONTENTS
- Accessing API Documentation
- Retrieving your API Access Token
- Activating API Permissions
- Accessing API Documentation (UI Walkthrough)
- Retrieving your API Access Token (UI Walkthrough)
- Activating API Permissions (UI Walkthrough)
Accessing API Documentation
- Step 1: Access your Timbre account.
- Step 2: Scroll to the bottom of the page where you will find API Docs in the bottom right-hand corner of the screen.
- Step 3: Use the toggle button at the top of the page to access more information.
Retrieving your API Access Token
- Step 1: After logging in to Timbre, navigate to Preferences.
- Step 2: In the Preferences window, select Other Settings and then API Access.
- Step 3: Select "Create Token".
Activating API Permissions
- Step 1: As the account admin, navigate to 'Preferences' and select the "Manage Users" tab.
- Step 2: Click on 'Actions' found next to any user and select 'Permissions'.
- Step 3: From the 'API Access' drop-down menu, enable API access.
- Step 4: Save permissions.
Accessing API Documentation (UI Walkthrough)
Step 1: Access your Timbre account.
Using your email address and password, log in to https://timbrecms.sharp-stream.com/login
Step 2: Scroll to the bottom of the page where you will find API Docs in the bottom right-hand corner of the screen.
Retrieving your API Access Token (UI Walkthrough)
Step 2: In the Preferences window, select Other Settings and then API Access.
Step 3: Select "Create Token".
Please note that the token created will not be retrievable by SharpStream once generated. Therefore the customer must keep a record of that token.
Activating API Permissions (UI Walkthrough)
Step 2: Click on 'Actions' found next to any user and select 'Permissions'.
Step 4: Save permissions.