General

Webhooks

Webhooks are used to keep track of the state of user data within Registration. Webhooks may be created to send notifications whenever an attribute or plural is created, changed, or deleted. Once configured, Janrain delivers changes in state to a pre-determined URL as a JSON object. If an error occurs, Janrain will try to send the message three times to avoid temporary networking glitches.

Required Configuration Information

The following information is needed to configure a webhook:

  • Capture Application ID
  • Entity Type – What capture entity type should each webhook respond to (typically user)
  • Callback URL (or URLs) – What URL to POST to for each webhook
    • Supported protocols:
      • HTTP
      • HTTPS (TLS 1.0 and above)
  • Event Types – What sort of events should each webhook respond to:
    • ADD – When a user record is created
    • UPDATE – When profile information from a user record is updated
      • If UPDATE, provide a list of user record profile attribute changes each webhook should respond to. Note: A list of attributes to choose from can be found on your Capture application Dashboard under the Schema section.
    • DELETE – When a user record is deleted
  • Callback Hash (optional) – A unique identifier for each webhook. If a callback hash is not provided, Janrain will generate one for you.

Implementation Steps

  1. Request a webhook through the Janrain Support Portal.
  2. Provide required configuration information (listed above).
  3. Janrain will contact you when the webhook is deployed and ready to use.

Retry System

The retry system handles network problems and other transient issues. In the event that a webhook call fails, the system will retry the call up to three times. Each retry is delayed by a few seconds.

When a failure happens, the event is logged with Janrain.

Response

Responses are returned in the body of POST requests as JSON objects inside an array. Each response consists of:

  • Key-value pairs for uuid from the user record
  • What entity_type was used
  • A datetime stamp recording when the event took place
  • The callback hash
  • The client_id from where the webhook was triggered

To verify that a webhook response originated with Janrain, compare the callback hash value in the response with the callback hash established when the webhook was configured.

When an action triggers the webhook, Janrain sends a list of JSON objects to the callback URL defined in the configuration. You will need to implement code to process the information delivered to this location.

The following is an example POST response from a webhook:

[
  {
    "uuid":"12345678-4321-1234-4321-123456789123",
    "entity_type":"user",
    "datetime":"2012-04-07T22:26:10.947Z",
    "hash": "1234567891234567891234567891234567891234",
    "client_id":"98765432198765432198765432198765"
  }
]

Email Service Providers / Marketing Automation

Salesforce Marketing Cloud

Overview

Salesforce Marketing Cloud (AKA Marketing Cloud) is a leading global provider of email marketing and cross-channel interactive marketing software-as-a-service solutions. These solutions empower organizations of all sizes to communicate with their customers through email, mobile, social media, and websites.

Major features of Janrain’s Marketing Cloud integration include:

  • Consumer Profile Data Transfer — User data is passed one way (from Janrain to Marketing Cloud) based on configurable field mappings.
  • Email Subscription List Transfer — Subscription list information is passed both ways (between Janrain and Marketing Cloud) to keep user preferences synchronized between systems.
  • Transactional Email Sending — Forgot Password and Welcome email messages may be sent through Marketing Cloud instead of Janrain. This supports entity, static, and mail event variables.
  • Business Unit Support — Profile data can be transferred into business units. This supports using the same business unit for multiple instances of registration.
  • Marketing Cloud Enterprise 2.0 Support

Prerequisites

  • A Janrain Registration (Capture) solution
  • A deployed Marketing Cloud solution

Installation

The bulk of integrating Marketing Cloud with Janrain solutions is performed behind the scenes by Janrain. Complete the following steps to finish the installation:

  1. Create a test account in Marketing Cloud (for Janrain testing purposes).
  2. Create a production account in Marketing Cloud (for the final integration to use once testing is complete).
  3. Complete the questionnaire (included in the deliverables provided by Janrain). These answers inform the back-end configuration.

Information Required by Janrain

Information required by Janrain differs depending on what features of Janrain’s Marketing Cloud integration are being implemented. The following is a general list of the information that Janrain will request for implementation.

General Details
  • A list of desired features and the use cases for these features:
    • Consumer Profile Data Transfer
    • Email Subscription List Transfer
    • Transactional Email Sending
  • The details of your Janrain integration and how your Marketing Cloud configurations will relate to:
    • Number of Registration applications
    • Number of API clients
    • Number of properties the integration will service
    • Number of Registration entity types
    • A description of how the Marketing Cloud connector will relate to these existing applications and properties
  • Requirements around bulk transfer of existing user records from Janrain into Marketing Cloud
