Revisões e aprovações

Banner do herói do caso de uso

A colaboração remota entre equipes se tornou necessária para muitas empresas durante a pandemia da Covid-19, compartilhamento e revisão de documentos digitais apresenta uma série de desafios para equipes e recursos multifuncionais.

Esses desafios incluem o compartilhamento de documentos em diferentes formatos de arquivo, a revisão e os comentários efetivos sobre o conteúdo, além da sincronização com as edições mais recentes. Adobe Acrobat Services As APIs foram projetadas para permitir que desenvolvedores de aplicativos solucionem esses desafios para seus usuários.

O que você pode aprender

Este tutorial prático mostra como criar um fluxo de trabalho de revisão e aprovação de documentos em um Node.js e uma aplicação Web do Express. Para acompanhar este tutorial, você precisa de alguma experiência com o Node.js.

O aplicativo tem os seguintes recursos:

  • Converter diferentes tipos de arquivos em PDF

  • Ativar uploads de arquivos

  • Dar aos usuários a capacidade de adicionar comentários e anotações

  • Exibir os PDF junto com esses comentários

  • Permitir que perfis de usuário identifiquem autores de comentários

  • Combinar arquivos em um PDF final para os usuários baixarem

APIs e recursos relevantes

Criação de credenciais de API do Adobe

Antes de iniciar o código, você deve criar credenciais para a Adobe PDF Embed API e a Adobe PDF Services API. A API de incorporação do PDF é gratuita. A API de serviços PDF é gratuita para uso por seis meses, depois você pode mudar para uma plano pré-pago a apenas $0,05 por transação de documento.

Ao criar credenciais para a API de Serviços do PDF, selecione o Criar amostra de código personalizada e selecione Node.js para o idioma. Salve o arquivo ZIP e extraia pdftools-api-credentials.json e private.key no diretório raiz do projeto Node.js Express.

Configurando um projeto e dependências

Configure o projeto Node.js e Express para fornecer arquivos estáticos de uma pasta chamada “public”. Você pode configurar seus modos de projeto, dependendo de suas preferências. Para começar a usar o produto rapidamente, use o Gerador de aplicativos Express. Ou se você quiser simplificar as coisas, você pode começar do zero e mantenha o código em um único arquivo JavaScript. No projeto de amostra vinculado acima, você está usando a abordagem de um arquivo e mantendo todos os códigos em index.js.

Copie o pdftools-api-credentials.json e private.key da amostra de código personalizado para o diretório raiz do projeto. Além disso, adicione-os ao arquivo .gitignore, se você tiver um, para que seus arquivos de credencial não sejam enviados acidentalmente a um repositório.

Em seguida, execute npm install @adobe/documentservices-pdftools-node-sdk para instalar o SDK do Node.js para Serviços PDF. Importe este módulo e crie o objeto de credenciais de API dentro do seu código (index.js em seu projeto de amostra), após o restante das importações de dependência desta forma:

  const PDFToolsSdk = require( "@adobe/documentservices-pdftools-node-sdk" );

  // Create Credentials
  const credentials =  PDFToolsSdk.Credentials
      .serviceAccountCredentialsBuilder()
      .fromFile( "pdftools-api-credentials.json" )
      .build();

Seu código inicial deve ser semelhante a este:


  const express = require( "express" );
  const PDFToolsSdk = require( "@adobe/documentservices-pdftools-node-sdk" );

  // Create Credentials
  const credentials =  PDFToolsSdk.Credentials
      .serviceAccountCredentialsBuilder()
      .fromFile( "pdftools-api-credentials.json" )
      .build();

  const app = express();

  app.use( express.static( "public" ) );

  app.listen( 8889, function() {
      console.log( "Server started on port", 8889 );
  } );

Agora você está pronto para trabalhar Acrobat Services APIs.

Convertendo um arquivo em PDF

Para a primeira parte do fluxo de trabalho de documentos, o usuário final deve fazer upload de documentos para compartilhar. Para ativar isso, adicione uma função de upload e consolide os diferentes formatos de arquivo de documento em PDF para prepará-los para o processo de revisão.

Comece criando uma função para converter documentos em PDF com base no exemplo de snippet para a API de serviços do PDF. Este exemplo também mostra snippets para muitos outros recursos vitais, incluindo reconhecimento óptico de caracteres (OCR), proteção e remoção de senha e compactação.

