Configurar Conexões

As conexões do Integration Hub permitem que você configure integrações com serviços da Web de terceiros para uso em NiCE CXone.

Todas as tarefas nesta página exigem a permissão Launch Connections Hub.

Criar um Modelo de conexão

Um modelo de conexão define as informações básicas sobre uma integração. Os Modelos são usados para criar conexões, nas quais você pode configurar solicitações específicas e outras informações.

Modelos de conexão não podem ser modificados após a criação. Se precisar alterar algum detalhe, inclusive os cabeçalhos, você deverá criar um novo modelo.

  1. Em NiCE CXone, clique no seletor de aplicativos Icon of three-by-three grid of white squares on a blue background e selecioneConnections Hub > Integrações > Integration Hub.
  2. Clique em Adicionar Modelo.
  3. Na guia Detalhes, insira um Nome para o modelo.
  4. Enter o nome do Aplicativo ao qual você está se conectando. Pode ser um aplicativo, uma plataforma ou um serviço da web.
  5. Selecione REST como o Método de Integração. Atualmente, REST é o único método suportado.
  6. Selecione uma opção para Tipo de autenticação. Após fazer uma seleção, a guia Configuration é exibida.

  7. Insira uma Descrição do modelo. Outros usuários poderão vê-la quando selecionarem esse modelo na biblioteca de conexões.
  8. Anexe um ícone arrastando e soltando uma imagem ou clicando em Procurar arquivos. Esse ícone é exibido para este modelo na biblioteca de conexões para todas as conexões criadas a partir deste modelo.
  9. Na guia Configuração, selecione os métodos (verbos) que você deseja que estejam disponíveis para uso com esse modelo. Nem todos os serviços da Web são compatíveis com todos os verbos REST.
  10. If you selected an authentication type, define any custom authentication headers for this template:
    1. Clique em Adicionar cabeçalho personalizado.
    2. Insira o nome DO cabeçalho no campo exibido.
    3. Clique em Add Custom Header para adicionar mais cabeçalhos personalizados.
    4. Selecione Obrigatório? para quaisquer cabeçalhos que devam ser usados em conexões criadas a partir deste modelo.
    5. Clique em X para excluir um cabeçalho.
  11. Verifique novamente todas as configurações. Não é possível editar um modelo depois de salvá-lo.
  12. Do one of the following: 
    • Clique em Salvar para adicionar o modelo à biblioteca de conexões.
    • Clique em Salvar + Minhas Conexões para adicionar o modelo à biblioteca de conexões e criar uma conexão a partir dele. Após a conexão ser criada, você pode configurá-la adicionando detalhes de autenticação, variáveis ou solicitações. Sua solicitação pode incluir qualquer uma ou todas essas configurações.

Adicionar uma conexão à lista Minhas Conexões

Esta seção se aplica se você clicou em Salvar ao criar o modelo de conexão, não em Salvar + Minhas Conexões. Uma conexão só pode ser usada em um script Studio se estiver na lista Minhas Conexões.

  1. Em NiCE CXone, clique no seletor de aplicativos Icon of three-by-three grid of white squares on a blue background e selecioneConnections Hub > Integrações > Integration Hub.

  2. Crie uma nova conexão de uma das seguintes formas:

    • Selecione uma conexão existente na Biblioteca de conexões e clique em + Minha conexão.

    • Copie um modelo selecionando um existente na lista Minhas Conexões e, em seguida, clique em Ícone de duas folhas de papel empilhadas Copiar.

  3. No campo My Connection Name na janela pop-up, insira um nome exclusivo para a nova conexão.

  4. Clique em Salvar.

Configurar Detalhes de Autenticação

