Explorando o WCMAPI no Fluig TOTVS: O Que Desenvolvedores Precisam Saber

Quando se trata de desenvolvimento na plataforma Fluig TOTVS, o WCMAPI é uma das ferramentas mais poderosas e essenciais à disposição dos desenvolvedores. Essa API fornece acesso a uma ampla gama de funcionalidades que facilitam a criação de soluções personalizadas e dinâmicas dentro do Fluig, desde a obtenção de informações de usuário até a realização de chamadas de serviço REST.

Neste post, vamos explorar o que o WCMAPI oferece, seus principais recursos e como ele pode ser utilizado no desenvolvimento de widgets, formulários e personalizações dentro do Fluig.

O Que é o WCMAPI?

O WCMAPI (Web Content Management API) é uma API JavaScript fornecida pelo Fluig que permite aos desenvolvedores interagir com o ambiente Fluig e seus recursos internos. Ele é amplamente utilizado para obter dados do usuário, interagir com o backend, manipular sessões, realizar chamadas REST e até mesmo controlar permissões de usuários e grupos.

Principais Funcionalidades do WCMAPI

Aqui estão algumas das funcionalidades mais importantes que os desenvolvedores devem conhecer:

1. Informações do Usuário

Acessar os detalhes do usuário logado é uma tarefa comum em muitos projetos. O WCMAPI facilita isso com propriedades que retornam o nome, código e login do usuário, permitindo que o desenvolvedor use essas informações em widgets, formulários e outras partes do sistema.

• WCMAPI.user: Retorna o nome do usuário logado.
• WCMAPI.userCode: Retorna o código único do usuário logado.
• WCMAPI.userId: Retorna o login do usuário.

Exemplo de uso:

console.log(WCMAPI.user);      // Exibe o nome do usuário
console.log(WCMAPI.userCode);  // Exibe o código do usuário
console.log(WCMAPI.userId);    // Exibe o login do usuário

2. Realização de Chamadas REST

O WCMAPI permite que você realize chamadas HTTP para APIs REST, o que é útil quando seu projeto precisa buscar ou enviar dados para serviços externos ou internos ao Fluig. Isso é feito por meio do método WCMAPI.Read.

• WCMAPI.Read(url, params, successCallback, errorCallback): Faz uma requisição GET para o endpoint fornecido.

Exemplo de uso:

WCMAPI.Read("/api/public/ecm/document/listDocument/1", {},
    function(data) {
        console.log("Sucesso:", data);
    },
    function(error) {
        console.error("Erro:", error);
    }
);

3. Criação de URLs de Serviço

Uma funcionalidade interessante do WCMAPI é a construção de URLs dinâmicas, especialmente útil quando estamos lidando com APIs ou serviços internos ao Fluig. O método WCMAPI.serverURL retorna a URL do servidor em que o Fluig está rodando.

• WCMAPI.serverURL: Retorna a URL do servidor Fluig.

Exemplo de uso:

var url = WCMAPI.serverURL + "/api/public/2.0/users";
console.log("A URL do servidor é:", url);

4. Manipulação de Permissões

Outra funcionalidade importante é a interação com as permissões de usuários e grupos dentro do Fluig. Isso é feito com métodos como WCMAPI.createPermission.

• WCMAPI.createPermission(): Cria permissões para usuários ou grupos em documentos, processos e outros recursos do Fluig.

5. Interação com Documentos

O WCMAPI também oferece suporte para trabalhar com documentos. A função WCMAPI.getDocumentURL retorna a URL de visualização de um documento específico no Fluig, facilitando a criação de links dinâmicos.

• WCMAPI.getDocumentURL(documentId): Retorna a URL de um documento no Fluig.

Exemplo de uso:

var documentUrl = WCMAPI.getDocumentURL(12345);
console.log("URL do documento:", documentUrl);

6. Gerenciamento de Sessão

A API permite também a manipulação da sessão do usuário no Fluig, como obter o token de sessão para realizar chamadas autenticadas. Isso é feito com WCMAPI.getToken.

• WCMAPI.getToken(): Retorna o token de sessão do usuário logado.

Boas Práticas ao Usar WCMAPI

Ao trabalhar com o WCMAPI, existem algumas práticas recomendadas que você deve adotar para garantir que o código seja eficiente, seguro e fácil de manter:

• Verificação de Erros: Sempre inclua callbacks de erro ao realizar chamadas REST ou acessar dados sensíveis.

  WCMAPI.Read("/api/public/endpoint", {},
      function(data) {
          console.log("Dados recebidos:", data);
      },
      function(error) {
          console.error("Erro ao acessar o endpoint:", error);
      }
  );

• Segurança: Evite expor dados sensíveis ou realizar operações críticas diretamente do lado do cliente. Prefira realizar operações complexas ou sensíveis no backend.
• Depuração: Use console.log para depurar valores retornados pela API, mas lembre-se de remover esses logs antes de implantar o código em produção.

Conclusão

O WCMAPI é uma ferramenta indispensável para desenvolvedores que trabalham com o Fluig TOTVS, oferecendo acesso a funcionalidades poderosas que simplificam o desenvolvimento de aplicações customizadas. Desde a obtenção de dados do usuário até a execução de chamadas REST, o WCMAPI permite que você crie soluções robustas e integradas de maneira eficiente.

Estude bem suas funcionalidades e utilize-as ao máximo para melhorar a experiência de uso e a performance de suas soluções no Fluig.

About the Author

Otácio Barbosa

Administrator

Visit Website View All Posts