Histórico da Página

Índice

outline	true
exclude	.*ndice
style	none

Falando de serviços

...

Os serviços REST 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 e testar esses os serviços. Informações Informações mais técnicas e detalhadas podem ser obtidas em Autorização para client de Serviços REST.

Caminho básico

01. No menu principal, acionar Painel de Controle.

02. Acionar a guia WCM No guia Gerais, acionar Serviços.

03. Acionar Serviços REST.04. Visualizar os serviços REST existentes.

Caminhos alternativos

Adicionar serviço REST

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 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.
Painel
Os campos destacados com um asterisco () são de preenchimento obrigatório.
Código
Código de identificação do serviço.
Domínio
Endereço correspondente ao domínio do serviço. Exemplo: http://127.0.0.1:8080.
Tipo de autenticação
Protocolo de autenticação que será utilizado pelo serviço. As opções disponíveis são:
OAuth 1;
OAuth 2;
Basic.
Consumer key
Chave para acesso ao serviço. Esse campo somente é exibido quando a opção selecionada no campo Tipo de autenticação for "Rest OAuth 1".
Consumer secret
Chave secreta para acesso ao serviço. Esse campo somente é exibido quando a opção selecionada no campo Tipo de autenticação for "Rest OAuth 1".
Token* de acesso
Token de acesso ao serviço. Esse campo somente é exibido quando a opção selecionada no campo Tipo de autenticação for "Rest OAuth 1" ou "Rest OAuth 2".
Token secreto
Token secreto de acesso ao serviço. Esse campo somente é exibido quando a opção selecionada no campo Tipo de autenticação for "Rest OAuth 1".
**URL token de acesso**
URL para o token de acesso ao provedor. Esse campo somente é exibido quando a opção selecionada no campo Tipo de autenticação for "Rest OAuth 1".
URL solicitação de token
URL para o token de requisição ao provedor. Esse campo somente é exibido quando a opção selecionada no campo Tipo de autenticação for "Rest OAuth 1".
URL autorização de usuário
URL para autorização de acesso do usuário ao provedor. Esse campo somente é exibido quando a opção selecionada no campo Tipo de autenticação for "Rest OAuth 1".
Id cliente
Chave única do cliente. Esse campo somente é exibido quando a opção selecionada no campo Tipo de autenticação for "Rest OAuth 2".
Client secret
Chave secreta do cliente. Esse campo somente é exibido quando a opção selecionada no campo Tipo de autenticação for "Rest OAuth 2".
Refresh token
Chave para atualização do token. Esse campo somente é exibido quando a opção selecionada no campo Tipo de autenticação for "Rest OAuth 2".
URL refresh token
URL para atualização do token. Esse campo somente é exibido quando a opção selecionada no campo Tipo de autenticação for "Rest OAuth 2".
Usuário
Usuário que será enviado no cabeçalho da requisição.
Senha
Senha que será enviada no cabeçalho da requisição.
Confirmação da senha
Confirmação da senha que será enviada no cabeçalho da requisição.
URL para teste de serviço
Endpoint GET para testar autenticação de acesso ao provedor.
03. Acionar Salvar.

Editar serviço REST

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

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.
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: Custom, Basic, None, Rest oauth 1, Rest oauth 2.
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:
Senha:

04. Acionar Salvar.

Editar serviço

01. Na janela Serviços

01. Na janela Serviços REST, 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.

PainelMais detalhes sobre os campos exibidos podem ser obtidos no caminho Adicionar serviço REST

.

04. Acionar Salvar.

Remover serviço

REST

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

02. Acionar Remover.

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

Testar serviço REST

01. Na janela Serviços REST, selecionar o serviço que se deseja testar.

02. Acionar Testar serviço.

03. Na janela exibida, acionar Testar serviço novamente.

...

do serviço.

...

Informações

title	Fique atento!

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

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 6

Nova versão 7

Chave