Histórico da Página
Índice
Índice | ||||||
---|---|---|---|---|---|---|
|
Objetivo
Para acessar com segurança recursos e serviços externos ao fluig à partir de processos de workflow (que podem ser encontrados aqui) ou customizações, pode-se utilizar a funcionalidade do Authorize Client no Fluig. Essa funcionalidade consiste em um cadastro de configurações de acesso e segurança do serviço externo a ser invocado, ou seja, para cada caso de protocolo de segurança sendo OAuth 1, OAuth 2 ou Basic Authentication, serão informados e cadastrados os token's de acesso, chaves, usuário, senha, etc.
Cadastro de Client para chamada a Serviços externos.
Para acesso ao cadastro do Authorize Client, acessar no Fluig o menu Painel de Controle, aba WCM, opção Authorize Client. A funcionalidade provê recursos para inclusão, alteração, exclusão, consulta e teste dos client's.
Dependendo do client de serviço a ser cadastrado, pode-se utilizar mecanismos de autenticação distintos, como OAuth 1, OAuth 2 ou Basic Authentication, para cada caso serão obrigatórias informações específicas para cada protocolo.
Para o OAuth 2 utilizamos a autenticação do tipo Baerer.
Nota | ||
---|---|---|
| ||
Para tipo de autorização OAuth 1, os métodos http disponíveis são: PUT, POST, GET, DELETE. |
...
Cadastro de client com autorização OAuth 1, informar os campos:
- Código do Serviço (Obrigatório)
- Domínio (Obrigatório)
- Tipo de Autenticação (Obrigatório)
- Consumer Key (Obrigatório)
- Consumer Secret (Obrigatório)
- Access Token (Obrigatório)
- Secret Token (Obrigatório)
- URL para o Access Token (Obrigatório)
- URL para o Request Token (Obrigatório)
- URL para Autorização (Obrigatório)
- URL GET para test da autenticação do serviço (Opcional)
Cadastro de client com autorização OAuth 2, informar os campos:
- Código do Serviço (Obrigatório)
- Domínio (Obrigatório)
- Tipo de Autenticação (Obrigatório)
- Id Cliente (Obrigatório)
- Client Secret (Obrigatório)
- Token de Acesso (Obrigatório)
- Refresh token (apenas se o Serviço disponibilizar)
- URL refresh token (apenas se o Serviço disponibilizar)
- URL GET para test da autenticação do serviço (Opcional)
Cadastro de client com autorização Basic Authentication, informar os campos:
- Código do Serviço (Obrigatório)
- Domínio (Obrigatório)
- Tipo de Autenticação (Obrigatório)
- Usuário (Obrigatório)
- Senha (Obrigatório)
- Confirmação da Senha (Obrigatório)
- URL GET para test da autenticação do serviço (Opcional)
Testando configurações de Autorização do Client cadastrado.
Após o cadastro do Client, é possível testar as configurações de acesso utilizando o endpoint GET cadastrado. Basta selecionar o client e clicar no link Testar Serviço na pagina principal da funcionalidade.
Consumindo o Serviço com autenticação OAuth 1, OAuth 2, Basic Authentication.
Chamada via javascript
Para consumo do serviço à partir de um processo de workflow (que podem ser encontrados aqui) e customização deve ser informado os seguintes parâmetros no javascript.
Nota title Como montar os parâmetros Para envio dos parâmetros no JSON, é obrigatório utilizar o nome das chaves conforme descrito abaixo.
- serviceCode (Chave única cadastrada)
- endopint (endpoint que será chamado)
- Para endpoint's que recebem QueryParam e PathParam, os parâmetro devem ser incluídos diretamente no endpoint. (endpoint : '/api/public/2.0/users/create?queryParam=exemple',)
- method (método http do serviço)
- params (parametros em formato JSON para envio ao serviço)
Exemplo de chamada aos serviços com http method POST
Bloco de código language js theme Eclipse title Exemplo de chamada no Java Script da customizção var clientService = fluigAPI.getAuthorizeClientService(); var data = { serviceCode : 'bamboo', endpoint : '/api/public/2.0/users/create', method : 'post',// 'delete', 'patch', 'put', 'get' params : { login : 'authorize.client', email : '[email protected]', code : 'authorize.client', firstName : 'authorize', lastName : 'client', fullName : 'authorize client', password : '123', extData :{ 'addicional-data':'123456' } } } // OU var data = { serviceCode : 'google', endpoint : '/userinfo/v2/me', method : 'get' } // OU var data = { serviceCode : 'fluig-local-basic', endpoint : '/api/public/2.0/testauthorizeclient/put', method : 'put', // 'delete', 'patch', 'post', 'get' params : { teste : 'teste' } } clientService.invoke(JSON.stringify(data));
Chamada via componente SDK
O recurso para consumo do serviço externo também está disponível no componente SDK através do AuthorizeClientSdkService
...