Important: If you are using the API to pull the HTML from your ScreenSteps site and display it in your own website then you will need to update the image permission settings for your site to get non-expiring image URLs.
See: Why are the links to my images broken?
Security and authentication
All API requests must be done over SSL. Authentication is done using basic authentication with:
- A ScreenSteps user's login name and password, or
- A ScreenSteps user's login name (admin or contributor user only, will not work with API access users) and an API token
You can locate the a user's login on the User Profile screen.
See: How to create an API Token
Basic Authentication
Use the following format:
{login}:{api_token or password}curl -u [email protected]:st_lOXL-sHouKuTan3i-LtOgg https://myaccount.screenstepslive.com/api/v2/sites.jsonRate Limiting
ScreenSteps will impose a rate limit of 300 requests/minute. If you exceed this limit you will receive a 429 response. The JSON body will a retry_in value that will tell you how many seconds you need to wait to retry your request.
How to generate an API token
Click here to see how to generate an API token
Request format
You must set an Accept: application/json header on all requests.
Response format
All responses will be in JSON format.
Will unpublished content be returned by the API?
If you are using the search API then no unpublished articles will be returned.
If you are listing the contents of a site, manual, or chapter then it depends on the type of user that you are authenticating with. For api and reader users unpublished content is not returned. For admin and contributor users unpublished content is returned.