This article contains information on the V1 XML API which has been deprecated. For docs on the V2 JSON API please see here:


In this article we will give you a very broad overview of the ScreenSteps Live API and how you can use it to get your content out of ScreenSteps to your website, web application or desktop application. By using the ScreenSteps Live API you can manage all of your content on ScreenSteps but then distribute it wherever you want your users to see it.

Sites and the ScreenSteps Live API

Sites and the ScreenSteps Live API

You make your ScreenSteps articles available to users by placing them in sites. In this example we have placed Manual B in a private site.  This means that no user can see the articles in Manual B unless they have permission to see that site.

Requesting the manual via the API

Normally, if I wanted users to see a protected manual I would have to create users accounts for them on my ScreenSteps site. But using the API I control the access via any other mechanism I choose.

In the above diagram I have a web application residing on my own server and a desktop application. By making a proper request over the HTTPS protocol I can gain access to the contents of my protected site.

ScreenSteps responds with XML

If the request is properly authenticated, your web or desktop app will receive an XML response containing the contents of your articles.  You can request the contents of a site, the contents of a manual or the contents of an article.


Add your comment

E-Mail me when someone replies to this comment