ScreenStepsScreenSteps API v2 JSON APIOverview and Authentication (v2 JSON API)

Overview and Authentication (v2 JSON API)

The ScreenSteps v2 JSON API is designed to allow you to:

  • Extract content from your ScreenSteps site for backup purposes
  • Extract content from your ScreenSteps site for publishing to other systems

It is a read-only API. It is not designed for updating content in ScreenSteps.

Security and authentication

All API requests must be done over SSL. Authentication is done using basic authentication with:

  • Your ScreenSteps login and password, or
  • Your ScreenSteps login and an API token

See: How to create an API Token

API tokens are account wide and are not tied to an individual user on your account. 

If you want to limit the access of an integration to your content then you should use a username/password combination for a user who has the permissions you want.

For example, if you only want an integration to have access to a single site on your account then you should create an Author or Reader user, assign them to the site and use their username/password for the integration.

Basic authentication

Use the following format:

{login}:{api_token or password}
curl -u me@example.com:st_lOXL-sHouKuTan3i-LtOgg https://myaccount.screenstepslive.com/api/v2/sites.json
How to generate an API token
  1. Select Account Settings
  2. Select API Tokens

Request format

You must set an Accept: application/json header on all requests.

Response format

All responses will be in JSON format.

0 Comments

Add your comment

E-Mail me when someone replies to this comment