| Informações |
|---|
|
Esta página foi revisada para considerar as configurações do fluig TOTVS Fluig Plataforma a partir da atualização 1.6.Caso possua uma atualização anterior do fluig acesse: DES 069 - Fluig API. |
Índice
| Índice |
|---|
| outline | true |
|---|
| exclude | .*ndice |
|---|
| style | none |
|---|
|
...
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.
...
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, localize o agrupador Parâmetros técnicos e acione a opção Oauth Provider.
note | | Em atualizações anteriores à 1.6.5 (Liquid), essa opção está localizada na aba Colaboração do Painel de controle. |
| Card |
|---|
| - 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 |
|---|
| - Volte para o Painel de controle e acesse agora a opção Oauth application.
| Nota |
|---|
Em atualizações anteriores à 1.6.5 (Liquid), essa opção está localizada na aba Colaboração do Painel de controle.
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 |
|---|
| - Opcional: Caso seu aplicativo execute ações em nome próprio, você pode criar um usuário aplicativo.
| Nota |
|---|
| 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 |
|
...
| Bloco de código |
|---|
|
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 |
|---|
|
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;
...