Índice


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.

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.




Serviços

01. No menu principal, acionar Painel de Controle.

02. No guia Gerais, acionar Serviços.

03. 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

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

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

03. Inserir as informações solicitadas.

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

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.

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

O serviço SOAP será depreciado a partir da atualização 1.6.5. A recomendação é utilizar a API REST.

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.

O campo Swagger só irá ser preenchido quando o serviço criado for do tipo Rest.

Neste campo será incluído o caminho swagger da api que será utilizada.

  • 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.

Para maiores 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, insita o endpoint get para teste de autenticação provider.

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, SQLServer ou Oracle.
  • 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.

04. Acionar Salvar.



Editar serviço

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

02. Acionar Editar, localizado no canto direito da tela, indicado pelo símbolo de lápis.

03. Alterar as informações desejadas.

04. Acionar Salvar.



Testar serviço REST

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

02. Acionar Testar serviço, localizado ao lado direito do ícone de Remover.



Testar serviço JDBC

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

02. Acionar Testar serviço, localizado ao lado direito do ícone de Remover.



Remover serviço

01. Na janela Serviços, selecionar o serviço a ser removido.

02. Acionar Remover.

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



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