Integration Hub

Integration Hub fornece um local central para lidar com integrações com sistemas e serviços externos. Ele permite que você crie conexões padronizadas RESTAPIFechado Interface de programação de aplicativo. Permite automatizar certas funcionalidades conectando seu sistema CXone Mpower a outro software., que podem ser usadas em vários scripts Studio. Isso evita a necessidade de criar repetidamente as mesmas solicitações sempre que quiser se comunicar externamente via API. Em vez disso, você pode criar a solicitação uma vez em Integration Hube reutilizá-la onde precisar. Isso simplifica e acelera o processo de script.

Integration Hub também torna suas integrações mais seguras. Ele criptografa as credenciais da API, portanto, cada vez que você as usa, elas não são expostas no script. Studio scripts são armazenados como texto simples, portanto, você não pode armazenar com segurança credenciais importantes como variáveis diretamente no script, como tokens usados para solicitações API. Integration Hub permite adicionar rapidamente uma solicitação de autenticação a um script e, em seguida, usar com segurança as credenciais recuperadas em chamadas de API subsequentes. Você também pode adicionar certificados mTLS a uma solicitação de API.

Integration Hub faz parte do aplicativo de Automação e IA em CXone Mpower. Se você tiver a permissão Iniciar automação e IA, poderá abrir o aplicativo CXone Mpower em uma nova janela e clicar em Integration Hub.

Integration Hub, mostrando a lista Minhas conexões à esquerda e a biblioteca de conexões à direita.

Conexões

Conexões definem os detalhes para integração com um serviço externo, como solicitações de API, fluxos de autenticação e variáveis. Por exemplo, você pode criar um modelo de conexão para Salesforce. Isso definiria os detalhes básicos necessários para se conectar com Salesforce, como tipo de autenticação e métodos suportados. A partir desse modelo, você criaria uma conexão, que permite preencher detalhes específicos do modelo, juntamente com detalhes mais específicos, como as solicitações de API específicas que você deseja fazer ao Salesforce.

Modelos de conexão

Cada conexão que você adiciona ao Integration Hub é criada com base em um modelo de conexão. Modelos definem as informações básicas que se aplicam a todas as conexões que serão feitas com o modelo. Isso inclui:

  • O nome do serviço da Web ao qual você está se conectando.
  • O método de integração. Atualmente, a API REST é o único método compatível.
  • O tipo de autenticação, se houver. Atualmente, você pode escolher OAuth 2.0 ou nenhuma autenticação.
  • Os cabeçalhos personalizados para autenticação, caso sejam necessários.
  • Os verbos disponíveis para uso por solicitações feitas com base no modelo. Verbos são as ações que podem ser executadas com o serviço Web conectado, como recuperar dados (GET) ou criar registros (POST).

Uma conexão não precisa incluir todos os tipos de informações de conexão. Ela pode conter qualquer combinação dos tipos de informação compatíveis.

Todos os modelos de conexão estão disponíveis na biblioteca de conexões em Integration Hub. Modelos que você pode usar em um script Studio estão listados em Meu Conexões em Integration Hub. Você pode criar no máximo 50 conexões (na lista Minhas Conexões). Não há limite para o número de modelos na Biblioteca de conexões.

Todos os modelos não podem ser modificados. Porém, os modelos personalizados podem ser excluídos. Caso você precise alterar algo em um modelo personalizado posteriormente, exclua o modelo e crie um novo. As conexões podem ser modificadas. A exclusão de um modelo personalizado não afeta as conexões criadas com ele.

Modelos de sistema

O Integration Hub possui dois tipos de modelos: os modelos de sistema, de propriedade do NiCE, e os modelos criados por você próprio. Os modelos de sistema são enviados com o Integration Hub, não podendo ser excluídos. Atualmente, Integration Hub inclui um modelo de sistema:

  • CXone Mpower Dev Portal: integra-se a API endpoints documentados no CXone Mpower Developer Portal . Isso é para reduzir sua dependência de ações do Studio Framework. Ele utiliza a OAuth autenticação 2.0. Para determinar a autenticação, ele utiliza o URL de descoberta. Ele não é compatível com os certificados de clientes.

Solicitações

Solicitações são chamadas de API. Para cada conexão na lista Minhas Conexões, você pode adicionar solicitações que deseja usar com o serviço externo específico. Essas solicitações especificam as seguintes informações, que são usadas para se conectar a um serviço Web:

  • URL: o local do recurso ao qual você está se conectando.
  • Método (Verb): a ação que você deseja que a solicitação execute, como recuperação de dados ou criação de um novo registro. O Integration Hub oferece suporte a estes verbos: GET, PUT, POST, DELETE, TRACE, PATCH, HEAD, OPTIONS. Os verbos disponíveis para uso em uma conexão são definidos no modelo usado para criar essa conexão.
  • Cabeçalhos: uma parte da solicitação que contém informações adicionais sobre a solicitação. Pode incluir o idioma, as credenciais e assim por diante.
  • Consulta Parâmetros: Uma maneira de passar informações com uma solicitação de API no URL do terminal. Eles são configurados como pares de chaves-valores. Podem ser usados para filtrar, classificar, personalizar ou controlar os dados retornados na resposta.
  • Corpo: o conteúdo da solicitação. O formato depende dos requisitos da API à qual você está se conectando. O tipo de mídia do corpo deve corresponder ao que é esperado pelo recurso ao qual você está se conectando. Ele também é conhecido como tipo MIME ou tipo de conteúdo. Estas são as opções compatíveis e os cabeçalhos de conteúdo associados: 
    • ApplicationJson: application/json
    • ApplicationJsonPatch: application/json-patch+json
    • FormURLEncoded: application/x-www-form-urlencoded
    • TextHtml: text/html
    • TextPlain: text/plain
    • TextXml: text/xml
    • Sigv4: application/ x-amz-json-1.1

