Third party API
Our virtual assistant Helper provides an area to integrate external API with the chatbot. With this, you can use third-party API with all Helper resources. This integration is performed through a REST request and requires some steps to be configured.
Procedure
- After accessing the platform, go to the menu "third party API";
- The screen will present the API previously registered, if any, with the Edit and Delete options;
- If you want to search for a specific API, use the search field and click on "Search";
- To register a new API, click on "New". The following fields will appear to be completed:
Field | Definition |
|---|---|
Name | Define the characteristic name of the API being registered. |
Dependency | If necessary, identify whether that API being created previously requires the execution of another API. |
Methode | Select which HTTP method will be used by the API: POST, GET, PUT, DELETE, or PATCH. |
URL | Set the URL for the new API. If you want to include in the URL a context already registered in the virtual assistant: put the value between {}. |
Once the identification fields are completed, we will complete the necessary attributes to continue the REST requests: header, body, responses, and settings.
Headers
This function allows adding necessary values for the REST request header.
- Click on “+” to add the header with the information to:
- Key;
- Value;
- Click on "Save".
Body
In the body, it is possible to assemble the content that will be sent in the body of the request.
- Click on “+” to add the body with the information to:
2. Click on "Save".
Responses
In responses, we will configure what we expect from this API.
- Click on “+” to add the information to::
- Format of response: it can be in JSON or Text;
- Name;
- Type: text, number, boolean, list, object or context;
- Identification.
- Click on "Save".
Settings
Here we will define the request settings that will influence the assistant's understanding.
- Select the desired code to define the fields:
- Successful htpp status;
- Htpp status of unauthorized;
- Htpp status of not found.
- *The options presented for these fields are pre-defined by the system.
- Then, define the messages that will appear on the chatbot screen for the following cases:
- Chatbot message for content not found;
- Chatbot message for request failure;
- Define whether the API being created is an authentication API.
- Click on "Save".