REST API

Esta página de ajuda é para Studio. Estas informações também estão disponíveis para Desktop Studio.

Icon of REST API: yellow cloud with code brackets

Lida com chamadas RESTful API simultaneamente. Esta ação permite que o sistema processe cargas mais altas. Ele retorna tanto o corpo quanto os cabeçalhos da Chamada de API. Isso torna mais fácil testar e depurar scripts.

Esta ação é um dos métodos suportados de conexão a serviços da web em um script Studio.

Se você tiver solicitações de API RESTful atualmente concluídas na Snippet ação, é altamente recomendável que você as substitua. Você pode usar a REST API ação, o Integration Hub, ou um dos outros métodos suportados. Fazer solicitações de API a partir de SNIPPET pode causar problemas graves de desempenho no sistema.

Dependências

Existem limitações para o uso desta ação que são impostas no nível da unidade de negóciosClosed Agrupamento organizacional de alto nível usado para gerenciar o suporte técnico, o faturamento e as configurações globais do seu sistema NiCE CXone..Isso é feito para que um não afete o outro. As limitações dentro da plataforma são:

  • Formato de resposta: Apenas o formato de resposta JSON é compatível.
  • Tentativas em caso de Falha: o manipulador de Ação tentará automaticamente duas vezes se uma mensagem de falha for recebida antes de retornar a resposta.
  • Tempo limite: Você especifica o valor de tempo limite na solicitação. O valor não pode ser mais que 90 segundos.
  • Tamanho máximo da Resposta: O tamanho máximo da resposta é de 32 KB. Isso é consistente com a funcionalidade existente do Snippet. Se chegar a este limite, você precisará reduzir o tamanho dos dados retornados.
  • Throttle Limit: The throttle limit is defined by two parameters:
    • Máximo de Solicitações Simultâneas: Até 100 solicitações simultâneas são permitidas por padrão. Este limite é o mesmo para todos os clientes do NiCE CXone. Isso significa que 100 solicitações simultâneas resultam em um throughput muito maior do que fazer chamadas de API a partir de uma ação Snippet. Se precisar de mais de 100 solicitações simultâneas, converse com seu representante de conta sobre aumentar o limite para sua unidade de negócios. Aprovações especiais são necessárias.
    • Em fila Contagem: Quando as solicitações excedem o limite, as solicitações extras entram em uma fila de processamento. Quando as solicitações ficam abaixo do limite, as solicitações enfileiradas são processadas.
  • Circuit Breaker: If your specified URL is down or unreachable, you can get too many failures on your request. When this happens, NiCE CXone will reduce request execution of ALL URLs from the REST API action for a period of time. This allows your specified URL to recover from the failure. Limits are identified below:
    • Taxa de transferência MÍNIMA: 100 solicitações em 30 segundos. uma vez atingido esse limite, a taxa de falha é considerada. Se sua unidade de negócios não estiver executando o número mínimo de solicitações, ela continuará executando solicitações mesmo que estejam falhando.
    • Taxa de falha: Quando o limite mínimo de taxa de transferência é atingido, se pelo menos 50% das solicitações falharem durante 30 segundos, o tempo de espera é acionado. Os 30 segundos é uma janela rolante.
    • Tempo de Recuo ou Duração da pausa: Se o throughput mínimo e a taxa de falha forem atingidos, nenhuma solicitação da ação REST API será executada por 30 segundos.

Outras dependências desta ação são:

  • JSON é o único formato de resposta suportado. A ação exige que todo o JSON esteja em uma única linha. Ao trabalhar com JSON nesta ação, você pode:

    • Fazer uma substituição de variável de uma string que contém JSON.
    • Converter um objeto de dados dinâmicos em JSON é suportado usando a função asjson(). Observe que a função asjson() trata tudo como uma string, o que significa que alguma manipulação é necessária ao trabalhar com valores booleanos ou numéricos.
    • Passe também a variável de saída resultSet(out) de uma ação anterior da API REST para esta propriedade.
  • Respostas são retornadas como objetos jtoken. Você pode trabalhar com elas como faria com objetos de dados dinâmicos no seu script.
  • Respostas contêm cabeçalhos e o corpo da resposta. Elas também podem conter códigos de status HTTP. Nem todas as respostas incluirão códigos de status. Se não houver erro, se a ação REST API falhar ao gerar uma resposta válida, ou se o erro retornado não puder ser interpretado como uma resposta válida, nenhum status será incluído.
  • Respostas contêm cabeçalhos e o corpo da resposta. Eles também incluem códigos de status HTTP em duas variáveis, __httpstatuscode e __httpstatusdescription. Essas variáveis são preenchidas com informações retornadas pelo servidor.No entanto, eles não são preenchidos se houver um erro, limite de tempo, overflow, circuito interrompido ou outra situação em que o servidor não retorne uma resposta.
  • Você pode usar mais de uma ação REST API em um script, mas elas não podem fazer referência aos mesmos objetos.

