Ações de API

As informações desta página de ajuda se aplicam tanto a Studio quanto a Desktop Studio.

Ações de API são ações de Studio que permitem que você use as API de NiCE CXone em seus scripts. Você pode usar a ação em vez de chamar a API usando métodos de integração tradicionais, como usar um snippet ou a RestAPI action.

As ações API são diferentes das ações Studio padrão. Elas não estão documentadas na ajuda online. No entanto, as API que correspondem às Ações de API estão documentadas no portal do desenvolvedor NiCE CXone A square with an arrow pointing from the center to the upper right corner.. Você pode usar esta documentação ao trabalhar com Ações de API em seus Scripts.

API Actions estão localizadas na paleta de API Actions em Studio. A organização deles corresponde à organização de API no portal do desenvolvedor. Isso ajuda a localizar a documentação correspondente com mais facilidade. Em Desktop Studio elas ficam na guia Framework. Nem todo API do NiCE CXone possui uma ação de API correspondente no Studio.

Definir o Usuário de segurança no seu script

Todas as ações da API exigem um usuário de segurança para funcionar corretamente. Um usuário de segurança é um perfil de funcionário NiCE CXone com permissões que permitem que ele acesse e interaja com NiCE CXone. Quando usado em um script, o usuário de segurança concede acesso de ação do Framework ou da API NiCE CXone. Esta deve ser uma conta dedicada apenas para esta finalidade. Você deve usar um perfil de funcionário NiCE CXone válido e ativo.

O usuário de segurança precisa de permissões que permitam que ele acesse o NiCE CXone e execute as ações necessárias. Não há uma lista pré-definida de permissões pois as exigências mudam de acordo com as ações usadas.

  1. Create a NiCE CXone employee profile. For this user: 
    • Dê a ele um nome que o identifique como um usuário de segurança.
    • Defina o Autenticador de login na aba Segurança da página Criar Novo funcionário como Nenhum selecionado. Não ter um autenticador de login significa que esta conta não pode ser usada para iniciar sessão no NiCE CXone. Isso não é um problema, já que você não vai precisar iniciar sessão com a conta. Ela é usada somente para fornecer acesso por meio de scripts do Studio.
    • Atribua a ela uma função que tenha as permissões apropriadas. A prática recomendada é criar uma função especificamente para o usuário de segurança.
    • Depois de salvar o novo perfil de funcionário, vá para ACD > ACD Users e pesquise o novo perfil. Tome nota do número na coluna ID. Este é o ID de agente do usuário. Você pode usá-lo para localizar o usuário ao configurar seu script.
  2. No seu Studio script, adicione uma ação SetSecurityUser action. Essa ação está localizada na aba Framework em Desktop Studio e na paleta Ações de API em Studio. Posicione SetSecurityUser antes de qualquer outra Ação do Framework ou de API.
  3. No campo de propriedade Agente em SetSecurityUser, enter o nome do usuário de segurança ou o id do agente e, em seguida, selecione o registro correspondente. Você pode usar substituição de variável nesse campo se tiver mais que um usuário de segurança que utiliza.
  4. Deixe a variável de saída como o padrão SecurityUser. Isso é definido na Variável de script. Em Desktop Studio a propriedade é ScriptVar (out). Se você alterá-la, deverá configurar toda ação do Framework ou API no script com a nova variável. Existem vários nomes para a propriedade que contém a variável, dependendo do Framework ou da ação de API utilizada. Usuário de segurança e AuthContext são dois nomes comuns.

Versões de Ação de API

À medida que novas versões de APIs do NiCE CXone são lançadas, novas versões das ações correspondentes podem ser lançadas no Studio. Geralmente, é melhor usar a versão mais recente da ação. Versões mais antigas ainda funcionarão na maioria dos casos. Você pode tentar as diferentes versões para ver quais funcionam e fornecem a funcionalidade de que você precisa.

