Informações

title	Atenção

Esta página foi revisada para considerar as novas configurações de server do fluig para a do TOTVS Fluig Plataforma a partir da atualização 1.6.

Caso possua uma atualização anterior do fluig acesse: DES 069 - Fluig API.

Índice

outline	true
exclude	.*ndice
style	none

...

Este documento é direcionado a desenvolvedores, clientes e parceiros que desejam criar aplicações e recursos externos ou internos ao fluig. O fluig possui uma API Pública com os principais serviços disponíveis na plataforma, bem como um componente interno (fluig-sdk-api.jar) que pode ser importado e utilizado para chamadas dos serviços no mesmo contexto do fluig. A API disponibiliza uma documentação de classes e interfaces no padrão Java Doc que pode ser encontrada aqui.

Através da API é possível criar mensagens em nome do usuário, adicionar um contato como favorito, criar artigos e muito mais. Para que aplicativos possam atuar em nome do usuário a autorização é realizada através do protocolo OAuth, e caso o serviço seja utilizado pelo componente interno, é injetado o EJB para execução dos serviços.

Pré requisitos

...

São pré requisitos básicos ter conhecimento sobre:

Desenvolvimentos de API REST
Padrão OAuth

API

...

API, de Application Programming Interface (Interface de Programação de Aplicativos), é um conjunto de rotinas e padrões estabelecidos pelo software para que aplicativos externos possam utilizar seus recursos em suas aplicações. No fluig, a documentação da API está disponível em http://[servidor_fluig]/api ou aqui.

...

Nota

title	Observação

O fluig não é compatível com o protocolo OAuth 2.0.

Processo de autenticação

Para que um aplicativo consiga atuar no fluig em nome de um usuário ou em nome próprio é necessário que ele esteja previamente cadastrado na plataforma fluig com suas chaves pública e privada. Quando o aplicativo estiver cadastrado no fluig, é possível iniciar o processo de autenticação conforme etapas abaixo:

...

Painel

title	Consumo da API Pública em Eventos

Utilizando um objeto consumer

Para obter uma instância de consumer é necessário solicitar ao objeto de ambiente oauthUtil executando o método getNewAPIConsumer ou getNewAPIConsumerAsCurrentUser.

getNewAPIConsumer: Utilizada para solicitar um objeto de acesso com autenticação por usuário da aplicação.

getNewAPIConsumerAsCurrentUser: Utilizada para solicitar um objeto de acesso com autenticação pelo usuário logado.

IMPORTANTE: Para poder utilizar esse método você deve marcar na página do usuário aplicativo a opção "Pode agir como usuário logado em eventos customizados"

O usuário da aplicação utiliza o modo Impersonate como forma de identificação na autenticação do acesso. Esse modo Impersonate só é permitido através dos eventos customizados e não fora dele.

Para ambos os métodos descritos acima, utilizar os seguintes parâmetros:

Consumer Key
Consumer Secret
Token Access
Token Secret

Para mais informações acesse o passo Cadastrar aplicativo no fluig.

Método GET

Esse método realiza uma chamada GET na API Publica, passando como argumento uma URI válida da API .

Ex: consumer.get("/public/social/community/comunidade1");

Método POST

Esse método realiza uma chamada POST na API Publica, passando como argumento uma URI válida da API e os dados enviados em formato JSON.

Ex: consumer.post("/public/social/post/create/with/upload", "{\"text\":\"Post criado via evento\",\"visibility\":\"PUBLIC\"}");

...

Para cadastrar um aplicativo no fluig, autentique-se como um administrador e na plataforma, acompanhe os passos a seguir:

Deck of Cards

effectDuration	0.5
history	false
id	samples
effectType	fade

Card

default	true
id	1
label	Passo1

Acesse o menu Painel de controle → aba WCM → , localize o agrupador Parâmetros técnicos e acione a opção Oauth Provider.

Image Removed

Painel administrativo fluigImage Added

Card

id	2
label	Passo 2

Clique em Adicionar, preencha os campos conforme a imagem e salve.

Cadastro de provedor Oauth

Detalhes:

Campo	Exemplo
Código	01
OAuth Provider	WCM
Descrição	Aplicativo de exemplo
Acess Token URL	http://<ServerFluig>/portal/api/rest/oauth/access_token
Request Token URL	http://<ServerFluig>/portal/api/rest/oauth/request_token
User Authorization URL	http://<ServerFluig>/portal/api/rest/oauth/authorize
Request Method	GET
Signature Method	HMAC-SHA

Card

id	3
label	Passo 3

Volte para o Painel de controle e acesse agora a opção Oauth Appapplication.

Image RemovedImage Added

