Histórico da Página
...
Para direcionar-se ao cadastro do Serviços REST, acesse 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.
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 | ||
---|---|---|
| ||
Para tipo de autorização OAuth 1, os métodos http disponíveis são: PUT, POST, GET, DELETE. |
...
Deck of Cards | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
...
|
...
|
...
|
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.
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 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: 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 language js theme Eclipse title Exemplo 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 title Retorno 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 | ||||
---|---|---|---|---|
| ||||
private getAuthorizeClientSdkService getAuthorizeClientSdkService() throws SDKException { return new FluigAPI().getAuthorizeClientSdkService(); } |
...