Integration Hub

Integration Hub oferece um local central para lidar com integrações com sistemas e serviços externos. Ele permite criar conexões APIClosed Interface de Programação de aplicativos. Permite que você automatize determinadas funcionalidades ao conectar o seu sistema NiCE CXone a outros softwares. REST padronizadas, que podem ser usadas em múltiplos Scripts de Studio. Isso evita a necessidade de criar repetidamente as mesmas solicitações sempre que você precisar se comunicar externamente por meio de API. Em vez disso, você pode criar a solicitação uma vez em Integration Hub e reutilizá-la sempre que precisar. Isso simplifica e agiliza o processo de criação de Scripts.

Integration Hub também torna suas integrações mais seguras. Ele criptografa as credenciais de API, de modo que, cada vez que você as usa, elas não ficam expostas no script. Os scripts Studio 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 de API. Integration Hub permite que você adicione rapidamente uma solicitação de autenticação a um script e, em seguida, use com segurança as credenciais recuperadas em Chamadas de API subsequentes. Você também pode adicionar certificados mTLS a uma solicitação de API.

Você pode encontrar Integration Hub no aplicativo Connections Hub em NiCE CXone. É necessário ter a permissão Launch Connections Hub para acessá-lo.

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

Modelos de Conexão

Cada conexão que você adiciona a Integration Hub é criada com base em um modelo de conexão. Os 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 sem 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. Os 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ções suportados.

Integration Hub é fornecido com cinco modelos de sistema padrão. Esses modelos permitem que você crie conexões com vários serviços da web, incluindo a API do NiCE CXone e quatro CRMsClosed sistemas de Terceiros que gerenciam itens como contatos, informações de vendas, detalhes de suporte e históricos de casos. populares.

Os modelos de conexão padrão e quaisquer modelos personalizados que você criar estão disponíveis na biblioteca de Conexões em Integration Hub. Os Modelos que você pode usar em um script Studio são listados em Minhas 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.

Os modelos não podem ser modificados. No entanto, você pode excluir seus modelos personalizados. Se precisar alterar algo em um modelo personalizado posteriormente, você pode excluir o modelo e criar um novo. As próprias Conexões podem ser modificadas. Excluindo um modelo personalizado não afeta as conexões criadas com esse modelo.

Modelos de sistema

Integration Hub tem dois tipos DE modelos: modelos de sistema pertencentes a NiCE e modelos que você mesmo cria. 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:

  • NiCE CXone Developer Portal: Fornece acesso direto e flexível às Chamadas de API encontradas no NiCE CXone DEVone Developer Portal. Para usar este modelo, seu aplicativo de integração deve estar registradoIcon of a square with an arrow pointing outside of it. com NiCE. Isso reduz sua dependência de Studio Framework actions. Ele utiliza a OAuth autenticação 2.0. Para determinar a autenticação, ele usa a URL do discovery. Ele não oferece suporte a certificados de cliente.
  • Microsoft Dynamics 365: Permite que você se conecte às API REST do Dynamics 365.
  • Salesforce: Permite que você se conecte às API REST de Salesforce.
  • ServiceNow: Permite que você se conecte às API REST ServiceNow.
  • Zendesk: Permite que você se conecte a API REST Zendesk.

Os modelos do sistema são configurados para usar a autenticação OAuth 2.0. Eles oferecem suporte aos métodos GET, PUT, POST, DELETE e PATCH. Eles não têm nenhum cabeçalho definido por padrão, portanto, você deve adicionar todos os cabeçalhos necessários nas conexões que criar com os modelos.

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 conectar a um serviço da web:

  • URL: A localização do recurso ao qual você está se conectando.
  • Método (Verb): A ação que você deseja que a solicitação execute, como recuperar dados ou criar um novo registro. 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 a 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 forma de passar informações com uma solicitação de API na URL DO terminal. Elas são configuradas como pares chave-valor. Elas podem ser usadas para filtrar, ordenar, personalizar ou controlar os dados retornados na resposta.
  • Body: The content of the request. The format depends on the requirements of the API you're connecting to. The media type of the body must match what the resource you're connecting to expects. It's also known as the MIME type or content type. These are the supported options and the associated content headers: 
    • 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 ao mesmo tempo.

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

Manual, Studio e Solicitações Híbridas

