Get Satisfaction Education Center

Home > Reference Guide > Single Sign On > Implementing FastPass

Implementing FastPass

Implementing FastPass on your site is done in a few simple steps. There are two use cases: Sign-In and Sign-Over (see FastPass Overview). For a correct implementation, you must cover both scenarios.

When a user is no longer part of your users database, you should proactively delete their FastPass identity in the community using our API. This is accomplished by sending an HTTP DELETE to the endpoint /people/:canonical_name/identity or /people/:getsat_uid/identity.
Of course, if your server allows them to login again, their fastpass identity will be recreated.

When a FastPass identity is successfully deleted, the following happens:
1) All topics that the person was following in the associated community are un-followed
2) The user’s notification settings for the associated community get turned off
3) If the person had provided an NPS score, it gets cleared out
4) If the person had declared “I’m a customer”, this gets cleared out

The user’s content is never deleted or hidden, because it belongs to the user and other users may benefit from it. But for all intents and purposes, the person is no longer considered an active member of the community.

Note: We provide the following libraries and their source code as illustrations and reference implementations for Fastpass in various popular languages. It’s not practical for us to maintain these examples in multiple versions of each language. One reason we provide the source code is so you can alter it to suit your needs.

Input Fields

 

Field Required Notes
Key Yes Get from the community’s admin section.
Secret Yes Get from the community’s admin section.
Email Yes User’s email address
Name Yes Whatever name want to show when the user posts
Unique Identifier Yes Unique ID from your system. Must remain unchanged for the lifetime
of the user’s account.
Is Secure No Almost always set to true
Private Fields No Key/value pairs to send along with the user to Get Satisfaction. Completely
optional way to enhance user data.

 

Libraries

RUBY

Method Signatures

Sample Call

Output:

Included files

fastpass.rb – The Ruby FastPass library.

Steps to implementing Fastpass

The following steps shows how to implement FastPass:

    1. Download the library: ruby.tar.gz or ruby.zip

 

    • Unpack the code archive into your application’s lib/ folder.

 

    • Add require 'fastpass' to environment.rb or some other initializer file.

 

    • Restart your server to load the FastPass code.

 

 

PHP

 

Method Signatures

Sample Call

Output:

Included files

  • FastPass.php – The PHP FastPass library.
  • OAuth.php – Pre-requisite library for OAuth helper functions.

Steps to implementing Fastpass

The following steps shows how to implement FastPass:

  1. Download the library: php.tar.gz or
    php.zip
  2. Unpack the code archive, e.g. into your PHP include path.
  3. Add require_once('FastPass.php'); where necessary. (Remember
    to set the correct path.)

JAVA

Method Signatures

Sample Call

Output:

Included files

Download the library: java.tar.gz or java.zip

    • fastpass.jar – Compiled Java FastPass Library

 

    • FastPass.java – The Java FastPass Library

 

    • oauth-core.jar – Pre-requisite library for OAuth helper functions

 

    • commons-codec-1.3.jar – Pre-requisite library for hashing algorithms

 

    • commons-lang-2.4.jar – Pre-requisite library for HTML entity encoding helpers

 

 

PYTHON

 

Method Signatures

(see file)

Sample Call

(see file)

Output:

Included Files

  • fastpass.py – The Python FastPass Library
  • oauth.py – pre-requisite library for OAuth helper functions

Steps to implement Fastpass

The following steps shows how to implement FastPass:

  • Unpack the code archive, e.g. into your PHP include path.
  • Add require_once('FastPass.php'); where necessary. (Remember to set the correct path.)
  1. Download the library: python.tar.gz or python.zip
  • Unpack the code archive, e.g. into a folder on your Python search path.
  • Add import fastpass where necessary.

.NET

Method Signatures

Sample Call

Output:

Included Files

 

    • FastPass.dll

 

    • FastPass.cs – The .Net FastPass Library

 

    • FastPassCLI.cs – A sample Console Application illustrating use of the FastPass dll

 

    • OAuthBase.cs – Pre-requisite library for FastPass

 

Note: you may need to regenerate a dll on your own system, being sure to sign it locally. This is often true for use with .ASP Download the .Net library.

 

SALESFORCE

See this community topic for a discussion of how to Single Sign On your customers that use Salesforce to log in to your application.

 

Notes

When a Fastpass call is made for a first-time user (an email address not yet in our database), the user is not logged in until they take their first action (a new topic, a reply, a me-too, a star…). At that point, the user is prompted to confirm the account creation on Get Satisfaction, and eventually they’re logged in. Subsequent Fastpass calls will log the user in immediately.

Advanced Options

 

Additional Fields (“Customer Record Linking”)

You can pass additional fields with a Fastpass call for a given user. These fields are available to Admins and Official Reps (only) in certain areas of the community. Sample call with additional fields: { "city" => current_user.address.city, "country" => current_user.address.country } ).html_safe %>

Have Questions?

Our team is here to help! Have questions about FastPass, or even Single Sign On in general? Let us know by submitting a question in our customer community.

System Status

Company Updates