The ScreenSteps Live API Developer Guide
Friday, July 11th, 2008The ScreenSteps Live API uses REST to retrieve manuals from your ScreenSteps Live account via xml.
Urls
The request urls are pretty simple. Currently the following requests are supported:
/api/manuals |
Retrieve a list of all public manuals for an account |
/api/manuals/:manual_id |
Retrieves the table of contents for a single manual. The manual id can be the id number for a manual or the permalink that you set up on ScreenSteps Live. |
/api/manuals/:manual_id/lessons/:lesson_id |
Retrieves the content of a lesson in a manual. Also retrieves basic information about the manual (title, and id) as well as the title and id of the next and previous lessons in a manual. |
By default only public manuals will be retrieved. If you wish to retrieve a manual that is protected then you can add the “?show_protected=true” parameter to the end of the url.
Required Headers
The following headers are required when making a request:
Date |
The current time and date in http format (e.g. Fri, 11 Jul 2008 18:24:47 GMT). |
Content-Type |
Should be set to “application/xml” |
Authorization |
This is the authorization string that you will need to compute for each request (explained below) |