Cada conexão do Integration Hub pode ter até 50 solicitações. Não há restrição quanto ao número de solicitações que podem estar ativas simultaneamente.

O CXone Mpower tem um limite de 32 KB no tamanho das respostas. Use parâmetros de consulta para filtrar os dados retornados. Isso pode ajudar você a ficar abaixo desse limite.

Solicitações manuais e Studio

O Integration Hub oferece suporte a duas opções para solicitações em conexões:

  • Manual: uma solicitação manual é criada no Integration Hub usando as opções da página Adicionar solicitação. Você pode usar segredos neles. Solicitações manuais são comumente usadas para casos em que os dados não são alterados. Elas podem ser executadas diretamente do Integration Hub sem a necessidade de um script Studio. Também podem ser executadas em scripts Studio.

  • Studio: em alguns casos, solicitações de API não podem ser criadas como solicitações manuais no Integration Hub. Por exemplo, as solicitações que exigem parâmetros de caminho, substituição de variáveis ou que se conectam a serviços da Web SOAP devem ser criadas em um script Studio. No entanto, talvez você queira manter o controle dessas solicitações em suas conexões do Integration Hub. A opção de solicitação Studio permite que você faça isso. Uma solicitação Studio aparece na guia Solicitações de uma conexão junto com todas as solicitações manuais que a conexão possui.

Variáveis

O Integration Hub permite armazenar pares de valores como variáveis. Como padrão, as variáveis são descriptografadas. Contudo, é possível criptografar uma variável, tornando-a secreta. O ato de marcar uma variável como sendo secreta aumenta a segurança de informações confidenciais, como senhas ou chaves.

As variáveis podem ser usadas na conexão em que você as criou. Se você executar uma conexão ou solicitação de autenticação em um script Studio, poderá usar variáveis dessa conexão no script.

Os segredos são criptografados em repouso em um banco de dados criptografado. O Integration Hub usa o Advanced Encryption Standard (AES) para criptografar os dados. O único momento em que os dados são descriptografados é no momento da execução.

Ações do Integration Hub Studio

Quando quiser usar a autenticação ou fazer uma solicitação em um script Studio, use as seguintes ações Studio:

Fatos importantes sobre as Integration Hub Studio ações

  • Eles exigem o Integration Hub. Se o Integration Hub não estiver ativado em seu sistema CXone Mpower, as ações não funcionarão.
  • É possível incluir mais de uma instância de cada ação em um script.
  • Você pode usar a substituição de variáveis para executar solicitações diferentes ou usar a autenticação de mais de uma conexão em um único script.
  • Assim como em outros métodos de fazer chamadas de API no CXone Mpower, é necessário um script adicional para receber a resposta do serviço da Web conectado e tratá-la adequadamente.
  • O CONNECTAUTH não permite nenhuma personalização. Ele executa a solicitação de autenticação conforme definido na conexão no Integration Hub.

Disjuntor

Integration Hub tem um disjuntor embutido. É uma precaução à prova de falhas para chamadas de API com falha. Se o disjuntor detectar que uma chamada está falhando repetidamente, ele ativará e limitará a chamada de API. O motivo mais comum para chamadas sem sucesso é um erro temporário do servidor (erros 500). Limitar (ou pausar) a chamada dá ao servidor tempo para voltar e funcionar corretamente.

A seguir estão as principais características do disjuntor:

  • O disjuntor é ativado se mais de 50% das chamadas para uma API falharem em 30 segundos.

  • Para ativar o disjuntor, o Integration Hub deve ter tentado mais 100 chamadas para uma API em uma janela de 30 segundos.

  • O disjuntor é ativado por 30 segundos.

  • Os motivos de falha podem ser acessados nos logs Studio rastreamento capturados na variável _err.

Histórico de auditoria

Cada conexão em Integration Hub tem um log de alterações. Sempre que uma conexão é criada ou atualizada, os seguintes detalhes são registrados:

  • Data: A data em que a alteração foi feita.

  • Modificado por: Quem fez a alteração.

  • Nome do perfil: O nome da conexão.

  • Ação: O que aconteceu, como por exemplo, se uma conexão foi criada ou modificada.

Os usuários poderão acessar esse log a partir de um novo botão Auditoria nas configurações da conexão.