Salesforce Marketing Cloud Details
  • Contact info for your Marketing Cloud technical contact
  • Marketing Cloud version
  • The Marketing Cloud test instance URL, Business Unit ID, and Janrain account login credentials
  • The Marketing Cloud production instance URL, Business Unit ID, and Janrain account login credentials
  • Whether or not your Marketing Cloud subscriber key is enabled
  • Any information on Business Units to be used (if any)
Data Mapping
  • A list of Janrain schema fields that will be mapped to Marketing Cloud, including:
    • Whether the data will be mapped to the subscriber record or into data extensions
    • The target Marketing Cloud attribute names and locations
    • The structure of any data extensions that will be used
  • Requirements around profile deletion (determine if profiles should be deleted in Janrain if they are deleted in Marketing Cloud)
Transaction Email Details
  • A list of the transactional emails that will be sent from Marketing Cloud
  • For each transactional email, provide the following:
    • The Registration event that should trigger the email (password reset, email verification, and so on)
    • The External Key of the Marketing Cloud template that should be used
    • Whether there will be shared templates for all properties or different templates for each property
Email Lists
  • A list of email subscription lists that will be synchronized, including:
    • The subscription list ID
    • How the subscription maps to Janrain lists
  • Requirements around email verification (determine if lists will be synchronized only if the user’s email address is verified)

DMPs

Adobe Audience Manager

Overview

The Janrain integration for Adobe Audience Manager (AAM) enables marketers to collect and store first-party demographic, psychographic, and behavioral customer profile data collected via social login and registration, and synchronize it with the audience data collected by AAM for richer audience segmentation and targeting. Features of the integration include:

  • User ID Sync — The Janrain Integration for AAM synchronizes user IDs between Janrain and Adobe to ensure that customer profile data is linked between the two systems and available in a single view.
  • Profile Data Transfer — Customer profile data is transferred from Janrain to AAM on a scheduled basis.

Configuration

Janrain will configure and deploy the Janrain AAM integration along with your Adobe technical contact.

Prerequisites

  • A Janrain Registration account.
  • An Adobe Audience Manager account.
  • A method to retrieve the site visitor’s Janrain ID from the Janrain on-page component and associate it with the matching Adobe ID in AAM. Note: Any site already using AAM can be modified to perform this matching operation. Adobe and/or Janrain technical resources can assist with this step.

Required Information

  • The frequency of customer profile transfers.
  • A taxonomy file that describes the audience segments as key-value pairs as provided by Janrain.
  • Configuration parameters:
    • Janrain Registration application ID
    • Janrain Registration application client ID
    • Janrain Registration application client secret
    • Janrain Registration application domain
    • Adobe SFTP server username
    • Adobe SFTP server password
    • Adobe SFTP server hostname
    • Adobe Data Provider ID

Customer Responsibilities

When a new user registers on your site, his or her Janrain UUID must be sent to AAM for synchronization with his or her Adobe ID. If you have existing Janrain users when implementing this integration, you will also need to perform this step each time a user logs in so that IDs will be matched up over time.

The Janrain UUID is available in the result of the onCaptureRegistration and onCaptureLoginSuccess events. Once you have retrieved the Janrain UUID, you need to implement a call passing that value to AAM. Your call will look something like this:

http://dpm.demdex.net/ibs:dpid=<AdobeAccountID>&dpuuid=<CaptureUUID>

CRM

Salesforce

Overview

The Janrain Salesforce Connector allows data to be synchronized between Salesforce and Janrain.

Major features of Janrain’s Salesforce integration include:

  • Consumer Profile Data Transfer — User data is passed between Janrain and Salesforce. New records created in Janrain are transferred to Salesforce.
  • Flexible Field Mapping — A mapping language allows any field within the Janrain database to be mapped to any field within an accessible Salesforce object. Plural and object mapping are supported.
  • Profile Deletion — Deletion behavior is configurable (deletion events from each system can be either ignored or acted upon).
  • Configurable Salesforce Polling Interval and Base URL — The connector supports the maximum Salesforce five-minute polling interval and a configurable Salesforce URL for API calls from Janrain.
  • Apigee Compatibility — The connector is compatible with Apigee.

Limitations:

  • Updates in Janrain are pushed to Salesforce instantly, whereas updates in Salesforce are retrieved by Janrain on a timed basis.
  • New records created in Salesforce will not be transferred to Janrain.

Note: There may be an additional licensing charge from Salesforce to deploy the connector. This fee will be passed from Janrain to the customer.

Prerequisites

  • A Janrain Registration (Capture) solution
  • A deployed Salesforce solution

Required Information

Deploying and configuring the Salesforce integration is performed by a Janrain technical representative. Before we get started, Janrain will need the following information about your Salesforce org:

  • Your organization’s Salesforce Org number (for billing purposes). The Salesforce integration license is for a single Salesforce Org.
  • What type of Salesforce license (edition) your organization has.
  • Any API usage limits in place for your Salesforce implementation.
  • Whether you are deploying the Salesforce integration in a staging (sandbox) or production instance of your site.

