PDF Blocks
PreçosSuporte
Começar grátis
Abrir a página

Visão geral das ações

O que é uma ação, o catálogo agrupado por capacidade e como a saída de uma ação vira a entrada da seguinte.

Uma ação é uma transformação de PDF única e pura, exposta como um único endpoint. Você envia um documento, a ação faz exatamente uma coisa com ele (mesclar, carimbar uma marca-d’água, criptografar, girar, dividir) e você recebe o resultado de volta. As ações não guardam estado nem compartilham contexto; cada chamada se basta. É essa uniformidade que permite encaixá-las em pipelines.

O que é uma ação

Toda ação é um POST para /v1/<action>, onde <action> é o nome técnico das tabelas abaixo. Todas seguem o mesmo contrato de requisição e resposta: um corpo multipart/form-data com o PDF de entrada em um campo file, autenticado com o cabeçalho X-API-Key. A maioria retorna um único application/pdf; a família de divisão retorna vários documentos.

Dezessete ações, agrupadas por capacidade. Cada uma leva à sua referência completa.

Mesclar e dividir

Ação Rota O que faz
Mesclar documentos /v1/merge_documents Combina uma matriz ordenada de PDFs em um único documento.
Dividir por número de páginas /v1/split_by_page_count Quebra um PDF em partes consecutivas com um número fixo de páginas.
Dividir em uma página /v1/split_at_page Divide um PDF em duas partes em um ponto de corte.
Dividir por tamanho de arquivo /v1/split_by_size Quebra um PDF em partes que não passam de um limite em bytes.
Dividir em grupos de páginas /v1/split_by_groups Quebra um PDF em grupos de páginas definidos por você.

Cada uma das quatro ações de divisão produz vários documentos; você escolhe o empacotamento com o cabeçalho Accept. Consulte Formatos de resposta.

Marcas-d’água

Ação Rota O que faz
Adicionar marca-d’água de texto /v1/add_text_watermark Carimba até três linhas de texto estilizado nas páginas.
Adicionar marca-d’água de imagem /v1/add_image_watermark Carimba uma imagem PNG ou JPEG, como um logotipo, nas páginas.

Senhas e segurança

Ação Rota O que faz
Adicionar senha /v1/add_password Criptografa um documento com uma senha de abertura e/ou de permissões.
Remover senha /v1/remove_password Descriptografa um documento quando você sabe a senha dele.
Adicionar restrições /v1/add_restrictions Define os sinalizadores de permissão de impressão, cópia e edição.
Remover restrições /v1/remove_restrictions Limpa os sinalizadores de permissão de um documento.
Remover assinaturas /v1/remove_signatures Remove as assinaturas digitais para que o documento possa ser editado.

Páginas

Ação Rota O que faz
Extrair páginas /v1/extract_pages Mantém um conjunto de páginas escolhido e descarta o resto.
Remover páginas /v1/remove_pages Descarta um conjunto de páginas escolhido e mantém o resto.
Girar páginas /v1/rotate_pages Gira as páginas escolhidas em um múltiplo de 90 graus.
Inverter páginas /v1/reverse_pages Inverte a ordem das páginas de ponta a ponta.
Reordenar páginas /v1/reorder_pages Rearranja as páginas na ordem indicada por quem chama.

Como as ações se compõem

Como toda ação recebe um PDF e (nas ações de saída única) devolve um PDF, a saída de uma ação é uma entrada válida para a seguinte. Nada é armazenado entre as chamadas, então você compõe encaminhando bytes: mantenha a resposta de uma requisição na memória e a poste como o file da próxima.

Um pipeline típico se lê da esquerda para a direita:

merge_documents  →  add_text_watermark  →  add_password
   (many PDFs)         (one watermarked)      (one encrypted)

O guia Encadear ações mostra isso de ponta a ponta, em código, sem tocar no disco.

Saída única ou várias saídas

A maioria das ações retorna um documento application/pdf. As quatro ações de divisão retornam vários e deixam você escolher como eles são empacotados (um arquivo ZIP, um envelope JSON ou um corpo multipart/mixed) por negociação de conteúdo. Esse mecanismo tem uma casa só: Formatos de resposta.