API de PDF do Macaaw
API de PDF para comprimir, converter e assinar
Uma API REST para 20 ferramentas de PDF e assinaturas eletrônicas. Cada tarefa roda nos nossos servidores em Londres e os arquivos são excluídos em até 2 horas.
Obter uma chave de sandbox grátisLer a documentação da API
- OpenAPI 3.1
- Coleção do Postman
- Sandbox grátis
- Webhooks assinados
curl https://macaaw.com/public/v1/tasks \
-H "Authorization: API-Key $MACAAW_API_KEY" \
-F "files[]=@lease.pdf" \
-F 'data={"tool":"compress-pdf","options":{"level":"recommended"}}'
# 201 Created
{ "id": "…", "tool": "compress-pdf", "status": "task.queued" }// Node 18+ (fetch, FormData and Blob are built in)
import { readFile } from "node:fs/promises";
const form = new FormData();
form.append("files[]", new Blob([await readFile("lease.pdf")]), "lease.pdf");
form.append("data", JSON.stringify({ tool: "compress-pdf", options: { level: "recommended" } }));
const res = await fetch("https://macaaw.com/public/v1/tasks", {
method: "POST",
headers: { Authorization: `API-Key ${process.env.MACAAW_API_KEY}` },
body: form,
});
const task = await res.json(); // { id, tool, status: "task.queued" }# Python 3 with requests
import json, os, requests
res = requests.post(
"https://macaaw.com/public/v1/tasks",
headers={"Authorization": f"API-Key {os.environ['MACAAW_API_KEY']}"},
files={"files[]": open("lease.pdf", "rb")},
data={"data": json.dumps({"tool": "compress-pdf", "options": {"level": "recommended"}})},
)
task = res.json() # {"id": ..., "status": "task.queued"}- 20ferramentas de PDF em um único endpoint
- 1 chamadapara enviar e iniciar uma tarefa
- < 2 haté seus arquivos serem excluídos
- £ 0para o sandbox
O que você pode criar
As tarefas de PDF que o seu produto não precisa manter
Reduza os envios antes de armazená-los
Comprima PDFs ou ajuste-os a um tamanho exato no momento em que seus usuários os enviam.
Converta arquivos do Office em PDF
De Word, Excel, PowerPoint, OpenDocument e HTML para PDF, com layouts que se mantêm.
Deixe digitalizações pesquisáveis
Reconhecimento de texto em 27 idiomas, PDF/A para arquivamento e tabelas direto para Excel.
Envie acordos a partir do seu próprio app
Crie um documento a partir de um PDF, posicione campos com tags de texto, envie e baixe a cópia assinada.
Incorpore a assinatura ao seu produto
Abra uma sessão de assinatura dentro do seu site, limitada às origens que você permitir.
Execute lotes com webhooks
Inicie centenas de tarefas e receba um callback assinado quando cada uma terminar.
Como funciona
Da chave ao resultado em quatro chamadas
Crie uma chave
Crie uma chave de sandbox na sua conta. Passe para uma chave de produção quando estiver pronto.
Conta › DesenvolvedorInicie uma tarefa
Envie os arquivos e a ferramenta em uma única requisição multipart.
POST /public/v1/tasksSaiba quando terminar
Assine task_completed ou consulte a tarefa periodicamente.
webhook: task_completedBaixe
Busque o resultado e depois exclua-o ou deixe-o expirar.
GET /tasks/{id}/download
Endpoints
Uma API pequena e previsível
URL base https://macaaw.com/public/v1 · JSON com chaves em snake_case · Authorization: API-Key …
Tarefas · ferramentas de PDF
- GET
/toolsTodas as ferramentas que você pode chamar, com suas opções - POST
/tasksEnvie arquivos e inicie uma ferramenta em uma única chamada - GET
/tasks/{id}Status: na fila, processando, concluída ou com falha - GET
/tasks/{id}/downloadO arquivo de resultado, ou um ZIP - DELETE
/tasks/{id}Exclua os arquivos agora
Documentos · assinaturas eletrônicas
- POST
/documentsUm PDF com destinatários e campos, ou tags de texto - POST
/documents/{id}/sendEnvie por e-mail ou em silêncio, para assinatura incorporada - GET
/documents/{id}/detailsDestinatários, campos e toda a linha do tempo - POST
/documents/{id}/sessionUm link de assinatura para a sua própria página - GET
/documents/{id}/downloadO PDF assinado com o certificado
Webhooks
- POST
/webhook-subscriptionsEscolha gatilhos como task_completed ou document_state_changed - GET
/webhook-eventsHistórico de entregas, com reenvio
Segurança
Pensada para produção desde o primeiro dia
As mesmas regras de exclusão e o mesmo processamento no Reino Unido do site, além dos controles que uma equipe de engenharia espera.
- Chaves sob o seu controleChaves de produção e de sandbox, mostradas uma única vez e armazenadas como hash. Revogue qualquer chave pela sua conta.
- Webhooks assinadosCada entrega leva ?signature= com um HMAC-SHA256 do corpo, feito com a sua chave compartilhada.
- Arquivos excluídos rapidamenteOs arquivos das tarefas ficam 1 hora em uma conta grátis e 2 horas no Pro e no Business, e depois somem. DELETE os remove na hora.
- Processamento no Reino UnidoCada tarefa roda nos nossos servidores em Londres. Os registros de requisições nunca guardam o conteúdo nem os nomes dos arquivos.
- Limites de taxa justos120 novas tarefas por minuto por usuário, com Retry-After em cada 429.
- Novas tentativas segurasEnvie uma Idempotency-Key e uma requisição repetida devolve o primeiro resultado por 24 horas.
Preços
Comece grátis. Pague conforme crescer.
Sandbox
£ 0
- Todos os endpoints, com dados de teste
- 10 requisições por minuto
- Até 5 páginas por tarefa
- Resultados com o carimbo “Sandbox”
- Dados de teste excluídos após 7 dias
Produção, no Pro ou no Business
A partir de £ 4,99por mês, cobrado anualmente
- Usa as cotas mensais do seu plano
- Depois, créditos: a partir de £ 5 por 500
- 1 crédito por página de OCR, 2 créditos por conversão do Office
- 120 novas tarefas por minuto
Enterprise
Preços por volume
- Preços por volume em páginas e conversões
- Limites personalizados, vendidos por contrato
- Cobrança anual por fatura
- Um contato dedicado
Perguntas
Os desenvolvedores perguntam
Existe uma forma grátis de testar a API?
Sim. Qualquer usuário conectado pode criar uma chave de sandbox grátis. As chamadas de sandbox são limitadas a 10 por minuto e 5 páginas por tarefa, todo resultado recebe o carimbo “Sandbox”, e os dados de teste são excluídos após 7 dias.
Quais ferramentas posso chamar?
As 20 ferramentas que rodam nos nossos servidores, de Comprimir e OCR a conversões do Office e PDF/A, além das assinaturas eletrônicas. GET /tools lista todas com suas opções. As 20 ferramentas de navegador rodam nos navegadores dos seus usuários, então não estão na API v1.
Como o uso da API é cobrado?
As chaves de produção vêm com o Pro e o Business. As chamadas usam as mesmas cotas mensais do site; além delas, valem créditos. Os pacotes de créditos começam em £ 5 por 500 créditos e valem por 12 meses.
Vocês têm SDKs?
A documentação tem exemplos para copiar e colar em curl, Node e Python para cada endpoint, um arquivo OpenAPI 3.1 e uma coleção do Postman, para você gerar um cliente em qualquer linguagem.
O que acontece se o meu endpoint de webhook estiver fora do ar?
Tentamos mais três vezes, após 1 minuto, 10 minutos e 1 hora, e depois marcamos a entrega como falha. Você pode reenviá-la pela sua conta ou pela API.
Lance recursos de PDF esta semana.
Crie uma chave de sandbox em um minuto. Sem precisar de cartão.