• Índice

Objetivo

Para utilizar os recursos do componente SDK, existem alguns pré-requisitos e exigências a serem seguidos, como:

Esta documentação é destinada ao desenvolvedor, cliente e parceiro do fluig que deseja consumir interna e externamente os recursos disponíveis na API Pública e no componente SDK.

As operações na API Pública estão disponíveis através de chamadas REST, que são consumidas via HTTP.
As operações no componente SDK estão disponíveis após configuração do fluig-sdk-api no classpath da aplicação, dessa forma, através de um ServiceLocator, é realizada a chamada ao serviço desejado. 

Consumindo um serviço na API Pública

Para utilizar um serviço da API Pública, deve ser utilizado o protocolo OAuth de autenticação, que através das chaves ConsumerKey, ConsumerSecret, configurados no OAuthConsumer é gerado através do OAuthProvider com um novo TokenAccess e um TokenSecret.

acessar com segurança recursos e serviços externos ao fluig à partir de processos de workflow ou customizações, pode-se utilizar a funcionalidade do Authorize Client no Fluig. Essa funcionalidade consiste em um cadastro de configurações de acesso e segurança do serviço externo a ser invocado, ou seja, para cada caso de protocolo de segurança sendo OAuth 1, OAuth 2 ou Basic Authentication, serão informados e cadastrados os token's de acesso, chaves, usuário, senha, etc. 

Cadastro de Client para chamada a Serviços externos.

Para acesso ao cadastro do Authorize Client, acessar no Fluig o menu Painel de Controle, aba WCM, opção Authorize Client. A funcionalidade provê 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.

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

  Código do Serviço (Obrigatório) Domínio (Obrigatório) Tipo de Autenticação (Obrigatório) Consumer Key (Obrigatório) Consumer Secret (Obrigatório) Access Token (Obrigatório) Secret Token (Obrigatório) URL para o Access Token (Obrigatório) URL para o Request Token (Obrigatório) URL para Autorização (Obrigatório) URL GET para test da autenticação do serviço (Opcional)

  Image AddedImage Added

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

  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 (Obrigatório) Id Cliente (Obrigatório) Client Secret Refresh Token Tipo de Permissão Token de Acesso Escopo URL de redirecionamento URL refresh token URL GET para test da autenticação do serviço (Opcional)

  Image AddedImage Added

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

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

  Image Added

  O client deve ser desenvolvido para suportar autenticação OAuth 1.0a.

Consumindo um serviço no componente SDK

Para utilizar o recursos do componente SDK, existem alguns pré-requisitos e exigências a serem seguidos, como:

...

• Realizar lookup do serviço via ServiceLocator. Seguir padrão da Super Classe FluigAPI.

Serviços disponíveis no componente SDK

• • ArticleService

  • CardIndexService

  • CardService

  • CollaborationSDKService

  • CommunityService

  • ContentFilesService

  • DocumentService

  • FavoritesService

  • FolderDocumentService

  • GlobalParameterService

  • GroupService

  • I18NService

  • PageService

  • PostService

  • SecurityService

  • SocialBreadcrumbService

  • TasksService

  • TenantService

  • UserService

  • WorkflowService

Exemplo para instanciar serviço do SDK

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

private UserService getUserServiceSDK() throws SDKException {
	return new FluigAPI().getUserService();
}

Consumindo um serviço do componente SDK a partir de eventos de javascript

...

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

Código do Serviço (Obrigatório) Domínio (Obrigatório) Tipo de Autenticação (Obrigatório) Consumer Key (Obrigatório) Consumer Secret (Obrigatório) Access Token (Obrigatório) Secret Token (Obrigatório) URL para o Access Token (Obrigatório) URL para o Request Token (Obrigatório) URL para Autorização (Obrigatório) URL GET para test da autenticação do serviço (Opcional)

Image AddedImage Added