Configurar API de integração
 |
 |
Pré-requisitos
- SoftExpert Copilot como parte das soluções adquiridas pela organização.
- Ambiente SoftExpert Suite hospedado em nuvem.
- Credencial previamente gerada para utilizar a API Google v2 ou v3.
- Acesso ao menu Configuração > Central de integrações (COP010).
Apresentação
A Central de integrações do Copilot conta com a aba API de integração, que disponibiliza as opções com as quais o SoftExpert Suite pode ser integrado, como Google, Amazon, Zenvia, Twilio e Azure AI Document Intelligence.
Além dessas APIs, o SoftExpert Suite oferece uma API própria, denominada SoftExpert Suite, que fornece serviços equivalentes aos das APIs externas, com a vantagem de não exigir a contratação de fornecedores terceiros.
Por meio da aba API de integração, também é possível validar a conexão com as APIs disponíveis no SoftExpert Copilot.
Neste artigo, será apresentado o procedimento para configurar e validar as APIs de integração.
Configurar API de integração
1. Para configurar uma API de integração, acesse o menu Configuração > Central de integrações (COP010).
2. Na aba API de integração, são exibidas as APIs já configuradas no sistema, sendo que API SoftExpert Suite vem cadastrada por padrão.
3. Clique no botão
da barra de ferramentas lateral para adicionar uma nova API de integração.
4. Na tela que será aberta, preencha os seguintes campos:
Para utilizar a API Google v2 ou v3, é necessário gerar previamente a credencial.
-
API: selecione a API desejada entre as opções disponíveis:
- Google v2: utilizada para tradução automática de texto.
- Google v3: utilizada para tradução automática de texto e arquivos.
- Amazon AWS v3: utilizada para tradução automática de texto.
- Zenvia: utilizada para o envio de mensagens automáticas via SMS e WhatsApp.
- Twilio: utilizada para o envio de mensagens automáticas via SMS e WhatsApp.
- Azure AI Document Intelligence: utilizada para a extração de dados de documentos.
- Título: insira um identificador para a API.
- Campos específicos: dependendo da API selecionada, o sistema solicitará informações adicionais. Preencha os campos conforme os dados fornecidos pela respectiva plataforma de integração.
- Título: informe um título.
- Campos específicos: cada opção de API solicita determinados campos. Informe-os conforme os dados fornecidos pelas plataformas de integração.
5. Após o preenchimento, clique no botão 
para concluir o cadastro da API.
6. A API será exibida na listagem.
Ao ser utilizada, a API exibirá um ícone de verificação
sinalizando que está em uso.
Caso seja necessário editar algum dado da API, como as credenciais, selecione a API desejada e clique em Alterar.
Para remover uma API, selecione a opção correspondente e clique em Excluir. No entanto, a exclusão só será permitida se a API não estiver em uso.
Validar API de integração
1. Para validar uma API, selecione a API desejada e clique no botão 
.
2. Na tela que será aberta, clique no botão Validar API.
3. Ao clicar neste botão, o sistema verificará se a API está acessível e pronta para ser utilizada pelo SoftExpert Copilot, garantindo uma integração bem-sucedida.
Conclusão
Com as APIs de integração devidamente configuradas e validadas, torna-se possível configurar as APIs específicas de tradução, notificação e IDP.