AI Bot Entitlement Integration Guide

Owned by Hemapriya (Unlicensed)
Last updated: Jun 01, 2023
2 min read

Entitlement Integration

Customers can provide the entitlement details for a given user. This section provides the details of the API.

API overview

Go to https://asc.apis.ascendo.ai/docs and under the “User” label you will find a POST API . This API provides the information on the user information for the current chat session. Prior to that, we are required to provide the specific Ascendo customer info and the corresponding API key. For example, Ascendo customer “Acme” will have its own unique uuid and API key. These will be available under the Admin Portal. The API then will provide the information on the customer email and the name.

Getting the UUID and API Key

Log into Ascendo and go to the Admin settings. Within the settings, click on the API key info.

Step 1: Click on the settings - this is available for the Admin users on the top right corner of the page.

 

Step 2: Under Integration Settings, on the menu on the left, click on API keys. Get the customer uuid(organization identifier).For getting the api keyType ‘ai_bot’ in API KeyLabel fields to generate API Key and click on Generate.

This customer uuid and API key will be required in the POST API.

 

Post API

Use the POST method to update the user details. API Link:

 

https://asc.apis.ascendo.ai/api/v1/user/{customer_uuid}/update_subscription?api_key={ai_bot_api_key}

Parameters:

  • customer_uuid - from the admin portal

  • api_key - from the admin portal

  • Request body(Contains the information about the end customer)

  • email - the email of your end customer

  • is_subscribed:

  • true

if the end customer has subscribed to your enterprise services to give them priority while handling their issues.

  • false

otherwise.

  • username-represents the end customer that is initiating the chat(eg-John Doe)

Response:

  • status : successful

 

Ascendo.ai