Gerenciar conexões

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.

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

Criar um modelo de conexão

Um modelo de conexão define as informações básicas sobre uma integração. 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.

Captura de tela da página Adicionar modelos no Integration Hub.
  1. No CXone, clique no seletor de aplicativos e selecioneAutomação e IA > Integration Hub.
  2. Clique em Adicionar modelo.
  3. Na guia Detalhes, insira um Nome para o modelo.
  4. Insira 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 compatível.

  6. Selecione uma opção para Tipo de Autenticação.

    Opção Detalhes
    OAuth 2.0 Selecione essa opção se quiser que o modelo inclua a autenticação OAuth 2.0. Atualmente, esse é o único tipo de autenticação compatível.
    Sem autenticação Selecione essa opção se não quiser que o modelo inclua a autenticação.
  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. Este ícone é exibido com este modelo na biblioteca que armazena 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. Para definir cabeçalhos de autenticação personalizados para esse modelo, clique em Adicionar cabeçalho personalizado. Essa opção só estará disponível se você tiver ativado a autenticação para o modelo. Para definir um cabeçalho: 
    1. Insira o nome do cabeçalho no campo exibido.
    2. Clique em Adicionar cabeçalho personalizado para adicionar mais cabeçalhos personalizados.
    3. Selecione Obrigatório? para todos os cabeçalhos que devem ser usados em conexões criadas a partir desse modelo.
    4. Clique no link 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. Siga um destes procedimentos: 
    • 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. Depois que a conexão for criada, você poderá configurá-la adicionando detalhes de autenticação, variáveis ou solicitações. Sua solicitação pode incluir qualquer uma ou todas essas configurações.

Criar uma conexão a partir de um modelo

Conexões permitem que você crie solicitações e adicione detalhes de autenticação. As conexões aparecem em Minhas conexões no Integration Hub.

Você cria conexões a partir de modelos de conexão. A biblioteca de conexões mostra todos os modelos de conexão existentes no seu CXone sistema. Se não houver um modelo que corresponda ao que você precisa fazer, você poderá criar um.

  1. No CXone, clique no seletor de aplicativos e selecioneAutomação e IA > Integration Hub.

  2. Localize um modelo na biblioteca de conexões. A biblioteca está no lado direito da página. Se estiver visualizando uma conexão ou modelo, clique no link X no canto superior direito da página. Isso a fecha, para que você possa ver a biblioteca de conexões.

  3. Clique em Minha Conexão na página de propriedades do modelo para criar uma conexão com base no modelo.

  4. Se estiver usando um certificado autoassinado mTLS, preencha os campos a seguir:

    • Certificado de cliente
    • Chave privada do cliente
    • Senha da chave

    Esses campos só aparecerão se você usar o OAuth 2.0 como tipo de autenticação. Você deve inserir o Certificado do cliente e a Chave privada do cliente juntos. Se a sua Chave privada do cliente estiver criptografada, você deverá digitar uma Senha de chave. Certificados mTLS só funcionarão se a URL de autenticação estiver em HTTPS. A validação desses campos ocorrerá depois que a conexão for salva. Você pode fazer referência a esses campos na guia Segredos.

  5. Digite um nome para a conexão e clique em Salvar.

  6. Clique na nova conexão na lista do lado esquerdo da página.

  7. Na guia Configuração, configure um Limite de tempo em milissegundos. O limite de tempo aplica-se a todas as solicitações configuradas na conexão, incluindo a autenticação.

  8. Configure a autenticação e as solicitações conforme necessário. Sua conexão pode incluir uma ou outra, ou ambas.

  9. Configure as variáveis , caso tenha informações que deseja criptografar para uso na conexão.

Configurar detalhes da 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. No CXone, clique no seletor de aplicativos e selecioneAutomação e IA > Integration Hub.

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

  3. Na guia Autenticação, insira a URL usada para a solicitação de autenticação. A URL não pode ser dinâmica, mas você pode fazer referência a segredos nela.

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

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

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

    1. Clique em Adicionar cabeçalho personalizado.

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

  7. Para adicionar um parâmetro de consulta à solicitação de autenticação:
    1. Clique em Adicionar parâmetro de consulta.
    2. Para cada parâmetro de consulta que você adicionar, insira um Nome do parâmetro de consulta e um Valor do parâmetro de consulta.

  8. 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ê estiver usando.

    Opção Detalhes

    ApplicationJson

    O conteúdo do corpo deve estar em JSON.
    ApplicationJsonPatch O conteúdo do corpo deve estar no formato JSON Patch.
    FormURLEncoded

    O conteúdo do corpo deve estar no formato de pares de chaves-valores. Esse tipo de mídia envia solicitações usando notações de URL comuns.

    Clique em +Adicionar parâmetro de formulário e, em seguida, insira o Nome do parâmetro do formulário e Valor do parâmetro de formulário.
    TextHtml O conteúdo do corpo deve estar em HTML.
    TextPlain O conteúdo do corpo deve estar em texto simples.
    TextXml O conteúdo do corpo deve estar em XML.

  9. Clique em Salvar.

Adicionar variáveis a uma conexão

As Integration Hub variáveis permitem compartilhar certas informações em uma conexão. É possível determinar se essas informações serão criptografadas ou não. Uma variável criptografada (segredo) proporciona uma camada adicional de segurança ao se usar informações confidenciais, como senhas, em scripts Studio.

