Questions? Contact Us
  Blue Mango Learning Systems
  • Home
  • Forums
  • Documentation
  • Submit a request
  • Check your existing requests
ScreenSteps Documentation » ScreenSteps Live API » PHP Library

Topics

  • Getting Started 4
    • Overview
    • API Calls
    • Generating the Authentication Header When Basic Authentication
    • Generating the Authentication Header When Using ScreenSteps Live API Key
  • How To's 2
    • Requesting and Displaying Image Data
    • How Do I Get a List of Manuals From the API?
  • Example XML Output 2
    • Spaces
    • Manuals
  • Example Code/Libraries 2
    • PHP Library
    • Ruby API Wrapper

Last Updated

Apr 20, 2010

Download Manual PDF

Other Resources

  • ScreenSteps Desktop & Workgroup

  • ScreenSteps 2.9
  • ScreenSteps Workgroup
  • Customizing HTML Templates
  • ScreenSteps: Tips & Tricks
  • Creating Word Templates
  • Publishing to Blogs & Wikis
  • ScreenSteps Live

  • ScreenSteps Live
  • Setting up a New Admin, Editor or Author on ScreenSteps Live
  • ScreenSteps Live Support Client
  • Integrating ScreenSteps Live With Other Services
  • Collaborating on ScreenSteps Live
  • ScreenSteps Live Remote Authentication
  • ScreenSteps Live API
  • API Examples
  • Implementation Guides

  • Creating a Software Manual With ScreenSteps
  • Creating a ScreenSteps Live Support Site
  • Improving your Zendesk Support Site with ScreenSteps Live

Comments

0 comments for this lesson

  • Prev: Manuals
  • Next: Ruby API Wrapper

PHP Library

Download the ScreenSteps Live API PHP class.

Edit sslive_include.php

Media_1241121698381

In order to use the PHP class on your website you will need the sslive_class.php, HMAC.php and sslive_include.php files.

To get started all you need to do is configure sslive_include.php with your ScreenSteps Live account information.

Media_1241121755205

The ScreenSteps Live API can be accessed using an API key (how do I find my API key?) or the username/password for a Reader account (what is a Reader account?). By default the sslive_include.php file creates an instance of the SSLiveAPI object (1) and sets the credentials using an example Reader account on example.screenstepslive.com (2).

If you just want to test you can leave the example settings in place.

Test Using Example Files

Media_1241121812031

The sslive_api_php folder provides two folders with example code. The plain folder just displays content from ScreenSteps Live with minimal HTML formatting. When just getting started it will be easiest to read this code and become familiar with the SSLiveAPI object methods. The pretty folder is a little nicer on the eyes and includes styling from the screensteps.com website.

What You Should See

Media_1241121905313

The next few screenshots show what you should see if you are using the example.screenstepslive.com settings and looking at the plain folder files. To begin open the spaces.php file.

A Space

Media_1241121912792

A Manual

Media_1241121917033

A Lesson in a Manual

Media_1241121938176
  • Prev: Manuals
  • Next: Ruby API Wrapper

Comments (0)

Add your comment

E-Mail me when someone replies to this comment

Documentation powered by ScreenSteps Live