TOTVS Fluig

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Denise De Deus

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Samara Buettgen

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Ajuste do espaçamento e dos painéis

Índice

Índice
outlinetrue
exclude.*ndice
stylenone


Falando de serviços

...

...

Os serviços permitem acessar com segurança recursos e serviços externos à plataforma, utilizando os protocolos de autenticação OAuth 1, OAuth 2 e Basic authentication. ....

 

Caminho básico

Nesse recurso é possível cadastrar e configurar os serviços. Informações mais técnicas e detalhadas podem ser obtidas em Autorização para client de Serviços REST.


Image Added


Serviços

...

...

01. No menu principal, acionar Painel de Controle, logo depois verificar o agrupador Desenvolvimento e acionar Serviços.

02. Acionar a guia WCM.

03. Acionar Serviços REST.

04. Visualizar os rerviços REST existentes.

 

Caminhos alternativos

 

Adicionar serviço REST

Visualizar os serviços existentes.


Filtrar por tipo

...

01. Selecione o(s) tipo(s) de serviço(s) que deseja visualizar: SOAP, JDBC ou REST.

02. Os dados do(s) filtro(s) escolhido(s) serão listados abaixo.


Adicionar serviço

...

Image Added Visualize o passo a passo 


01. Na janela Serviços REST, acionar Adicionar Novo serviço.

02. Selecione o tipo de serviço que deseja adicionar: SOAP, JDBC ou REST.

03. Inserir as informações solicitadas.

04. Após realizar todas as configurações citadas abaixo, acionar Salvar

Painel
borderColor#f2f2f2
bgColor#f2f2f2
Expandir
titleSaiba mais

Os campos destacados com um asterisco (*) são de preenchimento obrigatório.

Código

 

Domínio

 

Tipo de autenticação

 

URL para teste de serviço

03. Acionar Salvar.

Editar serviço REST

Deck of Cards
historyfalse
idservico
Card
id1
labelSOAP

Ao selecionar o tipo SOAP, os campos a serem preenchidos são:

  • Nome: neste campo, adicione um nome para o serviço que deseja cadastrar.
  • Descrição: neste campo, adicione uma descrição para o serviço.
  • URL: neste campo, adicione a URL do webservice que deseja utilizar.
  • Arquivo de binding: Somente será utilizado o arquivo de binding para serviços criados utilizando a API CXF. Para incluir, basta acionar Escolher arquivo no campo Arquivo de Binding e incluir.
Painel
borderColor#f2f2f2
bgColor#f2f2f2

Mais detalhes referente a binding, você encontra na nossa documentação técnica de Integração com Aplicativos Externos.

Card
id2
labelREST

Ao selecionar o tipo REST, os campos a serem preenchidos são:

  • Nome: neste campo, adicione um nome para o serviço que deseja cadastrar.
  • Descrição: neste campo, adicione uma descrição para o serviço.
  • Swagger: neste campo, adicione um endereço para um arquivo no formato JSON.
Painel
borderColor#f2f2f2
bgColor#f2f2f2

O campo Swagger só será preenchido quando o serviço criado for do tipo REST. Neste campo será incluído o caminho swagger da API que será utilizada. Image Added Veja a imagem

  • Domínio: neste campo, adicione o domínio do serviço.
  • Tipo de autenticação: neste campo, selecione o tipo de autenticação que deseja:
    • None.
    • Rest oauth 1.
    • Rest oauth 2.
    • Custom.
    • Basic.
Painel
borderColor#f2f2f2
bgColor#f2f2f2

Para mais detalhes de como preencher corretamente as configurações de autenticação, acesse a documentação técnica Fluig API.

  • URL para teste de serviço: neste campo, insira o endpoint GET para teste de autenticação provider.
Card
id3
labelJDBC

Ao selecionar o tipo JDBC, os campos a serem preenchidos são:

  • Nome: neste campo, adicione um nome para o serviço que deseja cadastrar.
  • Descrição: neste campo, adicione uma descrição para o serviço.
  • Driver: neste campo, será selecionado o driver desejado: MySQL, SQL Server ou Oracle. Após a gravação do serviço, o driver não pode ser editado.
  • URL: neste campo, adicione a URL do webservice que deseja utilizar.
  • Usuário: usuário de acesso ao banco de dados.
  • Senha: senha de acesso ao banco de dados.

Editar

...

01. Na janela Serviços REST, selecionar localizar o serviço a ser editado.

02.  No íconeImage Addedclicar na opção Editar;

03. Alterar Acionar inserir as informações solicitadasdesejadas.

03. Inserir as informações solicitadas.

Expandir
titleSaiba mais

 

03. Acionar Salvar.

Remover serviço REST

 

01. Na janela Serviços REST, acionar Adicionar.

02. Inserir as informações solicitadas.

Expandir
titleSaiba mais

 

03. Acionar Salvar.

 

Testar serviço REST

 

01. Na janela Serviços REST, acionar Adicionar.

02. Inserir as informações solicitadas.

Expandir
titleSaiba mais

 

03. Acionar Salvar.

 

 

04. Acionar Salvar para confirmar as alterações.


Testar serviço

01. Na janela Serviços, localizar o serviço a ser testado.

02. Na coluna Opções, acionar o botão Testar serviçoImage Added .

03. Acionar a opção Testar Serviço.

Painel
borderColor#f2f2f2
bgColor#f2f2f2

O teste só é realizado para serviços REST ou JDBC. A janela de Testar serviço irá apresentar um campo contendo o retorno do teste, em caso de sucesso ou erro.


Configurar log

01. Na janela Serviços, localizar o serviço que deseja configurar o log.

02. No íconeImage Addedclicar na opção Configurar log;

03. Na janela apresentada, definir o botão como ON para ativar a configuração de log.

04. Após ativar o botão é preciso definir o tempo de expiração do log. Podendo ser definido em horas entre 1 hora até 24 horas.

05. Acionar Salvar para confirmar a configuração do log.

Painel
borderColor#f2f2f2
bgColor#f2f2f2

Com o log habilitado, será apresentada a quantidade de requisições realizadas pelo serviço específico.


Excluir serviço

01. Na janela Serviços, localizar o serviço a ser excluído.

02. No íconeImage Addedclicar na opção Excluir log;

03. Na mensagem exibida, acionar Sim, remover o serviço para efetivar a remoção.


Fazer download do log

...

01. Na janela Serviços, acionar o botão Download do log.

Painel
borderColor#f2f2f2
bgColor#f2f2f2

Ao acionar essa opção, é possível baixar o arquivo de log do servidor, apresentando os erros que ocorreram na integração com algum sistema externo.




Informações
titleFique atento!

Esta documentação é válida a partir da atualização 1.8.1 - Silver Mist. Se você utiliza uma atualização anterior, ela pode conter informações diferentes das quais você vê na sua plataforma.

...