function fileToPDF( filename, outputFilename, callback ) {
      // Create an ExecutionContext using credentials and create a new operation
  instance.
      const executionContext = PDFToolsSdk.ExecutionContext.create( credentials ),
          createPdfOperation = PDFToolsSdk.CreatePDF.Operation.createNew();

      // Set operation input from a source file.
      const input = PDFToolsSdk.FileRef.createFromLocalFile( filename );
      createPdfOperation.setInput( input );

      // Execute the operation and Save the result to the specified location.
      createPdfOperation.execute( executionContext )
          .then( result => {
              result.saveAsFile( outputFilename );
              callback( outputFilename );
          } );
  }

Agora você pode usar essa função para criar PDF a partir de documentos carregados.

Manipular uploads de arquivos

Em seguida, o servidor precisa de um ponto de extremidade de upload de arquivo no servidor Web para receber e processar os documentos.

Primeiro, crie uma pasta dentro de uma pasta de envios e nomeie-a de “rascunhos”. Você armazena os arquivos carregados e os arquivos de PDF convertidos aqui. Em seguida, execute npm install express-fileupload para instalar o módulo Express-FileUpload e adicionar o middleware ao Express em seu código:

const fileUpload = require( "express-fileupload" );
app.use( fileUpload() );

Agora, adicione um /upload e salve o arquivo carregado dentro da pasta rascunhos usando o mesmo nome de arquivo. Em seguida, chame a função que você escreveu anteriormente para criar um arquivo PDF do mesmo documento, se ele ainda não estiver no formato PDF. Você pode gerar um nome de arquivo para o novo arquivo PDF com base no nome do documento original carregado:

// Create a PDF file from an uploaded file
app.post( "/upload", ( req, res ) => {
    if( !req.files || Object.keys( req.files ).length === 0 ) {
        return res.status( 400 ).send( "No files were uploaded." );
    }

    // Create PDF from the uploaded file
    let file = req.files.myFile;
    file.mv( __dirname + "/uploads/drafts/" + file.name, ( err ) => {
        if( err ) {
            return res.status( 500 ).send( err );
        }
        if( file.name.endsWith( ".pdf" ) ) {
            res.redirect( "/" );
        }
        else {
            // Convert to PDF
            fileToPDF( __dirname + "/uploads/drafts/" + file.name, __dirname + "/uploads/drafts/" + file.name.replace( /\./g, "-" ) + ".pdf", ( file ) => {
                res.redirect( "/" );
            } );
        }
    });
} );

Criando uma página de upload

Para fazer upload de arquivos do aplicativo da Web, crie um index.html página da web dentro da pasta uploads. Na página, adicione um formulário de upload de arquivo que envia o arquivo ao endpoint /upload:

<form ref="uploadForm"
      action="/upload"
      method="post"
      encType="multipart/form-data">
      <input type="file" name="myFile" accept=".doc,.docx,.ppt,.pptx,.xls,.xlsx,.txt,.rtf,.bmp,.jpg,.gif,.tiff,.png">
      <input type="submit" value="Upload File" />
  </form>

Captura de tela do recurso de upload de arquivos na página da Web

Agora você pode fazer upload de documentos no servidor Node.js. O servidor salva o arquivo dentro da pasta uploads/drafts e cria uma versão de formato de PDF ao lado dela.

Agora você está pronto para incorporar os documentos carregados, portanto, use a API de incorporação de PDF para permitir que os usuários adicionem comentários e anotações aos documentos facilmente.

Enumerando arquivos PDF

Como um fluxo de trabalho de documento típico pode envolver vários documentos, você deve mostrar uma lista de documentos e vincular cada um a uma nova página de revisão de documento em seu aplicativo.

Primeiro, dentro do código do servidor, adicione um ponto de extremidade /files que obtém e retorna uma lista de todos os arquivos de PDF armazenados na pasta uploads/drafts:

const fs = require( "fs" );

app.get( "/files", ( req, res ) =\> {

fs.readdir( \_\_dirname + "/uploads/drafts/", ( err, files ) =\> {

if( err ) {

return res.status( 500 ).send( err );using

}

return res.json( files.filter( f =\> f.endsWith( ".pdf" ) ) );

} );

} );

Adicionar um /download/:file rota que fornece acesso ao arquivo de PDF carregado para incorporação na página da Web.

NOTE
Em um aplicativo de produção, você deve adicionar autenticação e autorização para garantir que a solicitação venha de um usuário válido e que o usuário tenha permissão para acessar o documento.
app.get( "/download/:file", function( req, res ){
    // Note: In production code, this should check authentication and user access permissions
    res.download( __dirname + "/uploads/drafts/" + req.params[ "file" ] );
});

