Introduction

This API authorizes users for your application. This is needed so that your application can interact with LiveEngage on behalf of your users in a secure and authorized way. The application should be installed in the context of your account.

This API provides standard oauth 2.0 endpoints to receive and refresh access tokens. Please see the oauth 2.0 rfc reference for more information.

Getting Started

  1. Install a LiveEngage application. Here is a guide to installing LiveEngage applications. The following two fields are mandatory for this flow, grant_types and redirect_uris. In addition, all normally mandatory fields, as detailed in the guide above, should be populated as well. Here is an example showing how to configure them:
{"client_name": "<YOURAPPNAME>",
"grant_types": [
   "authorization_code",
   "refresh_token"
 ],
 "redirect_uris": [
   "http://{YOURAPPLICATIONDOMAIN}/{CALLBACK_PATH}"
 ]
}

After finishing the installation, please retrieve the AppInstall ID and secret that you will need to use when calling this API's endpoints.

  1. Retrieve your domain. Use the LivePerson Domain API to retrieve this information by providing the following service name:

    • sentinel

The flow goes like this:

  1. User launches your application. We expect this flow to be the first thing the application does.
  2. User is redirected to the LivePerson Identity Service. If they have an existing LiveEngage session (they have logged in previously in the same browser from which they're accessing the application), a code will be provided immediately. If they don't have an existing LiveEngage session, they will be redirected to a login page. Once they login, they'll receive the code from the Identity Service. This is achieved by using the authorize method.
  3. Users are redirected back to the application site with the code provided in Step 1.
  4. Your application accesses the LE Applications Authorization API to request a token with the user's code provided in Step 1. This is achieved by using the token request.
  5. Your application receives an access token with which it can access LiveEngage services.