Scripts e APIs

É possível se conectar a serviços da web com scripts do Studio que usam padrões SOAP ou API RESTful. Você pode se conectar com os seguintes métodos:

  • Ação REST API do Studio
  • Integration Hub
  • Ações de API do Studio
  • Integrações de fluxo de trabalho CRM

 

Serviços web RESTful

É possível usar scripts do Studio para conectar com APIs RESTful usando o proxy REST em uma ação Snippet. Você pode acessar este serviço com a função GetRestProxy(). O proxy REST permite que seus scripts interajam com servidores web remotos. Ele fornece algumas propriedades e funções que você pode usar para isso.

O proxy REST exige o uso de objetos de dados dinâmicos. O tipo de dados dinâmicos permite que seus scripts trabalhem com respostas formatadas em XML e JSON. Objetos de dados dinâmicos podem receber dados nestes formatos e permitir sua leitura. Você também pode criar objetos dinamicamente que podem ser convertidos em XML ou JSON. Essas habilidades são necessárias para o uso de APIs RESTful.

Para usar o proxy REST, adicione uma ação Snippet ao seu script e abra a janela Snippet Editor . Invoque a função GetRESTProxy() usando a seguinte sintaxe.

ASSIGN proxy = GetRESTProxy() 
 proxy.<property | function>([parameters]) 

Para <property | function>, escolha a partir das propriedades e funções descritas nas seguintes seções.

Propriedades

Propriedade Detalhes
StatusCode Contém o código de status HTTP após uma chamada para MakeRestRequest(). Esta propriedade não pode ser modificada. Se a função falhar, ela não armazenará mais o código de status.
StatusDescription Contém a descrição do status HTTP após uma chamada para MakeRestRequest(). Esta propriedade não pode ser modificada.
ContentType

Permite que você substitua o cabeçalho do tipo de conteúdo padrão. O padrão é application/x-www-form-urlencoded.

Dependendo da chamada que está fazendo, pode ser preciso alterar o cabeçalho. Por exemplo, se estiver enviando JSON, altere isso para application/json. É necessário alterar esta propriedade.

ProxyTimeoutSeconds Permite que você altere o tempo limite da solicitação. O padrão é 10 segundos. é necessário alterar esta propriedade.

Funções

A tabela a seguir fornece informações sobre as funções disponíveis para uso ao se conectar a APIs RESTful. Há outras funções de proxy REST que permitem que você codifique e misture strings.

Função Detalhes
MakeRestRequest(URL) Executa uma solicitação HTTP para o URL designado.
AddHeader Adiciona um cabeçalho personalizado à solicitação HTTP.
ClearHeaders Limpa todos os cabeçalhos personalizados adicionados com AddHeader.

Exemplos

ASSIGN proxy = GetRESTProxy()
ASSIGN proxy.ContentType = "application/json"
ASSIGN url = "https://catfact.ninja/fact"
ASSIGN verb = "GET"
ASSIGN result = proxy.MakeRestRequest(url,payload,'JSON',verb)

 

ASSIGN restProxy=GetRESTProxy()

restProxy.AddHeader("x-api-key", "qwer") //Assigning incorrect header for demonstration purposes
restProxy.ClearHeaders()
restProxy.AddHeader("x-api-key", "asdf")
ASSIGN restProxy.ProxyTimeoutSeconds = "2"
ASSIGN restProxy.ContentType = "application/json"

ASSIGN uri = "http://postman-echo.com/post"

DYNAMIC beowulfCharacteristics
ASSIGN beowulfCharacteristics.name = "Beowulf"
ASSIGN beowulfCharacteristics.occupation= "Hero" 
ASSIGN beowulfCharacteristics.foe = "Grendel"
ASSIGN payloadJSON = "{beowulfCharacteristics.asJSON()}

Serviços web SOAP

Você pode usar serviços da web baseados em SOAP com scripts do Studio. Para isso, é preciso importar um WSDL ou Proxy DLL para o Studio. O DLL importado precisa ser autorizado pela NICE CXone. Após a autorização do DLL, ele é salvo na raiz do armazenamento de arquivo da sua unidade de negóciosFechado Alto nível de agrupamento organizacional usado para gerenciar o suporte técnico, cobrança e configurações globais para o seu ambiente CXone .

Usar serviços web SOAP exige assistência da NICE CXone. Entre em contato com o seu Representante de Contas do CXone para maiores informações.

Usar SOAP em um Snippet

Quando quiser usar um serviço web baseado em SOAP em um script do Studio, é preciso criar um snippet. Adicione uma ação Snippet ao seu script. Na janela do editor snippet, adicione uma instrução USES que nomeia o arquivo de proxy DLL que você gerou e armazenou no armazenamento de arquivo da sua unidade de negóciosFechado Alto nível de agrupamento organizacional usado para gerenciar o suporte técnico, cobrança e configurações globais para o seu ambiente CXone .

O snippet a seguir é um exemplo de uso de um serviço da web baseado em SOAP com um script do Studio.

USES "sf.dll"
cStart="{now}"
sforce=new SforceService()
session=new SessionHeader()
loginResult=sforce.login("demo@nice.com",password6")
sforce.sessionheadervalue=session
session.sessionid=loginResult.sessionid
sforce.url=loginresult.serverUrl

t=new Task()
t.ActivityDate=#"8/20/2050"
t.Description="Call placed by {first }{Last}."
t.Subject="Call @{cStart}"
t.Status="Completed"
t.CallType="Outbound"
t.OwnerId=SF_Agent_ID
t.ReminderDateTime="{cStart}"

SWITCH Type
{
   CASE "CON" { t.WhoId=SF_Obj_ID }
   CASE "LEA" { t.WhoId=SF_Obj_ID }
   CASE "ACC" { t.WhatId=SF_Obj_ID }
   CASE "OPP" { t.WhatId=SF_Obj_ID }
   CASE "CAS" { t.WhatId=SF_Obj_ID }
}
SaveResult=sforce.create(t)