Tipos de script suportados

Um quadrado com uma linha saindo dele e indo em direção a três outros quadrados.

Icon of gray-green envelope

Ícone de balão de fala verde escuro

Icon of purple telephone handset

Ícone do símbolo de correio de voz na cor marrom-enferrujado, composto por dois círculos unidos por uma linha

Icon of pink document with lines of text

Ícone de um telefone celular verde com um balão de fala na tela

Icon of purple computer monitor with a mobile device overlapping its lower right corner

Genérico

E-mail Chat Telefone Correio de voz Item de trabalho SMS Digital

Propriedades de entrada

Estas propriedades definem dados que a ação usa durante a execução.

Propriedade

Descrição

Adicionar legenda

Insira uma frase curta que identifique exclusivamente esta ação no script. A legenda aparece na tela do script no ícone da ação.

Verb

O verbo que você deseja que esta ação use. Essa propriedade oferece suporte a ações REST básicas, como GET, PUT, POST, DELETE e PATCH.

Parâmetros

Especifique os parâmetros a incluir ou os dados a publicar como um objeto JSON de pares de chave-valor. Vários tipos de JSON são aceitos, como Jobject, Jarray ou Jtoken.

Cabeçalhos

Permite que você adicione cabeçalhos personalizados para permitir a autenticação do cliente, como tokens do portador. Você pode usar JSON neste campo.

Importante Se seu endpoint de URL customizado requer cabeçalhos diferentes, ele deve ser especificado nesta propriedade. Para manter a paridade de recursos com a ação Snippet existente, NiCE CXone adiciona os seguintes cabeçalhos por padrão:

{"Accept":"application/json", "Content-Type" :"application/x-www-form-urlencoded"}

Comando

Atualmente, a única opção é MakeRestRequest. Essa função funciona da mesma forma que a função MakeRestRequest() usada ao fazer uma Chamada de API REST em uma ação Snippet.

Tempo de espera em Milissegundos

```

Permite que um tempo limite da chamada REST seja especificado e respeitado. Deve ter menos de 90 segundos (90000 milissegundos). Se nenhum tempo limite for especificado, o padrão é 10 segundos (10000 milésimos de segundo).

```
Endereço do serviço

O URL da API REST que você quer que a ação chame. Você pode usar substituição de variável com esta propriedade. Use a propriedade Parâmetros para especificar os parâmetros de consulta a serem incluídos.

Limite de tempo

O caminho seguido se não houver resposta pelo número de segundos ou milésimos de segundo especificado na propriedade Timeout.

Propriedades de saída

As propriedades contêm variáveis que armazenam dados retornados pela execução da ação. Elas estão disponíveis para referência e uso quando a ação é concluída.

Propriedade

Descrição

Conjunto de resultado

Uma variável que contém qualquer informação retornada da API especificada no Endereço do serviço. Você pode passar o conteúdo dessa variável como está no cabeçalho e nos parâmetros, se necessário. A resposta é retornada como um objeto Jtoken, mas você pode declará-la como um objeto dinâmico e trabalhar com ela como faria com outros objetos dinâmicos em seu script.

Lista de argumento de erro

Um objeto de dados dinâmicos que contém informações sobre quaisquer erros que ocorram. Quando ocorre um erro, o objeto contém o código de status HTTP, a descrição de status e uma mensagem. Quando não há erro, o objeto fica vazio.

Códigos de status HTTP e descrições de status são retornados somente se o erro puder ser analisado adequadamente como uma resposta válida. Isso significa que nem todos os erros incluirão um código de resposta HTTP.

Condições do Ramo de resultado

As condições de ramificação de resultado permitem que você crie ramificações no seu script para tratar diferentes resultados quando uma ação é executada.

```

Condição

```

Descrição

Throttle

Caminho percorrido quando muitas solicitações são executadas dentro de um curto período de tempo. Veja as limitações abaixo para mais detalhes.

InvalidInput

Caminho percorrido se uma entrada inválida for encontrada ou ocorrer um erro de tempo limite. Cada parâmetro é validado quando o script é salvo.

Falha

Caminho percorrido quando ocorre algum erro ou exception no aplicativo NiCE CXone que executa a solicitação.

Erro

Caminho percorrido quando o terminal do cliente remoto retorna um código de erro http.

Padrão

Caminho seguido quando a resposta não é recebida em 90 segundos.

Sucesso

Caminho seguido se a ação for concluída sem erros e quaisquer Chamadas de API ou retornos de dados foram bem-sucedidos (códigos de resposta 2xx).