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, configurar e testar esses serviços. Informações mais técnicas e detalhadas podem ser obtidas em Autorização para client de Serviços REST.
01. No menu principal, acionar Painel de Controle.
02. Acionar a guia WCM.
03. Acionar Serviços REST.
04. Visualizar os serviços REST existentes.
01. Na janela Serviços REST, acionar Adicionar.
02. Inserir as informações solicitadas.
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:
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.
01. Na janela Serviços REST, selecionar o serviço a ser editado.
02. Acionar Editar.
03. Alterar as informações desejadas.
Mais detalhes sobre os campos exibidos podem ser obtidos no caminho Adicionar serviço REST. |
04. Acionar Salvar.
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.
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.
04. Visualizar o resultado no quadro Retorno do teste, que é exibido após a finalização do teste do serviço.
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. |