Ao criar uma variável, você pode convertê-la em segredo a qualquer momento. Assim que a variável se tornar um segredo e o conector tiver sido salvo, não será mais possível transformar o segredo em uma 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 que você inseriu no campo depois que ele é mascarado.

  1. No CXone, clique no seletor de aplicativos e selecioneAutomação e IA > Integration Hub.

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

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

  4. Digite um nome de variável que identifique o conteúdo da variável. 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.

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

  8. Clique em Salvar.

Utilizar variáveis em uma conexão

É possível utilizar as variáveis em solicitações manuais ou Studio de scripts. Elas podem ser utilizadas em cabeçalhos, parâmetros de consultas e conteúdo de corpo.

Use uma variável nos detalhes de autenticação ou em uma solicitação manual

  1. No CXone, clique no seletor de aplicativos e selecioneAutomação e IA > 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 em que deseja usar uma variável. As variáveis podem ser usadas nas guias Autenticação e Solicitações.

  4. Digite a variável no lugar onde deseja ver o 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.
    • As variáveis só podem ser usadas com a conexão em que foram criadas.

Utilizar uma variável em uma Studio solicitação

Para utilizar variáveis em um Studio script, este deverá 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. Clique duas vezes na ação Snippet à qual você deseja adicionar a variável.

  3. Na janela do editor Snippet, adicione a variável no local em que você 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 digitado no campo Nome da variável, na guia Variáveis.
    • Coloque os colchetes e o nome da variável entre aspas ( " ). 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/".
    • As 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/V26.0/AGENTS"

Criar uma solicitação manual

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

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

  1. No CXone, clique no seletor de aplicativos e selecioneAutomação e IA > Integration Hub.

  2. Clique na conexão com a qual você 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 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. Em Parâmetros de consulta, adicione todos os parâmetros de consulta necessários para sua solicitação:
    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. Ele deve coincidir com o tipo exigido pelo serviço da Web ao qual você estiver se conectando.

    Opção Detalhes

    ApplicationJson

    O conteúdo do corpo deve estar no formato JSON, com application/json como cabeçalho do conteúdo.
    ApplicationJsonPatch O conteúdo do corpo deve estar no formato JSON Patch, com application/json-patch+json como cabeçalho do conteúdo.
    FormURLEncoded

    O conteúdo do corpo deve estar em pares de chaves/valores, com application/x-www-form-urlencoded como sendo o cabeçalho do conteúdo. Esse tipo de mídia envia solicitações usando notações de URL comuns.

    Clique em +Adicionar parâmetro de formulário e, em seguida, insira o Nome do parâmetro do formulário e Valor do parâmetro de formulário.
    TextHtml O conteúdo do corpo deve estar no formato HTML, com text/html como cabeçalho do conteúdo.
    TextPlain O conteúdo do corpo deve estar em formato de texto simples, com text/plain como cabeçalho do conteúdo.
    TextXml O conteúdo do corpo deve estar no formato XML, com text/xml como cabeçalho do conteúdo.
  11. Se quiser alterar o status ativo dessa solicitação, clique em Ativo na parte superior da página. O texto muda para Inativo.
  12. Clique em Confirmar.
  13. Na guia Solicitações, clique em Testar para a solicitação que você acabou de adicionar. O Integration Hub tenta 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 Studio

Uma Studio solicitação é útil quando houver solicitações de API que não possam ser criadas no Integration Hub, mas quando se deseja usar o Integration Hub para autenticação e segredos.

  1. No CXone, clique no seletor de aplicativos e selecioneAutomação e IA > Integration Hub.

  2. Clique na conexão com a qual você 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.

    Solicitações Studio não podem ser testadas no Integration Hub. Você deve testá-las no Studio, executando o script com um rastreamento.

  8. Clique em Salvar.
  9. Inicie o Studio e faça login.
  10. Abra um script existente ou crie um novo.
  11. Adicione uma ação Snippet ao seu script e clique duas vezes 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 ter membros que contenham os cabeçalhos, os parâmetros de consulta e o conteúdo do corpo necessários para a solicitação.

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

    {
 "URL": "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.0/AGENTS",
 "HTTPMETHOD": "POST",
 "HEADERS": {
	"CONTENT-TYPE": "APPLICATION/JSON",
	"AUTHORIZATION": "BEARER[[BEARERTOKEN]]"
	},
 "QUERYPARAMETERS": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "123456"
	},
 "BODY": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "123456",
	"ACCOUNTNAME": "TESTACCOUNT"
	}
}

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

    DYNAMIC requestPayload 
ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.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 = "123456"
ASSIGN requestPayload.BODY.ANI = "[[ANI]]"
ASSIGN requestPayload.BODY.ACCOUNTID = "123456"
ASSIGN requestPayload.BODY.ACCOUNTNAME = "TESTACCOUNT"
ASSIGN requestPayloadJSON = "{requestPayload.asjson()}"
ASSIGN requestPayloadJSON = "{requestPayloadJSON.replace("HYPHENPLACEHOLDER", "-")}"

    A última linha do exemplo anterior usa a função replace() para inserir o caractere 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 ao número de solicitações que podem estar ativas simultaneamente. Como padrão, as solicitações estão ativas.

  1. No CXone, clique no seletor de aplicativos e selecioneAutomação e IA > Integration Hub.

  2. Clique na conexão com a qual você 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.