Authentication REST Service

Overview

In order to provide a more seamless and secure experience for agents, we rely on the booking platform to inform Uplift whether or not an agent is currently logged in to the booking platform.

For an easier understanding of the authentication flow, please refer to the diagram below.

To achieve this, we need a simple REST service that will accept an agentID and a sessionToken.

1. The agentID is given to us when the Uplift Agent Library is initialized (in the agent object).
2. We retrieve the sessionToken by invoking the sessionTokenCallback function, which is also provided upon initializing the Uplift Agent Library.
   

function initAgentPayMonthly() {
  window.Uplift.Agent.init({
    agent: {
      id: "identifier",
      agencyId: "agency-identifier",
      email: "arthur@uplift.com",
      firstName: "Arthur",
      familyName: "Davis",
      phoneNumber: "0000000000"
    },
    locale: "en-US", // "en-CA", "fr-CA"
    currency: "USD", // "CAD"
    onChange: myOnChangeCallback,
    sessionTokenCallback: mySessionTokenCallback, // Your sessionTokenCallBack goes here
    payMonthlyContainer: "#up-agent-pay-monthly-container",
    checkout: true
  });
}

Given these two values, the service will send a response with a status code of either 204 for a valid session or 403 for an invalid session. If the agent’s session is not valid, your callback handler will receive a response with the status SERVICE_UNAVAILABLE, and Uplift Pay Monthly should not be displayed as a payment method.

Note you are able to start developing the integration to Uplift Pay Monthly before completing the build of the Authentication REST API; however, having this API is required for testing and deployment in production.

Example Implementation

An example request from the Uplift server will look as shown below.

The response from the REST service should be as shown below. Note we will be focusing on the status code to determine the validity of an agent’s session.