Embed Code

Our embed code is a single pure javascript call which can be used on every page in an almost identical fashion in order to load the Userplane suite of applications without any trouble. Using this universal loader you can load the Userplane platform used for tracking presence, launching conversations, and building rich experiences using our notification api.

Simply fill your siteId and provide the Simple-SSO token for your user to embed Userplane on your site.

Example

<script type="text/javascript" src="http://cdn.userplane.com/release/sdk/userplane.js"></script>
<script>
       up.init({
      siteId:"YOUR_SITE_ID",
      key: "",
      token: "YOUR_TOKEN_IDENTIFIER",
      // Docs: Simple-SSO · Token Examples
      settings: {},
      lang: "en-us"
   });

</script>

Parameters

Property Description Required
siteId The identifier for your particular site. This is the public key which we use to identify what site your users are a part of as well as track all statistics and analytics data against. Yes
key Key is a pass through value for Integrated SSO calls. When using Simple SSO the key parameter is used as a part of our caching strategy. Providing a value specific the user who is logged in is recommended if you want to ensure that a user on the same browser’s identity within Userplane is cleared out if the log out and back in with another account. No
token The token parameter is required when you are using Simple SSO to authenticate you users with Userplane. Yes, when using Simple SSO
lang The language you wish to use for your integration. See Supported Locales Yes
settings An object used to configure your integration beyond the simple identification elements provided in the rest of the embed code. Yes, even if your not changing anything you must provide it.

Settings

Setting Description Possible Values
tokenType Providing a tokenType with “Base64″ will cause us to decode all your parameters from Base64 ensuring that all special characters are handled safely and adding an extra layer of security onto the token process. Base64