Você pode configurar os detalhes da autenticação na guia Autenticação na sua conexão. Essa guia fica visível somente quando a autenticação está ativada no modelo usado para essa conexão.

  1. Em NiCE CXone, clique no seletor de aplicativos Icon of three-by-three grid of white squares on a blue background e selecioneConnections Hub > Integrações > Integration Hub.

  2. Clique na conexão com a qual deseja trabalhar em Minhas Conexões, no lado esquerda da página.

  3. Clique na guia Autenticação .

  4. Insira o URL usado para a solicitação de autenticação. A URL não pode ser dinâmica, mas você pode fazer referência a segredos nela.

  5. Selecione o Método (verbo) REST usado na solicitação de autenticação. Os verbos disponíveis são definidos pelo modelo usado para essa conexão.

  6. Em Cabeçalhos, insira o valor apropriado em cada campo. Os Campos com um asterisco (*) são obrigatórios. Esses campos são definidos no modelo usado para essa conexão.

  7. Para adicionar um cabeçalho personalizado a essa conexão:

    1. Clique em Add Custom Header.

    2. Insira um Nome de cabeçalho e um Valor de cabeçalho.

  8. To add a query parameter to the authentication request:
    1. Clique em Adicionar parâmetro de consulta.
    2. Para cada parâmetro de consulta que você adicionar, informe um Query Parameter Name e Query Parameter Value.
  9. Selecione um Tipo DE mídia e insira o conteúdo do Corpo. O tipo DE mídia afeta o formato do conteúdo do corpo. Deve corresponder ao Tipo exigido pelo servidor de autorização que você está usando.

  10. Clique em Salvar.

Configurar um Certificado mTLS Autoassinado

Você pode usar a guia Configuração de uma conexão para definir a configuração de limite de tempo e um certificado mTLS autoassinado.

  1. Em NiCE CXone, clique no seletor de aplicativos Icon of three-by-three grid of white squares on a blue background e selecioneConnections Hub > Integrações > Integration Hub.

  2. Clique na conexão com a qual você deseja trabalhar em Minhas Conexões, no lado esquerdo da página.

  3. Clique na guia Configuração.

  4. Ajuste a configuração Limite de tempo (MS) conforme necessário. O limite de tempo aplica-se a todas as solicitações configuradas na conexão, incluindo a autenticação. Se estiver usando um certificado autoassinado mTLS, preencha os campos a seguir:

    • Certificado do provedor de identidade do cliente
    • Chave Privada do cliente
    • Frase secreta da chave

    Esses campos só aparecem se você usar OAuth 2.0 como seu tipo de autenticação. Você deve inserir o Client Certificate e o Client Private Key juntos. Se sua Client Private Key estiver criptografada, você deve inserir uma Key Passphrase. Os certificados mTLS só funcionam se a URL de autenticação estiver em HTTPS. A validação desses campos ocorre após a conexão ser salva. Você pode fazer referência a esses campos na guia Segredos.

  5. Clique em Salvar.

Adicionar variáveis e segredos a uma conexão

Integration Hub Variáveis permitem que você compartilhe determinadas informações em uma conexão. É possível determinar se essas informações serão criptografadas ou não. Uma variável criptografada, ou secreta, fornece uma camada adicional de segurança ao usar informações sensíveis, como senhas em Studio Scripts.

Quando você cria uma variável, pode convertê-la em secreto a qualquer momento. Depois que uma variável se torna um secreto e o conector é salvo, não é possível transformar o secreto novamente em variável.

Segredos não são reversíveis. Quando você clica fora do campo Valor do segredo, o conteúdo é criptografado e substituído por asteriscos mascarados ( *). Não há como recuperar o valor inserido no campo depois que ele for mascarado.

  1. Em NiCE CXone, clique no seletor de aplicativos Icon of three-by-three grid of white squares on a blue background e selecioneConnections Hub > Integrações > Integration Hub.

  2. Clique na conexão com a qual deseja trabalhar em Minhas Conexões, no lado esquerdo da página.

  3. Na guia Variables, clique em + Adicionar variável.

  4. Insira um Nome da variável que identifique o que a Variável contém. Nomes podem conter espaços ou caracteres especiais.

  5. Digite o valor da Variável. Este é o valor da variável e as informações que serão criptografadas, caso a variável seja tornada secreta. Certifique-se de que as informações estejam corretas antes de ativá-la como sendo secreta.

  6. Para criptografar a variável, ative o interruptor Secreta. Lembre-se de que, se você ativar essa opção, não poderá revertê-la.

  7. Para remover uma variável da conexão, clique no X à sua direita.

  8. Clique em Salvar.

Usar Variáveis em uma conexão

Você pode usar variáveis em solicitações de script manuais ou Studio. Você pode usá-las em cabeçalhos, parâmetros de consulta e conteúdo do corpo.

