Link para acessar documentos

Este manual tem como objetivo detalhar a integração a ser realizada entre cliente e a plataforma de visualização de documentos através de links dinâmicos criptografados.

Através de API

A API é um componente Java standalone sem dependências de outras bibliotecas e deve ser incorporado em qualquer sistema, web ou desktop, que execute na JRE 6 ou superior. 

Caso o seu sistema seja em Java, por favor, solicite para [email protected] o envio da API

2.1 - Utilizando a API

Após importar a biblioteca “MavenLinkAPI.jar” em seu projeto basta uma linha de código para criar links dinâmicos para abrir documentos no visualizador. Veja como exemplo o código abaixo.

String link=LinkFactory.buildLink("pedrosilva", "343", "SIM-5452354545").

                    addParameter("sistema", "SMA").

                    buildLink();

Os três primeiros parâmetros são obrigatórios.

• username : Username do usuário logado para exibição na tela e relatórios.
• userID: Identificador único do usuário logado no sistema para vínculo em tabela de comentários e busca de informações.
• Número do processo: Número do processo no sistema que será integrado ao visualizador

Além destes três parâmetros obrigatórios poderão existir diversos outros parâmetros opcionais que você repassa para a API utilizando o método “addParameter”. Estes parâmetros serão criados durante a integração do sistema. Exemplo:

• idr_documento = Indica o documento inicial que deve abrir para o usuário
• num_pagina = Indica o número da página que deve abrir ao usuário
• id_pagina = Indica o ID da página (flip_pagina_edicao) que deve abrir ao usuário

Por fim basta chamar o método “buildLink()” que retornará o link criptografado para ser disponibilizado ao cliente final.

2.2 - Adicionando grupos

Você pode utilizar o método “addGroup” para adicionar grupos para o seu usuário. Se o usuário possuir pelo menos um grupo ele poderá compartilhar as suas anotações com os grupos e assim ter o seu trabalho exposto para usuários que acessarem com um ou mais grupos idênticos. 

Informe neste caso o ID e o NOME do grupo. 

2.3 - Abrindo processos com o link

Após gerar o link criptografado você precisa utiliza-lo para abrir os processos..

Para fazer isso troque o “XXX” pelo código gerado no link abaixo. 

http://{HOST}:{PORT}/mavenflip/pub/visualizador/?numero=XXX

Através de Webservice

Se o seu serviço não utiliza a plataforma Java você pode gerar as chaves de criptografia através de webservices SOAP disponíveis no visualizador. 

Obtenha o acesso ao WSDL do serviço em :

http://{HOST}:{PORT}/mavenflip/{CONSULTE}?wsdl

* Colocamos "CONSULTE" pois o nome do serviço pode variar conforme cliente e instalação. Solicite pra [email protected] seus dados.

O método “geraLink” recebe os seguintes parâmetros:

• nrProcesso - Número do processo a ser aberto (inclui formatação)
• username - Identificador do usuário logado
• sistema - Identificador do sistema de origem que está gerando o link
• ip - IP do usuário requisitante que vai abrir o processo

Ele irá retornar uma chave de 256 caracteres parecida com o padrão abaixo em vermelho e você irá concatenar essa chave no link fixo, demarcado em azul. Faça o redirect do usuário para este link.

https://www.servidor.com.br/mavenflip/pub/visualizador/?numero=xy_aaaaaaxxxxxxaaaa