Configure API integration
|
|
This content was generated by artificial intelligence. To request a review, send an e-mail to documentacao_se@softexpert.com.
Prerequisites
- SoftExpert Copilot as part of the solutions acquired by the organization.
- Cloud-hosted SoftExpert Suite environment.
- Pre-generated credentials for using the Google API v2 or v3.
- Access the Settings menu > Integration Center (COP010) .
Presentation
The Copilot Integration Center features an API Integration tab , which provides options for integrating with SoftExpert Suite, such as Google, Amazon, Zenvia, Twilio, and Azure AI Document Intelligence.
In addition to these APIs, SoftExpert Suite offers its own API, called SoftExpert Suite , which provides services equivalent to those of the external APIs, with the advantage of not requiring the hiring of third-party providers.
Through the Integration API tab , it is also possible to validate the connection with the APIs available in SoftExpert Copilot.
This article will present the procedure for configuring and validating integration APIs.
Configure API integration
1. To configure an integration API, go to the Settings > Integration Center (COP010) menu .
2. In the Integration API tab , the APIs already configured in the system are displayed, with the SoftExpert Suite API being registered by default.
3. Click the button in 
the sidebar toolbar to add a new integration API.
4. On the screen that will open, fill in the following fields:
To use the Google API v2 or v3, you must generate credentials beforehand .
-
API: Select the desired API from the available options:
- Google v2 : Used for automatic text translation .
- Google v3 : Used for automatic translation of text and files .
- Amazon AWS v3 : Used for automatic text translation .
- Zenvia : used for sending automated messages via SMS and WhatsApp .
- Twilio : used for sending automated messages via SMS and WhatsApp .
- Azure AI Document Intelligence : used for extracting data from documents .
- Title: Enter an identifier for the API.
- Specific fields: Depending on the selected API, the system will request additional information. Fill in the fields according to the data provided by the respective integration platform.
- Title : Please provide a title.
- Specific fields: each API option requires specific fields. Fill them in according to the data provided by the integration platforms.
5. After filling out the form, click the button 
to complete the API registration.
6. The API will be displayed in the listing.
When used, the API will display a verification icon 
indicating that it is in use.
If you need to edit any API data, such as credentials, select the desired API and click Edit .
To remove an API, select the corresponding option and click Delete . However, deletion will only be allowed if the API is not in use.
Validate integration API
1. To validate an API, select the desired API and click the button 
.
2. On the screen that opens, click the Validate API button .
3. By clicking this button, the system will verify if the API is accessible and ready to be used by SoftExpert Copilot, ensuring a successful integration.
Conclusion
With the integration APIs properly configured and validated, it becomes possible to configure the specific APIs for translation, notification, and IDP.