Installation

The bulk of integrating Salesforce with Janrain solutions is performed behind the scenes by Janrain. Complete the following steps to finish the installation:

  • Create a Salesforce user account (solely for use by the Janrain connector) with read/write privileges.
  • Create a connected app within Salesforce (for use by the Janrain connector) that has OAuth settings enabled.
  • All objects will need an external ID (to support mapping).
  • Provide a spreadsheet with field mappings.
  • Provide the configuration settings outlined below.
  • Ensure that your Salesforce license supports the volume of data transfer (API calls) required by the Janrain connector.
  • Create or identify a field in Salesforce to which to map the Janrain UUID.

Information required by Janrain differs depending on what features of the Janrain Salesforce integration are being implemented. This is a general list of the information that Janrain will request for implementation:

  • Salesforce login URL
  • Salesforce login credentials
  • Salesforce security token
  • Salesforce consumer key
  • Salesforce consumer secret
  • Salesforce polling interval
  • Salesforce object(s)
  • Janrain entity type(s)
  • Janrain client ID(s) to whitelist for inclusion in the integration
  • Record deletion behavior in Salesforce (respond to or ignore deletions from Janrain)
  • Record deletion behavior in Janrain (respond to or ignore deletions from Salesforce)

Data Append

Appreciation Engine–Registration

Overview

The Appreciation Engine allows site owners to follow their users’ activity across a variety of social networking platforms.

Integrating with Janrain

Note: This integration requires the assistance of Janrain engineers.

Janrain’s Registration solution integrates with The Appreciation Engine by passing user registration information to The Appreciation Engine, where it can be tracked accordingly.

The Appreciation Engine tracks brands and activities with which users interact. This data, along with weighted scoring, recommendations, and demographic information, are added to Registration’s database schema. New users are added to The Appreciation Engine using Janrain’s webhooks API. Updated users are synchronized with The Appreciation Engine at regular intervals.

Requirements

  • A deployed instance of Janrain’s Registration solution.
  • A deployed instance of The Appreciation Engine.

Implementation

  1. Meet with your representative from The Appreciation Engine to gather configuration information for Janrain. This information includes:

    1. Which brands and activities to track. These will need to be added to the Janrain Registration (Capture) schema so they can be recorded.
    2. Weights given to individual brands and activities.
    3. Which Social Login permissions (AKA scopes) are needed.
    4. A definitive path for transmitting information. You may choose the Janrain RESTful API, the Appreciation Engine API, or another.
    5. A schedule for Janrain to grant admin access to the customer’s Appreciation Engine (if applicable), and when schema changes will be made.
  2. Meet with Janrain to confirm the information in step 1.

  3. Developers from The Appreciation Engine will modify the Registration schema. If you do not want to give The Appreciation Engine admin rights to your schema, it can be modified using the Janrain RESTful API.

  4. Once the new schema is added, the implementation is complete. Data will flow to The Appreciation Engine and to the customer.

To add additional brands after the initial configuration, contact The Appreciation Engine and repeat step 1, substeps 1-3.

Enterprise Service Bus (ESB)

Mulesoft (Integration Platform)

Overview

The MuleSoft Anypoint™ Platform is a complete platform for SOA, SaaS integration, and APIs which enables enterprises to integrate on-premise and cloud applications. Using MuleSoft’s Anypoint™ Platform, you can quickly create connectivity between Janrain and third party SaaS applications and services such as Salesforce, LinkedIn, and Jive for simplified and streamlined web visitor experiences.

MuleSoft’s Janrain connector makes it easy to connect to Janrain APIs and perform standard tasks without having to interface with the Janrain platform directly. The MuleSoft Janrain connector provides access to the following Janrain API groups as a cloud connector:

  • User Data
  • Partner
  • Social Login
  • Authentication
  • API Client Configuration

Prerequisites

  • MuleSoft Anypoint Studio
  • A Janrain Social Login or Registration account

Cloud Connector Installation

  1. Within MuleSoft Anypoint Studio, select Help > Install New Software.
  2. Click the drop-down menu and select MuleStudio Cloud Connectors Update Site.
  3. Search for Janrain, select the connector, and click Next.
  4. Click Next to install the connector.
  5. Accept the Terms of Service and click Finish.
  6. After the system restarts, the Janrain connector appears in the Cloud Connectors list.

Using the Cloud Connector

Add the connector to an Anypoint Studio project by dragging and dropping the Janrain Cloud Connector from the Connectors list to the canvas.

Janrain Cloud Connector

You can now use the Janrain Cloud Connector in your integration. Click the Operation list to see the available API methods.

Operation List
Operation Entity Find