Usar uma Variável nos Detalhes de autenticação ou em uma Solicitação manual

  1. Em NiCE CXone, clique no seletor de aplicativos Icon of three-by-three grid of white squares on a blue background e selecioneConnections Hub > Integrações > Integration Hub.

  2. Clique na conexão com a qual deseja trabalhar em Minhas Conexões, no lado esquerdo da página.

  3. Clique na guia em que deseja usar uma variável. As Variáveis podem ser usadas nas guias Authentication e Solicitações.

  4. Digite a variável no lugar onde deseja ver seu valor, adotando as seguintes diretrizes:

    • Coloque o nome entre colchetes duplos. Por exemplo: [[ NomedaVariável ]].
    • Utilize o nome exatamente como foi digitado no campo Nome da variável, na guia Variáveis.
    • Variáveis somente podem ser usadas com a conexão em que foram criadas.

Usar uma Variável em uma Solicitação do Studio

Para usar variáveis em um script Studio, o script deve ter uma ação CONNECTAuth ou CONNECTREQUEST. A ação deve vincular o script à conexão que contém a variável.

  1. No Studio, abra o script no qual você deseja usar a variável.

  2. Duplo clique na ação Snippet à qual você deseja adicionar a variável.

  3. Na janela do Snippet editor, adicione a variável no local em que deseja que o valor da variável seja usado, seguindo estas diretrizes:

    • Coloque o nome entre colchetes duplos. Por exemplo: [[ NomedaVariável ]].
    • Utilize o nome exatamente como foi inserido no campo Nome da variável na guia Variáveis.
    • Coloque entre aspas duplas ( " ) os colchetes e o nome da variável. Por exemplo: [[ NomedaVariável ]]. Se a variável fizer parte de uma sequência de caracteres, como um URL, toda a sequência deverá ser colocada entre aspas, e não apenas a variável. Por exemplo: "[[ NomedaVariável ]]/local/outrolocal/".
    • Variáveis só podem ser usadas com a conexão em que foram criadas. A conexão deve ser especificada no script com uma ação CONNECTAuth ou CONNECTREQUEST.

    Exemplos:

    • ASSIGN requestPayload.body = "[[client_id]]"

    • ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V42.0/AGENTS"

Criar uma Solicitação Manual

Solicitações são o meio pelo qual você obtém as informações necessárias do serviço web ao qual sua integração se conecta. Você pode usar solicitações manuais em scripts Studio ou executá-las a partir de Integration Hub.

Se sua solicitação exigir parâmetros de caminho ou substituição de variável na URL, nos cabeçalhos ou nos parâmetros, você deve criar uma solicitação Studio. solicitações manuais não são compatíveis com essas opções.

  1. Em NiCE CXone, clique no seletor de aplicativos Icon of three-by-three grid of white squares on a blue background e selecioneConnections Hub > Integrações > Integration Hub.

  2. Clique na conexão com a qual deseja trabalhar em Minhas Conexões, no lado esquerdo da página.

  3. Na guia Solicitações, clique em Adicionar Solicitação.

  4. Digite o Nome da solicitação.

  5. Selecione Manual como Gatilho.

  6. Insira a URL dessa solicitação.

  7. Clique no Método (verbo) dessa solicitação.

  8. Em Cabeçalhos, adicione todos os cabeçalhos necessários para sua solicitação:

    1. Clique em Adicionar Cabeçalho.

    2. Insira um Nome de cabeçalho e um Valor de cabeçalho.

  9. Under Query Parameters, add any query parameters that are required for your request: 
    1. Clique em Adicionar parâmetro de consulta.
    2. Insira um Nome de parâmetro de consulta e um Valor de parâmetro de consulta.
  10. Selecione um Tipo DE mídia e insira o conteúdo do Corpo. O tipo DE mídia afeta o formato do conteúdo do corpo. Deve corresponder ao Tipo exigido pelo serviço web ao qual você está se conectando.

  11. Se quiser alterar o status ativo desta solicitação, clique em Ativo na parte superior da página. O texto muda para Inativo.
  12. Clique em Confirmar.
  13. On a guia Solicitações, clique em Testar para a Solicitação que você acabou de adicionar. Integration Hub tenta executar a solicitação. Uma janela é exibida e mostra os resultados do teste.
  14. Clique em Editar e faça alterações na solicitação ou clique em Salvar.

Criar uma Solicitação de Studio

Uma solicitação Studio é útil quando você tem solicitações de API que não podem ser criadas em Integration Hub, mas deseja poder usar Integration Hub para autenticação e segredos.

  1. Em NiCE CXone, clique no seletor de aplicativos Icon of three-by-three grid of white squares on a blue background e selecioneConnections Hub > Integrações > Integration Hub.

  2. Clique na conexão com a qual deseja trabalhar em Minhas Conexões, no lado esquerdo da página.

  3. Na guia Solicitações, clique em Adicionar Solicitação.

  4. Digite o Nome da solicitação.

  5. Selecione Studio como o Gatilho.

  6. Selecione e copie a carga útil da solicitação de exemplo na página Adicionar Solicitação se quiser usar o exemplo para criar o JSON no seu script.

  7. Clique em Confirmar.

    As solicitações de Studio não podem ser testadas a partir de Integration Hub. Você deve testá-las em Studio executando o script com um rastreamento.

  8. Clique em Icon of a floppy disk Salvar.

  9. Inicie o Studio e faça login.
  10. Abra um script existente ou crie um novo.
  11. Adicione uma ação Snippet action ao seu script e dê um duplo clique nela para abrir a janela do editor Snippet.
  12. Crie um objeto dinâmico na janela do editor Snippet e converta-o em JSON. O objeto que você criar deve conter membros que armazenem os cabeçalhos, os parâmetros de consulta e o conteúdo do corpo necessários para a solicitação.

    Use a carga útil de exemplo que você copiou de Integration Hub em uma etapa anterior como guia ao criar seu objeto. A carga útil de exemplo é:

    {
     "URL": "[[INSTANCEURI]]/INCONTACTAPI/SERVICES/V42.0/AGENTS",
     "HTTPMETHOD": "POST",
     "HEADERS": {
    	"CONTENT-TYPE": "APPLICATION/JSON",
    	"AUTHORIZATION": "BEARER[[BEARERTOKEN]]"
    	},
     "QUERYPARAMETERS": {
    	"ANI": "[[ANI]]",
    	"ACCOUNTID": "8675309"
    	},
     "BODY": {
    	"ANI": "[[ANI]]",
    	"ACCOUNTID": "9035768",
    	"ACCOUNTNAME": "Mister Underhill Bagginses"
    	}
    }
    		

    Um objeto dinâmico criado usando a carga útil de exemplo como guia é:

    DYNAMIC requestPayload 
    ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERVICES/V42.0/AGENTS"
    ASSIGN requestPayload.HTTPMETHOD = "POST"
    ASSIGN requestPayload.HEADERS.CONTENTHYPHENPLACEHOLDERTYPE = "APPLICATION/JSON"
    ASSIGN requestPayload.HEADERS.AUTHORIZATION = "BEARER[[BEARERTOKEN]]"
    ASSIGN requestPayload.QUERYPARAMETERS.ANI = "[[ANI]]"
    ASSIGN requestPayload.QUERYPARAMETERS.ACCOUNTID = "8675309"
    ASSIGN requestPayload.BODY.ANI = "[[ANI]]"
    ASSIGN requestPayload.BODY.ACCOUNTID = "9035768"
    ASSIGN requestPayload.BODY.ACCOUNTNAME = "Mister Underhill Bagginses"
    ASSIGN requestPayloadJSON = "{requestPayload.asjson()}"
    ASSIGN requestPayloadJSON = "{requestPayloadJSON.replace("HYPHENPLACEHOLDER", "-")}"

    A última linha do exemplo anterior usa a função replace() para inserir o caractere de hífen ( - ) no nome da chave CONTENT-TYPE. No Studio, os nomes de variáveis não podem incluir caracteres especiais, como hifens. Portanto, essa abordagem é usada como uma solução alternativa.

  13. Configure o script para usar a solicitação.

Alterar o Estado de uma Solicitação

Cada conexão do Integration Hub pode ter até 50 solicitações. Não há restrição quanto à quantidade de solicitações que podem estar ativas ao mesmo tempo. Solicitações estão ativas por padrão.

  1. Em NiCE CXone, clique no seletor de aplicativos Icon of three-by-three grid of white squares on a blue background e selecioneConnections Hub > Integrações > Integration Hub.

  2. Clique na conexão com a qual deseja trabalhar em Minhas Conexões, no lado esquerdo da página.

  3. Na guia Solicitações, clique na Solicitação com a qual você deseja trabalhar.

  4. Clique em Inativo ou Ativo na parte superior da página para alterar o estado.