The ScreenSteps Online Knowledge Base Everything you need to know about ScreenSteps
Blue mango logo white 250
  • Table of Contents
  • Contact Us
ScreenSteps Documentation » ScreenSteps Live API » Generating the Authentication Header When Using ScreenSteps Live API Key

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

Quicklinks

  • Downloads
  • View forums
  • Submit a help request
  • Contact us
  • Retrieve a lost license key

Last Updated

Sep 22, 2011

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
  • Zendesk and ScreenSteps Live
  • Help Scout and ScreenSteps Live
  • FAQs

  • FAQs

Comments

0 comments for this lesson

  • Prev: Generating the Authentication Header When Basic Authentication
  • Next: Requesting and Displaying Image Data

Generating the Authentication Header When Using ScreenSteps Live API Key

This lesson discusses how to create the header that is required when retrieving data from your ScreenSteps Live account using the ScreenSteps Live API and a ScreenSteps Live API Key. Alternatively you can use a Reader account's username/password.

Authorization Header When Using ScreenSteps Live API Key

The header you send with each request will look something like this:

Content-Type: application/xml
Accept: application/xml
Date: Tue, 06 Jan 2009 17:56:39 GMT
Authorization: ScreenStepsLiveAPI auth= AUTH_STRING

Generating AUTH_STRING

To create the AUTH_STRING you need the following information:

1) Your ScreenSteps Live domain.
2) The path of the resource you are requesting.
3) The date being sent in the Date header.
4) Your ScreenSteps Live API key.

Armed with the above data you create a string as follows:

SSLIVE_DOMAIN:PATH:DATE

Next create a SHA1 digest of the string using your ScreenSteps API Key as the salt. To end with you base64 encode the digest.

Here is an example in PHP that uses the Crypt_HMAC PEAR library:

$sslive_api_key = '12e5317e88';
$domain = 'example.screenstepslive.com';
$path = '/spaces/';
$httpDate = gmdate("D, d M Y H:i:s T"); // i.e. Tue, 06 Jan 2009 17:56:39 GMT
$string = $domain . ':' . $path . ':' . $httpDate;

$hasher =& new Crypt_HMAC($sslive_api_key, 'sha1');
$digest = $hasher->hash($string);
$AUTH_STRING = base64_encode(pack('H*', $digest));

$AUTH_STRING can now be passed in the Authorization header.

  • Prev: Generating the Authentication Header When Basic Authentication
  • Next: Requesting and Displaying Image Data

Comments (0)

Add your comment

E-Mail me when someone replies to this comment
Blue Mango Learning Systems © 2012