Algumas ações API têm a versão no nome da ação.Você pode vê-lo ao observar a estrutura em árvore de ações na guia Framework. Nem todas as ações API incluem o número da versão.Para estas ações, você pode encontrar a versão nas propriedades estendidas da ação. Você só pode ver as propriedades estendidas na guia Propriedades quando a ação está selecionada na guia Estrutura.

Nem toda versão de todo API possui uma ação correspondente no Studio.

Exibir Propriedades Estendidas da Ação da API

Esta tarefa só pode ser concluída no Desktop Studio.

  1. Em Studio, reorganize as guias para que você possa ver a guia Propriedades e a guia Framework ao mesmo tempo.
  2. Na guia Framework, clique em uma ação de API.
  3. On the Properties tab, you can now see the extended properties of the action. In particular, the following properties are helpful when learning about an API action: 
    • Diversos > Parâmetros > Verb: Esta propriedade mostra o método, ou verbo, associado à ação.
    • Misc > Parâmetros > Version: Esta propriedade mostra a Versão da API.
    • Misc > Web > URI: Esta propriedade pode ser útil para localizar a documentação do API no portal do desenvolvedor.
    • Misc > Parâmetros: Na seção Parâmetros, você pode expandir as propriedades para ver informações adicionais sobre cada uma das propriedades da ação.

Localizar documentação API

Esta tarefa só pode ser concluída usando o Desktop Studio.

NiCE CXone As API são documentadas no NiCE CXone Portal do Desenvolvedor. Ações API no Studio não possuem um vínculo direto à documentação correspondente aos seus APIs. No entanto, você pode usar informações disponíveis nas propriedades estendidas da ação para ajudá-lo(a) a localizar a documentação.

Usar o URI requer familiaridade geral com o sistema NiCE CXone como um todo e com as diferentes APIs do NiCE CXone. Isto porque determinar qual API é compatível com qual ação no Studio não é sempre fácil. Conhecer o fluxo geral de um contato por meio de NiCE CXone ajuda você a interpretar corretamente a URI de uma ação e aplicar as pistas encontradas ali à estrutura da documentação da API no portal do desenvolvedor. Os exemplos nesta seção demonstram a interpretação que pode ser exigida.

A página inicial da seção de API do portal do desenvolvedor fornece uma visão geral de cada API NiCE CXone.

Exemplo 1

Às vezes há uma correlação clara entre uma ação e seu API:

Com base no nome e URI da ação, os primeiros dois APIs a ser considerados são o API de Agente e o API Admin. Ao analisar a lista de chamadas de API para cada um, você pode eliminar a Agent API. A sua descrição indica que ele é usado para gerenciar sessões de Agentes e não parece haver nenhuma chamada relacionada a competências, conforme ilustrado na imagem a seguir.

O API Admin indica que ele é usado com objetos de sistema como competências. A lista de chamadas de API Disponível para este API inclui competências, conforme ilustrado na imagem a seguir.

Quando você expande a seção Competências, um dos endpoints é GET /skills/agents. A breve descrição para este terminal diz que ele "Retorna atribuições de competências."

Exemplo 2

Às vezes, a correlação não é óbvia, conforme mostrado no exemplo a seguir. Em casos como esse, você precisará aplicar seu conhecimento de API NiCE CXone e da própria plataforma para encontrar o terminal de API correspondente.

Com base neste nome e URI da ação, não fica imediatamente claro qual API analisar primeiro. Caso não tenha certeza sobre por onde deve começar, você pode consultar a documentação para cada API e examinar todas as seções relacionadas aos contatos. A API do Admin é a única que possui uma seção de contato de nível superior. Infelizmente, este API não contém terminais relacionados a contatos ativos.

Neste ponto, você pode se concentrar na palavra active no nome da ação e no uri. Aproveitando-se do seu conhecimento do NiCE CXone, você sabe que ativo indica contatos que estão atualmente sendo atendidos. Isso leva você a examinar mais detalhadamente a API de Dados Em tempo real. Esta API possui somente uma seção, e quando você a expande, você vê que um dos endpoints é GET /contacts/active. A breve descrição para este terminal diz que ele "Retorna contatos ativos."