Árvore de páginas

Versões comparadas

Chave

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

...

Para exibir o cadastro de Serviços RESTacesse no fluig o menu Painel de Controle, aba WCM, opção Serviços REST. O recurso contém opções para inclusão, alteração, exclusão, consulta e teste dos clients.

Image Modified

 

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 tipo de autenticação existem informações específicas, que deverão ser preenchidas.

...

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

 

  • Para cadastrar client com o tipo de autorização OAuth 1, informar os campos:

 

CampoCondição
Código do ServiçoObrigatório
DomínioObrigatório
Tipo de AutenticaçãoObrigatório
Consumer KeyObrigatório
Consumer SecretObrigatório
Access Token de acesso
Obrigatório
Secret Token secreto
Obrigatório
URL Token de acesso
Obrigatório
URL solicitação de TokenObrigatório
URL Autorização de UsuárioObrigatório
URL para teste de ServiçoOpcional

 

 

 

 

Nota

 

  • Para
o OAuth 2 utilizamos a autenticação do tipo Baerer.

 

 

 Cadastro de client com
  • cadastrar client com o tipo de autorização OAuth 2, informar os campos:
Card
id2
labelOAuth 2
info

 

title
CampoCondição
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)(
Obrigatório
Refresh TokenApenas se disponibilizado pelo Serviço
Token de
Acesso
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)
  • URL Refresh TokenApenas se disponibilizado pelo Serviço
    URL para teste de ServiçoOpcional

     

     

    Informações
    titleNota

    Para o OAuth 2 utilizamos a autenticação do tipo Baerer.

     

     

    Image Added

     

    Image Added

     

     

    Image RemovedImage Removed

    Card
    id3
    labelBasic Authentication

     

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

     

    CampoCondição
    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 (
    SenhaObrigatório
    )
    URL
    GET
    para
    test da autenticação do serviço (Opcional)
    teste do ServiçoOpcional

     

    Image Added

     Image Removed

     

    Testando configurações de autorização do

    ...

    client cadastrado

    Após o cadastro do Client client, é possível testar as configurações de acesso utilizando o endpoint GET a URL para teste do Serviço (Endpoint GET) cadastrado. Basta selecionar o client e clicar no link botão Testar Serviço na pagina principal do recurso.

    Image Removed

    Image Removed

    ...

    :

    Image Added

     

     

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

    Chamada via

    ...

    Javascript

    • Para consumo do serviço à a partir para do desenvolvimento de workflow workflows ou de desenvolvimento sobre a plataforma, deve-se informar os seguintes parâmetros no javascript.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.
      • endpoint: Endpoint que será chamado.
      Informações

      Para endpoint's que recebem QueryParam e PathParam, os

      parâmetro

      parâmetros devem ser incluídos diretamente no endpoint. (endpoint : '/api/public/2.0/users/create?queryParam=exemple',)

      • method: Método http HTTP do serviço.
      • params: Parâmetros em formato JSON para envio ao serviço.
    • Exemplo de chamada aos serviços com http 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: Informa o serviceCode e se obteve sucesso. Ex: "google:SUCCESS".
      • endopint: Endpoint chamado.
      • result: String com o resultado retornado.
      • method: Método http do serviço.
      • strParams: Paramêtros Parâmetros em formato String.
      • params: Paramêtros Parâmetros em formato Map<String, Object> Map<String, Object> utilizados.
       

    Chamada via componente SDK

    ...

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

     

    ...