Introduction

The purpose of the Chat Editor API is to give users access to create, edit and retrieve contents from the Intent Base of the Inbenta Chat application.

This page describes how to set up the Chat Editor API.

Obtain API credentials

All requests to Chat Editor API endpoints will be authenticated and authorized. In order to access it you need several keys.

API key and secret

To obtain your Editor API key and secret, open your Inbenta App and go to the Administration tab. Look for the "Chat Editor API" section:

The Chat Editor API section contains two subsections: Production and Development. Each section provides the keys and instructions to implement the API in the corresponding environment.

There you can get the API key and secret.

• The API Key will grant you access to the APIs.
• The Secret allows the request to access your instance's data.

User personal secret token

In addition to the API key and secret, you need to identify yourself in the API. To do so, you need a user personal secret token.

• The Personal Secret identifies the user doing the action.

To obtain your User Personal Secret token, see Generating and managing personal API secrets (This links redirects you to the Help Center).

API setup

Obtain and use the access token

You need a valid access token to use the Chat Editor API. Follow the steps listed in the Authorization section to set up your page with your token. Once you obtain the access token, you must append it to every request inside the Authorization header, with the format Bearer <your_access_token>.

Get the API URL

The base URLs of the Chat Editor API are dependent on the instance, so that Inbenta can offer worldwide service and allow service auto-escalation. This base URL may change over time. Do not store or cache it persistently. Instead, get it every time you obtain a new valid access token.

To get the current API URL for your instance, get the apis parameter from the same response that gave you the access token. Extract the URL corresponding to the instance product, for example:

{
    "accessToken": "******************",
    "expiration": 1573563837,
    "expires_in": 1200,
    "apis": {
        ...
        "chat-editor": "https://endpoint.inbenta.example/chat",
        ...
    }
}

Specify the version

Once you have the appropriate API URL for your implementation, you must specify the version of the API.

You specify the version at the end of the URL with v + {version}.

Example:

The URLs for the current latest version of each Chat Editor API look like this:

• Chat Editor: "https://endpoint.inbenta.example/chat-editor/v1"

Use the API

Authorization

You need a valid access token to use the Chat Editor API. Follow the steps listed in the Authorization section to set up your page with your token and refresh it.

Retrieve information

Now you can create or retrieve information from the Intent Base.

Example: How to create a content

To create a content use the POST /contents endpoint. This endpoint requires:

1. the API Key,
2. an access token, and
3. the data for the content that you want to create.

For more information about POST /contents and other endpoints, see the API routes section.