Atualize a página index.html com um elemento file list que seja preenchido no momento do carregamento. Cada item pode ser vinculado a uma página da Web draft.html e você pode passar o nome do arquivo para a página usando os parâmetros de sequência de caracteres de consulta.

NOTE
O jQuery é usado para anexar cada item, portanto, você deve carregar a biblioteca do jQuery em sua página da Web ou anexar o elemento usando um método diferente.
  <ul id="filelist">
      <li>Loading documents...</li>
  </ul>

  ...

  <script>
      // Load current files
      fetch( "/files" )
      .then( r => r.json() )
      .then( files => {
          if( files && files.length > 0 ) {
              $( "#filelist" ).empty();
              files.forEach( file => {
                  $( "#filelist" ).append( `<li><a
  href="/draft.html?file=${file}">${file}</a></li>` );
              })
          } else {
                  $("#filelist").append("<div>No documents found.</div>");
                }
      });
  </script>

Captura de tela da seleção de um arquivo para revisão

Incorporação de um PDF

Você está pronto para incorporar e mostrar arquivos PDF dentro de seu aplicativo web.

Crie uma página da Web chamada “draft.html” e adicione um elemento div na página do PDF incorporado:

  <div id="adobe-dc-view"></div>

Inclua o Acrobat Services biblioteca:

  <script src="https://documentcloud.adobe.com/view-sdk/main.js"></script>

Dentro de uma tag de script personalizada, analise o nome do arquivo a partir dos parâmetros de string de consulta para que você saiba qual arquivo incorporar na página:

  <script type="text/javascript">
          let params = new URLSearchParams( window.location.search );
          let filename = params.get( "file" );
  </script>

Adicione um ouvinte de eventos do documento para o evento adobe_dc_view_sdk.ready que carrega o arquivo de PDF especificado em uma exibição incorporada dentro do elemento div. Use sua ID de cliente a partir das credenciais de API de PDF incorporado. Você deseja ativar comentários e anotações, portanto, incorpore a exibição no modo FULL_WINDOW e defina a opção showAnnotationsTools como true.

  document.addEventListener( "adobe_dc_view_sdk.ready", () => {
      var adobeDCView = new AdobeDC.View( {
          clientId: "YOUR CLIENT ID HERE",
          divId: "adobe-dc-view",
          locale: "en-US",
      } );
      adobeDCView.previewFile( {
          content: { location: { url: "download/" + filename } },
          metaData: { fileName: "Draft Version.pdf" }
      }, {
          embedMode: "FULL_WINDOW",
          showAnnotationTools: true,
          showPageControls: true
      } );
  });

Criar um perfil de usuário

Por padrão, comentários e anotações são exibidos como “Convidado” nesta exibição. É possível definir o nome do revisor atual para os comentários e anotações registrando um retorno de chamada do perfil do usuário no código da página para a visualização PDF. Veja a seguir um perfil de exemplo. Em um aplicativo completo que inclui autenticação de usuário, as informações de perfil da sessão do usuário conectada podem ser definidas dessa maneira para identificar cada comentarista do documento no fluxo de trabalho de revisão.

  adobeDCView.registerCallback(
      AdobeDC.View.Enum.CallbackType.GET_USER_PROFILE_API,
      () => {
          return new Promise( ( resolve, reject ) => {
              resolve({
                  code: AdobeDC.View.Enum.ApiResponseCode.SUCCESS,
                  data: {
                      userProfile: {
                          name: "YOUR NAME",
                          firstName: "FIRST",
                          lastName: "LAST",
                          email: "document.editor@adobe.com"
                      }
                  }
              });
          });
      }
  );

Seu perfil identifica você como um usuário específico ao ver e anotar qualquer documento carregado usando esta página da Web.

Salvando feedback do documento

Depois que um usuário comenta em um documento, ele clica em Economize. Por padrão, ao clicar em Salvar baixa o arquivo PDF atualizado. Altere esta ação para atualizar o arquivo de PDF atual no servidor.

Adicionar um /save ponto final para o código do servidor que substitui o arquivo PDF na pasta uploads/drafts:

  // Overwrite the PDF file with latest PDF changes and annotations
  app.post( "/save", ( req, res ) => {
      if( !req.files || Object.keys( req.files ).length === 0 ) {
          return res.status( 400 ).send( "No files were uploaded." );
      }

      let file = req.files.pdf;
      file.mv( __dirname + "/uploads/drafts/" + file.name, ( err ) => {
          if( err ) {
              return res.status( 500 ).send( err );
          }
          res.send( "File uploaded" );
      });
  } );

