The Login Service API provides endpoints to manage the User Session in LiveEngage, such as User Login, Application Login, Logout and Refresh. Use this API to log into LiveEngage as a user with credentials or an application with an API key. After logging in, you receive a session token (Bearer) to use for other related API calls.
We recommend that you implement our Retry Policy and KeepAlive Best Practices.
Step 1. Retrieve your domain
Before you can choose your login method, you must retrieve your domain using the Domain API.
TIP: Use the
agentVep service name to retrieve your domain.
Step 2. Choose your method of login
User Login - Provides a way for users to access and manage a LiveEngage session. A session could be a customized workspace or hosting a LiveEngage user in an external app. Use the LiveEngage username and password, and refer to User Login for more details.Logged in users are managed under the same restrictions as regular users in LiveEngage, including password expiration, concurrent conversation limits, skill groups and so on. If your account has SSO enabled, this method is not standalone, and you must register the relevant user through your hub to provide LiveEngage with an SSO SAML assertion.
Application - Provides a way for applications to access and manage LiveEngage sessions, such as bots, virtual agents, or other apps that need to act as an agent. The Application Login method overcomes both issues detailed in the User Login method (above), such as password expiration or SSO integration. For more details, refer to Application Login.To login as an application, you must have the User Type - Bot feature activated. If you do not, contact your account team before proceeding.
Step 3. Create an API key and new Bot
Refer to our Getting Started guide for more information on creating API keys. You'll need the details (like username or app secert) to use the methods of this API mentioned above so make sure to note them.