Giving access to your TV schedules via API allows for setting up API calls that automatically updates schedule data.
Adding TV schedule subscribers is done in the Schedules module. Enter Schedules and choose API users in the left side menu.
Active and inactive users
The list displays all added users. Status to each user shows if the API set up is active (green) or inactive (grey).
Add new user
To set up a new user, click on the Add user button to the right.
Name and description - this is where you add details of the user. We recommend that you add email address and company name, this to easily identify what company you have given API access too. You also want to add an email address since you need to sent a user the access key for them to be able set up the API call.
Activating/deactivating a user
To activate a user, switch the activation button from OFF to ON. Click Create.
This is also how you deactivate a user, if you want to cut access to the API.
Send information to user
As a last step you need to send the API documentation and unique URL plus key required for the user to access. Click on the email icon to the user in the list and enter the email address in the top field. Click Send.
API versions
The API is based on Public Schedule and we're releasing updates of the version when needed. The current default version is selected in the dropdown menu in the documentation page and it's also the version we're linking to in the information email sent to your invited API users. They can, however, choose to work with another version if they want to. All versions listed in the dropdown menu will be supported.
Comments
0 comments
Please sign in to leave a comment.