Talking in Pictures

A blog about visual communication

ScreenSteps Desktop 2.7 Now Available! Download ScreenSteps 2.7

Posts Tagged ‘API’

FogBugz Search Widget – Search Your ScreenSteps Live Knowledge Base From FogBugz

We are happy to announce the availability of a ScreenSteps Live widget for FogBugz help desks. This widget will allow FogBugz users to quickly search their ScreenSteps Live knowledge base right from within their FogBugz help desk. The video below give a quick overview.

You can find instructions on how to install the widget here:

Installing the ScreenSteps Live FogBugz Search Widget

Want to Learn More About Visual Knowledge Bases?

Download our free webinar: ScreenSteps Live – Key Concepts for Effective Visual Knowledge Bases

Bookmark and Share

The ScreenSteps Live API Ruby Wrapper

Today we have released a new Ruby wrapper for interacting with the ScreenSteps Live API using ActiveResource. The video below shows some examples of using the wrapper in the console. The API will let you:

  • Retrieve spaces, manuals, buckets and lessons
  • Search spaces, manuals and buckets
  • Get lessons for a given tag in a space, manual or bucket
  • Create tasks in your ScreenSteps Live account

We hope that this will make it easier for Rubyists to integrate ScreenSteps Live with their Ruby applications.

You can download the latest version of the library at GitHub: http://github.com/bluemango/ScreenSteps-Live-API-Ruby-Wrapper

Several of the ideas for setting up the library were taken from the Batchbook ruby library.

Bookmark and Share

ScreenSteps Live API Example: Zendesk Widget

Some of you may be familiar with Zendesk, a popular help desk application. Zendesk has this great feature that allows you to create custom widgets in your sidebar. With just a little bit of work we were able to create a ScreenSteps Live widget that allows us to search all of our content on ScreenSteps Live. That way we can quickly copy the url for a lesson and paste it right into a response to our customers.

Watch the video below so see an example:

You can get the code for the widget and instructions on how to configure the widget here: ScreenStep Live Zendesk Widget Example

Bookmark and Share

The ScreenSteps Live API Developer Guide

The 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)

Authorization String

(more…)

Bookmark and Share
Screensteps Support Suite

ScreenSteps is the most effective tool for creating and delivering customer tutorials and guides.
Learn about the ScreenSteps Support Suite