Integration Hub oferece suporte a três opções para solicitações em conexões:

  • Manual: Uma solicitação manual é criada em Integration Hub usando as opções na página Add Solicitação. Você pode usar segredos neles. solicitações manuais são comumente usadas para casos em que os dados não mudam. Eles podem ser executados diretamente do Integration Hub sem exigir um script Studio. Eles também podem ser executados em Scripts Studio.
  • Studio: In some cases, API requests cannot be built as manual requests in Integration Hub. For example, requests that require path parameters, variable substitution, or that connect to SOAP web services, must be built in a Studio script. However, you may want to keep track of these requests in your Integration Hub connections. The Studio request option allows you to do that. A Studio request appears on a connection's Requests tab along with all of the manual requests the connection has.

  • Híbrido: Uma solicitação híbrida combina os recursos dos tipos de solicitação manual e Studio. Isso proporciona a flexibilidade de pré-configurar os detalhes da solicitação em Integration Hub, permitindo que qualquer um desses valores seja substituído dinamicamente em tempo de execução. As solicitações híbridas são ideais quando:

    • A maioria da configuração da sua solicitação é consistente entre execuções, mas um ou mais valores precisam mudar dinamicamente. Por exemplo, um corpo de solicitação que varia por cliente ou um parâmetro de consulta que muda com base na entrada de um script Studio.

    • Você deseja a conveniência de configurar e visualizar os valores padrão em Integration Hub, mantendo a capacidade de substituí-los programaticamente.

    • Você precisa de uma única definição de solicitação que possa atender a múltiplos casos de uso sem duplicar a configuração.

A tabela a seguir resume a diferença entre os três tipos de solicitação:

Categoria Manual Studio Híbrido
Configuração

Todos os campos definidos na UI

Todos os campos fornecidos no tempo de execução

Campos definidos na UI com substituições opcionais em tempo de execução

Entrada em tempo de execução

Não suportado

Obrigatório

Opcional

Validação de campo

URL e método HTTP são obrigatórios

N/A (validado em tempo de execução)

Nenhum campo obrigatório; valores podem ser fornecidos em tempo de execução

Testar botão

Disponível

Não disponível

Não disponível

Substituir comportamento

N/A

N/A

Valores dinâmicos sobrepõem valores estáticos

Variáveis

Integration Hub permite armazenar pares de valores como variáveis. As Variáveis são não criptografadas por padrão. 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 cria. Se você executar uma conexão ou solicitação de autenticação em um Studio script, você pode usar variáveis dessa conexão no script.

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

Integration Hub Studio Ações

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 ações de Integration Hub Studio

  • Eles exigem o Integration Hub. Se Integration Hub não estiver habilitado no sistema NiCE CXone, as ações não funcionam.
  • Você pode incluir mais de uma instância de cada ação em um script.
  • Você pode usar a substituição de variável para executar diferentes solicitações ou usar autenticação de mais de uma conexão em um único script.
  • Assim como ocorre com outros métodos de realizar Chamadas de API no NiCE CXone, é necessário um script adicional para receber a resposta do serviço web conectado e tratá-la adequadamente.
  • CONNECTAUTH não permite nenhuma personalização. Ele executa a solicitação de autenticação conforme definido na conexão no Integration Hub.

Circuit Breaker

Integration Hub tem um circuit breaker integrado. Trata-se de um mecanismo de segurança preventivo para Chamadas de API com falha. Se o circuit breaker detectar que uma chamada está falhando repetidamente, ele é ativado e limita a Chamada de API. O motivo mais comum para falhas em chamadas é um erro de servidor temporário (erros 500). Limitar (ou pausar) a chamada dá ao servidor tempo para voltar a funcionar corretamente.

As seguintes são as principais características do disjuntor:

  • O circuit breaker é ativado se mais de 50% das chamadas para uma API falharem dentro de 30 segundos.

  • Para acionar o circuit breaker, Integration Hub deve ter tentado mais de 100 chamadas para uma única API dentro de uma janela de 30 segundos.

  • O disjuntor é ativado por 30 segundos.

  • Os motivos de falha estão acessíveis nos registros de rastreamento do Studio, capturados na variável _err.

Histórico de auditoria

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

  • 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 ocorreu, como se uma conexão foi criada ou modificada.

Você pode acessar este log com o botão Auditoria nas configurações da conexão.