Integration Hub

O conteúdo desta página é para um produto ou recurso em versão controlada (CR). Se você não faz parte do grupo CR e deseja obter mais informações, entre em contato com o seu Representante de Contas do CXone.

O Integration Hub fornece uma maneira padronizada de lidar com a integração do CXone com autenticação de terceiros e serviços da Web. Os serviços da Web podem ser aplicativos, plataformas ou sistemas.

O Integration Hub é uma das maneiras pelas quais você pode trabalhar com chamadas de APIs REST no CXone. A vantagem de usar o Integration Hub é que você pode adicionar a conexão e usá-la em vários lugares. Outros métodos exigem a criação de uma conexão sempre que você quiser usá-la.

Além disso, o Integration Hub proporciona segurança aprimorada, inclusive MTLS e segredos. As variáveis adicionadas como secretas são criptografadas, não podendo ser acessadas diretamente.

Conexões e modelos de conexão

As conexões definem os detalhes das solicitações de API, os detalhes de autenticação e as variáveis que você deseja usar no CXone. 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.

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 da Web conectado, como a recuperação de dados ou a criação de registros.

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. Eles incluem:

NICE CXone Portal do desenvolvedor: integra-se com terminais disponíveis no Portal do desenvolvedor de APIs, para reduzir a dependência de Studio ações da estrutura. 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.

Não é possível modificar os modelos do sistema e aqueles que você tiver criado. 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 estão disponíveis na biblioteca de conexões no Integration Hub. As conexões estão listadas em Minhas conexões no Integration Hub. Você pode criar no máximo 50 conexões. Não há limite para o número de modelos.

Solicitações

Solicitações são chamadas de API. Eles especificam as seguintes informações, que são usadas para se conectar a um serviço da 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.
Parâmetros de consulta: uma maneira de passar informações com uma solicitação de API. 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

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 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.

Segredos são criptografados em repouso. O Integration Hub usa o Advanced Encryption Standard (AES) para criptografar os dados. Ele está armazenado em um banco de dados criptografado. 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:

CONNECTAUTH: essa ação permite que você inclua detalhes de autenticação ou segredos no seu script. Os detalhes e variáveis de autenticação devem ser definidos em uma conexão do Integration Hub.
CONNECTREQUEST: essa ação permite que você use uma solicitação definida em uma conexão do Integration Hub. Essa ação é necessária para usar solicitações manuais e solicitaçõ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, 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, é 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.