Generate LivePro API Key

To connect LivePro to a Knowledge Hub knowledge base, you must either provide your LivePro credentials to NiCE Professional Services or enter them in Knowledge Hub yourself. This page describes how to generate your LivePro API key and set up the integration between LivePro and AWS AppFlow. After you complete the setup, AppFlow connects to Knowledge Hub to make your LivePro content available for use.

Prerequisites

  • You must have an active LivePro instance before you can generate API keys or set up the integration. If you are not a LivePro customer, go to https://livepro.com to set up your instance.

  • You must have LivePro administrator privileges to generate an API key.

  • You must have full application access to create API key. You can create API keys only for your account.

Create a LivePro API Key

  1. Sign in toLivePro with your administrator credentials.

  2. Click your profile icon in the top right corner of LivePro.

  3. Select Admin from the menu.

  4. In the Admin Dashboard, under Security & Permissions click API Keys.

  5. Click Add New Key + .

  6. In the Add API Key pop-up, enter the username for the account you want to link to this API key.

    The API key will only access content that your user role can see.

  7. Click Save.Your API key will be generated.

  8. Click Copy Key to copy it to your clipboard.

    Store the key securely and do not share it.

API Key Expiration

LivePro API keys do not have a built-in expiration. Your API key remains valid as long as:

  • Your user account is active.

  • The API key is not manually reset or deleted.

  • You retain administrator privileges.

The API key stays valid until you reset or delete it. When you reset or create a new API key, the previous key becomes invalid.

AppFlow Configuration

This JSON file provides the configuration input for creating an AWS AppFlow connector profile that integrates LivePro as a source system. It includes the credentials and parameters AppFlow needs to authenticate and fetch data. Enter your LivePro details in JSON format when you set up AppFlow. For example,

Example: Success Response

{

"LIVEPRO_BASE_URL": "",

"LIVEPRO_OBJECT_NAME": "",

"LIVEPRO_API_KEY": ""

}

Parameter Details

Parameter

Description

Example

LIVEPRO_INSTANCE_URL Specifies the base URL of the LivePro instance that AppFlow connects to. https://acme.livepro.com.au
LIVEPRO_OBJECT_NAME

Identifies the LivePro object that AppFlow retrieves data from.

An object already exists in LivePro that includes all supported knowledge types. The name of this object is either articles or Articles. You can use this object name as the value for the LIVEPRO_OBJECT_NAME parameter.

 Articles (default)
LIVEPRO_API_KEY Provides the API key for authenticating requests to LivePro. lpk_abc123...