Registre um retorno de chamada de exibição de PDF para a SAVE_API que faz upload do conteúdo para o ponto de extremidade /save. Você pode alterar o valor autoSaveFrequency para permitir que o aplicativo salve automaticamente as alterações em um temporizador e inclua metadados adicionais no arquivo atualmente incorporado na conclusão, se desejar.

  adobeDCView.registerCallback(
      AdobeDC.View.Enum.CallbackType.SAVE_API,
      ( metaData, content, options ) => {
          return new Promise( ( resolve, reject ) => {
              let formData = new FormData();
              formData.append( "pdf", new Blob( [ content ] ), "drafts/" + filename
  );
              fetch( "/save", {
                  method: "POST",
                  body: formData
              }).then( resp => {
                  resolve({
                      code: AdobeDC.View.Enum.ApiResponseCode.SUCCESS,
                      data: {
                          /* Updated file metadata after successful save operation */
                          metaData: Object.assign( metaData, {} )
                      }
                  });
              });
          });
      },
      {
          autoSaveFrequency: 0,
          enableFocusPolling: false,
          showSaveButton: true
      }
  );

Comentários e anotações nos documentos de rascunho agora são salvos no servidor. Você pode leia mais sobre como os retornos de chamada ajuste-se ao seu fluxo de trabalho. Por exemplo, retornos de chamada de status ajude a lidar com conflitos de arquivo se várias pessoas quiserem revisar e comentar no mesmo documento simultaneamente.

Na etapa final, combine todos os documentos editados em um arquivo de PDF usando a API de serviços do PDF.

Combinação de arquivos PDF

O código de combinação de PDF é como o código de criação de PDF, mas usa a operação CombineFiles e adiciona cada arquivo como entrada.

  function combineFilesToPDF( files, outputFilename, callback ) {
      // Create an ExecutionContext using credentials and create a new operation
  instance.
      const executionContext = PDFToolsSdk.ExecutionContext.create( credentials ),
          combineFilesOperation = PDFToolsSdk.CombineFiles.Operation.createNew();

      // Set operation inputs from source files.
      files.forEach( file => {
          const input = PDFToolsSdk.FileRef.createFromLocalFile( file );
          combineFilesOperation.addInput( input );
      } );

      // Execute the operation and Save the result to the specified location.
      combineFilesOperation.execute( executionContext )
          .then( result => {
              result.saveAsFile( outputFilename );
              callback( outputFilename );
          } );
 }

Baixando o PDF final

Adicione um ponto final chamado /finalize que chama a função para combinar todos os arquivos de PDF dentro do uploads/drafts pasta em um Final.pdf e, em seguida, faz o download.

  app.get( "/finalize", ( req, res ) => {
      fs.readdir( __dirname + "/uploads/drafts/", ( err, files ) => {
          if( err ) {
              return res.status( 500 ).send( err );
          }
          combineFilesToPDF(
              files.filter( f => f.endsWith( ".pdf" ) ).map( f => __dirname +
  "/uploads/drafts/" + f ),
              __dirname + "/uploads/Final.pdf", ( file ) => {
              res.download( file );
          } );
      } );
  } );

Por fim, adicione um link na página da Web principal index.html a este ponto final /finalize. Esses links permitem que os usuários baixem o resultado do fluxo de trabalho do documento.

<a href="/finalize">Download final PDF</a>

Captura de tela do download do documento final

Próximas etapas

Este tutorial prático mostrou como Acrobat Services As APIs integram um fluxo de trabalho de compartilhamento e revisão de documentos em uma aplicação web. O aplicativo permite que funcionários remotos compartilhem arquivos e colaborem com seus colegas de equipe, que são especialmente úteis para funcionários e prestadores de serviço que trabalham em casa.

Você pode usar essas técnicas para permitir a colaboração em seu aplicativo ou explorar Amostras do SDK do Nó de Serviços PDF e Amostras de API incorporadas do PDF no GitHub para obter inspiração sobre como usar APIs Adobe.

Pronto para habilitar o compartilhamento e a revisão de documentos em seu próprio aplicativo? Inscreva-se no seu Adobe Acrobat Services conta de desenvolvedor. Acesse o Adobe PDF Embed gratuitamente e aproveite uma avaliação gratuita de seis meses das outras APIs. Após a avaliação, você pode pré-pago por apenas $0,05 por transação de documento à medida que sua empresa cresce.

recommendation-more-help
61c3404d-2baf-407c-beb9-87b95f86ccab