Configurando Webservice no Script de Automação

267 Visualizações
3, outubro de 2023
Júlia Santos

Os WebServices são uma técnica vantajosa para a troca de dados e consumo de serviços via Web.

Este documento tem como objetivo descrever as instruções de configuração de um Webservice para consumo de dados no script de automação na solução Tactium Omnichannel.

Declarando os parâmetros do webservice

Para consumir um Webservice no script de automação, realizamos o cadastro de uma Função Externa     .

Após o cadastro, esta função poderá ser executada na árvore de atendimento a partir de uma Ação Externa.

 

Nome

Nome para identificação da Função Externa

Formato

Formato do método (API/REST)

Requerimento

Método de chamada do Webservice (GET/POST)

URL

Url para chamada do método

Tipo de Autorização

Autorização utilizada na chamada do método. (Basic Auth/Bearer Token). Caso sem autenticação, não preencher.

Formato Corpo da Requisição

Formato do corpo dos parâmetros (Formulário/Json)

Validar Código de Status?

Parâmetro para habilitar o tratamento do formato JSON em requisições com retorno diferente de sucesso (200)

Com a finalização do preenchimento dos campos acima, clique em      para confirmar e iniciar o cadastro dos parâmetros.

O cadastramento é realizado a partir do detalhamento dos parâmetros (variáveis) de entrada e saída utilizados na chamada do método.

Parâmetros de Entrada e Saída

A inserção dos parâmetros deve ocorrer de acordo com a ordem de declaração, veja o exemplo de método abaixo:

Para realizar a chamada deste método é necessário cadastrar todas as variáveis de entrada e saída para conseguirmos consumir e alimentar as informações que serão utilizadas no script.

Declarando as variáveis no script

A declaração de variáveis para o script de automação são realizadas no cadastro de Variáveis do Script  .

Após o cadastro das variáveis podemos defini-las dentro do cadastro da webservices.

Ao clicar no botão selecione a opção “Novo” para realizar o cadastro das variáveis.

Na tela de “Cadastrar Variável” temos os seguintes campos para preenchermos:

  • Nome: Nome da variável de acordo com o método webservice;
  • Tipo:  Tipo da Variável(Em Default: Texto Curto);
  • Descrição: Descrição da Variável(Recomenda-se repetir o nome da variável)

Exemplo:

Após cadastrar todas as variáveis de entrada e\ou saída temos que declara-las dentro do cadastro da webservices na Função Externa .

Declarando Variáveis e Parâmetros no Cadastro de Webservice

Após cadastrar as variáveis no devemos atribui-los aos parâmetros do webservice de acordo com sua declaração. Dentro do “Cadastrar Webservices e Procedures” após definirmos todos os campos para cadastrar a Webservice no botão devemos cadastrar os parâmetros.

No cadastro de um novo parâmetro temos os seguintes campos:

  • Nome Parâmetro: Nome do parâmetro conforme seu retorno ou entrada na API;
  • Tipo Parâmetro: Tipo do parâmetro Entrada ou Saída;
  • Sequência: Sequencia de Entrada ou Saída do Parâmetro de acordo com a API;
  • Variável: Variável cadastrada anteriormente que se refere ao parâmetro;
  • Local Parâmetro: Caso o parâmetro seja de Entrada ele pode se localizar:
    • Corpo da Requisição: Se localiza no corpo da Api;
    • Cabeçalho da Requisição: Se localiza no cabeçalho;
    • Url da Requisição: Quando o parâmetro se localiza na URL da chamada da API.

Variáveis e Parâmetros Segundo, Terceiro(…) Nível

Na declaração para leitura de variáveis (filho) dentro de outras variáveis (mãe) iremos utilizar o método abaixo como exemplo para declaração:

Para a leitura das propriedades retornadas pela FilhoVariável devem ser utilizadas as notações de ponto.

.

A notação de pontos permite acessar uma variável em outra.

Dito isto, para declarar variáveis dentro de outras e conseguir consumir os dados corretamente, devemos preencher a nomenclatura do “Nome Parâmetro” na Função Externa da seguinte forma: Variável.FilhoVariável.

Sendo necessário, segundo o exemplo acima, para obter o retorno da variável “Token”:  “Lzv(…)” basta preencher o parâmetro como : “dados.token”.

Variáveis e Parâmetros de Array

A declaração de variáveis com Array iremos utilizar o método abaixo como exemplo para declaração:

Dito isto, para declarar variáveis com Array e conseguir consumir os dados corretamente, devemos cadastrar a variável e preencher o “Nome” no cadastro de variável e nomenclatura do “Nome Parâmetro” na Função Externa da seguinte forma: Variável[Índice].Variável.

Para a leitura das propriedades retornadas pelo Array devem ser utilizadas as notações de ponto e notações de colchetes.

[ ]

A notação de colchetes permite acessar variáveis com Array, onde dentro deste colocamos o índice desejado. (Este sempre se inicia em 0 (zero) )

.

A notação de pontos. Permite acessar uma variável em outra.

 

Sendo necessário, segundo o exemplo acima, para obter o retorno da variável “Nome”:  “Maria” colocar o nome da variável e parâmetro sendo: “pessoas[1].nome”.



Este conteúdo foi útil para você?
100% LikesVS
0% Dislikes

Index