Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Para direcionar-se ao cadastro do Serviços RESTacesse no fluig o menu Painel de Controle, aba WCM, opção Serviços REST. O recursoprovê recursos para inclusão, alteração, exclusão, consulta e teste dos client's.

Image RemovedImage Added

 

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.

...

Nota
titleMétodos HTTP Suportados

Para tipo de autorização OAuth 1, os métodos http disponíveis são: PUT, POST, GET, DELETE. 
Para tipo de autorização OAuth 2, os métodos http disponíveis são: PUT, POST, GET, DELETE, PATCH.
Para tipo de autorização Basic, os métodos http disponíveis são: PUT, POST, GET, DELETE, PATCH. 

 

...

Deck of Cards
effectDuration0.5
historyfalse
idsamples
effectTypefade
Card
defaulttrue
id1
labelOAuth 1

 

  • Cadastro de client com autorização OAuth 1, informar os campos:

    1. Código do Serviço (Obrigatório)
    2. Domínio (Obrigatório)
    3. Tipo de Autenticação (Obrigatório)
    4. Consumer Key (Obrigatório)
    5. Consumer Secret (Obrigatório)
    6. Access Token (Obrigatório)
    7. Secret Token (Obrigatório)
    8. URL para o Access Token (Obrigatório)
    9. URL para o Request Token (Obrigatório)
    10. URL para Autorização (Obrigatório)
    11. URL GET para test da autenticação do serviço (Opcional)

 

Image ModifiedImage Modified

 

 

Card
id2
labelOAuth 2

 

  •  Cadastro de client com autorização OAuth 2, informar os campos:

...

    1. Código do Serviço (Obrigatório)
    2. Domínio (Obrigatório)
    3. Tipo de Autenticação (Obrigatório)
    4. Id Cliente (Obrigatório)
    5. Client Secret (Obrigatório)
    6. Token de Acesso (Obrigatório)
    7. Refresh token (apenas se o Serviço disponibilizar)
    8. URL refresh token (apenas se o Serviço disponibilizar)
    9. URL GET para test da autenticação do serviço (Opcional)

Image ModifiedImage Modified

...

Card
id3
labelBasic Authentication

 

  • Cadastro de client com autorização Basic Authentication, informar os campos:

...

    1. Código do Serviço (Obrigatório)
    2. Domínio (Obrigatório)
    3. Tipo de Autenticação (Obrigatório)
    4. Usuário (Obrigatório)
    5. Senha (Obrigatório)
    6. Confirmação da Senha (Obrigatório)
    7. URL GET para test da autenticação do serviço (Opcional)

Image Modified

 

 

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 funcionalidadedo recurso.

Image Modified

Image Modified

Image Modified

 

 

Consumindo o serviço com autenticação OAuth 1, OAuth 2, Basic Authentication

...

  • Para consumo do serviço à partir para desenvolvimento de um processo de workflow (que podem ser encontrados aqui) e customização deve ser informado workflow ou de desenvolvimento sobre a plataforma deve-se informar os seguintes parâmetros no javascript.

    Nota
    titleComo 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: 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 : Método http do serviço).
    • params (parametros : Parâmetros em formato JSON para envio ao serviço).
  • Exemplo de chamada aos serviços com http method POST

    Bloco de código
    languagejs
    themeEclipse
    titleExemplo de chamada no Java Script da customizção
    	try{
    		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'                                     
    			}                                                       
    		}                                                           
    		var vo = clientService.invoke(JSON.stringify(data));
    
    		if(vo.getResult()== null || vo.getResult().isEmpty()){
    			throw new Exception("Retorno está vazio"); 
    		}else{
    			log.info(vo.getResult());
    		}
    	} catch(err) {
    		throw new Exception(err); 
    	}
     
    Nota
    titleRetorno

    A chamada "clientService.invoke(JSON.stringify(data)); " retorna um objeto com os objetos abaixo:

    • serviceCode (: Chave única cadastrada).
    • description (Traz : Informa o serviceCode e se teve obteve sucesso ou não. Ex: "google:SUCCESS").
    • endopint (endpoint : Endpoint chamado).
    • result (string : String com o resultado retornado).
    • method (método : Método http do serviço).
    • strParams (paramêtros : Paramêtros em formtao formato String).
    • params (paramêtros em formato : Paramêtros em formato Map<String, Object> utilizados).
     

Chamada via componente SDK

O recurso para consumo do serviço externo também está disponível no componente SDK através do AuthorizeClientSdkService.

Veja a seguir o exemplo para a chamado ao serviço no SDK:

Bloco de código
languagejava
themeEclipse
private getAuthorizeClientSdkService getAuthorizeClientSdkService() throws SDKException {
	return new FluigAPI().getAuthorizeClientSdkService();
}

...