Clique em Adicionar, preencha os campos Consumer Key, Descrição e Consumer Secret, pois são todos campos obrigatórios, conforme imagem abaixo e salveacione Salvar:

Cadastro de aplicativo Oauth

Detalhes:

Campos	Exemplo
Consumer Key	<chave publica de seu aplicativo>
OAuth Provider	Provedor cadastrado no Passo 2
Consumer Secret	<chave secreta de seu aplicativo>

Card

id	4
label	Passo 4

Opcional: Caso seu aplicativo execute ações em nome próprio, você pode criar um usuário aplicativo.

Nota

title	Atenção

Caso a plataforma Fluig esteja configurada para autenticação utilizando o TOTVS Identity, é requerida a criação de um usuário aplicativo que será utilizado na conexão com a API.

Na mesma tela de cadastro de aplicativo OAuth existe uma ação chamada Usuário Aplicativo. Ao acessá-la poderão ser gerados tokens exclusivos para o aplicativo.

Informações

Se desejar que o usuário aplicativo execute ações em nome de outro usuário cadastrado na plataforma, basta selecionar a opção Permite Impersonalização. Selecionando este recurso, o usuário aplicativo pode, por exemplo, fazer um post em uma comunidade em nome de outro usuário, sendo apresentado da seguinte forma:

'Usuário x' fez uma publicação na comunidade, em vez de 'App X' fez uma publicação na comunidade.

Este comportamento é válido para todos métodos da API como por exemplo, publicação de documentos, movimentar processos entre outros.

Na mesma tela de cadastro de aplicativo OAuth existe uma ação chamada Usuário Aplicativo. Ao acessá-la poderão ser gerados tokens exclusivos para o aplicativo

.

Caso as ações do seu aplicativo devam ser executadas em nome de um usuário, então o aplicativo deve passar pelo processo padrão de autenticação OAuth.

Usuário aplicativo

...

View file

name	fluig-client-demo.zip
height	150

Baixe o arquivo e descompacte-o em um diretório de sua preferência.

O projeto basicamente consiste em um pom.xml xml (Project Object Model, arquivo padrão do Maven) e e uma classe Java chamada FluigClientExample. Abra a classe e verifique a documentação gerada a partir de comentários.

Você verá que é necessário construir um objeto FluigClient objeto FluigClient e este objeto recebe alguns parâmetros como host, consumer key e consumer secret. Você deve alterar os valores passados na construção para um host conhecido e informar o consumer key e secret da aplicação de sua responsabilidade, conforme o código adianteabaixo:

Bloco de código

language	java

FluigClient fluig = new FluigClient()
			.setHost("http://127.0.0.1:8080")
			.setConsumerKey("informe aqui o seu consumer key")
			.setConsumerSecret("informe aqui o seu consumer secret")
			.connect();

No caso da autenticação no Identity, também será necessário informar o Access Token e Token Secret apresentados na criação do usuário aplicativo.

Bloco de código

language	java

FluigClient fluig = new FluigClient()
			.setHost("http://127.0.0.1:8080")
			.setConsumerKey("informe aqui o seu consumer key")
			.setConsumerSecret("informe aqui o seu consumer secret")
			.setTokenAccess("informe aqui o seu Token Access")
			.setTokenSecret("informe aqui o seu Token Secret")
			.connect();

Mais abaixo no código, podemos reparar que a aplicação cria e lê posts de comunidades. Você deve informar uma comunidade válida do seu ambiente para executar a aplicação demonstração;

...

Depois de realizar as alterações, entre no diretório gerado e você notará que o arquivo pom.xml localiza-se na raiz do projeto.

...

Durante o processo de build, o Maven irá exibir vários logs , como dependências sendo baixadas dentre outros.

Depois do build finalizado com sucesso, repare que o arquivo target/api-client-demo-jar-with-dependencies.jar foi gerado. Este arquivo é um executável Java.

...

Bloco de código

language	bash

$ java -jar target/api-client-demo-jar-with-dependencies.jar

Se você reparar na classe FluigClientExampleclasse FluigClientExample, a execução irá: listar os usuários, criar uma publicação na página pessoal do usuário, criar uma publicação em uma comunidade e listar as publicações de uma comunidade. Durante a execução os logs dos resultados das chamadas serão exibidos no console.

...

Para ter acesso à documentação JAVA DOC do componente SDK, clique aqui.

Informações
Veja o exemplo (upload-file-ecm-rest) em nosso repositório aqui.

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 10

Nova versão Atual

Chave

Índice

Pré requisitos

API

Processo de autenticação

Atalhos

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 10

Nova versão Atual

Chave

Índice

Pré requisitos

API

Processo de autenticação