API PDF

API PDF Macaaw

API PDF untuk memampat, menukar dan menandatangani

Satu API REST untuk 22 alat PDF dan tandatangan elektronik. Setiap tugasan berjalan di pelayan kami di London dan fail dipadam dalam masa 2 jam.

Dapatkan kunci sandbox percumaBaca dokumentasi API

  • OpenAPI 3.1
  • Koleksi Postman
  • Sandbox percuma
  • Webhook yang ditandatangani
Mampatkan PDF dengan satu permintaan
Bahasa sampel kod
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"}
  • 22Alat PDF pada satu titik akhir
  • 1 panggilanuntuk memuat naik dan memulakan tugasan
  • < 2 hsehingga fail anda dipadam
  • £0untuk sandbox

Apa yang boleh anda bina

Kerja PDF yang tidak sepatutnya perlu ditanggung oleh produk anda

  • Kecilkan muat naik sebelum anda menyimpannya

    Mampatkan PDF, atau muatkannya di bawah saiz tepat, sebaik sahaja pengguna anda memuat naiknya.

  • Tukar fail Office ke PDF

    Word, Excel, PowerPoint, OpenDocument dan HTML ke PDF, dengan susun atur yang kekal.

  • Jadikan imbasan boleh dicari

    Pengecaman teks dalam 32 bahasa, PDF/A untuk arkib, dan jadual terus ke Excel.

  • Hantar perjanjian daripada aplikasi anda sendiri

    Cipta dokumen daripada PDF, letakkan medan dengan tag teks, hantarnya dan muat turun salinan yang ditandatangani.

  • Benamkan tandatangan dalam produk anda

    Buka sesi tandatangan di dalam laman anda, terhad kepada asal yang anda benarkan.

  • Jalankan kelompok dengan webhook

    Mulakan beratus-ratus tugasan dan dapatkan panggilan balik yang ditandatangani apabila setiap satu selesai.

  • Kunci berskop dan kelompok

    Kunci dengan skop dan putaran, tugas kelompok, kemajuan langsung dan paparan halaman.

  • Penyunting terbenam

    Letakkan penyunting PDF atau penyunting imej dalam aplikasi anda sendiri, di sebelah tandatangan terbenam.

Cara ia berfungsi

Daripada kunci kepada hasil dalam empat panggilan

  1. Cipta kunci

    Buat kunci sandbox dalam akaun anda. Tukar kepada kunci langsung apabila anda sudah bersedia.

    Akaun › Pembangun
  2. Mulakan tugasan

    Hantar fail dan alat dalam satu permintaan multipart.

    POST /public/v1/tasks
  3. Dapatkan makluman apabila selesai

    Langgan task_completed, atau tinjau tugasan secara berkala.

    webhook: task_completed
  4. Muat turun

    Ambil hasilnya, kemudian padamkannya atau biarkan ia tamat tempoh.

    GET /tasks/{id}/download

Titik akhir

API yang kecil dan mudah dijangka

URL asas https://macaaw.com/public/v1 · JSON dengan kunci snake_case · Authorization: API-Key …

Rujukan API penuh

Tugasan · alat PDF

  • GET/toolsSetiap alat yang boleh anda panggil, bersama pilihannya
  • POST/tasksMuat naik fail dan mulakan alat dalam satu panggilan
  • GET/tasks/{id}Status: queued, processing, completed atau failed
  • GET/tasks/{id}/downloadFail hasil, atau ZIP
  • DELETE/tasks/{id}Padam fail sekarang

Dokumen · tandatangan elektronik

  • POST/documentsPDF serta penerima dan medan, atau tag teks
  • POST/documents/{id}/sendHantar melalui e-mel, atau secara senyap untuk tandatangan terbenam
  • GET/documents/{id}/detailsPenerima, medan dan garis masa penuh
  • POST/documents/{id}/sessionPautan tandatangan untuk halaman anda sendiri
  • GET/documents/{id}/downloadPDF yang ditandatangani bersama sijilnya

Webhook

  • POST/webhook-subscriptionsPilih pencetus seperti task_completed atau document_state_changed
  • GET/webhook-eventsSejarah penghantaran, dengan hantar semula

Keselamatan

Dibina untuk produksi sejak hari pertama

Peraturan pemadaman dan pemprosesan di UK yang sama seperti laman web, serta kawalan yang dijangkakan oleh pasukan kejuruteraan.

  • Kunci yang anda kawalKunci langsung dan sandbox, dipaparkan sekali dan disimpan sebagai cincangan. Batalkan mana-mana kunci daripada akaun anda.
  • Webhook yang ditandatanganiSetiap penghantaran membawa ?signature= dengan HMAC-SHA256 bagi kandungan, dibuat dengan kunci kongsi anda.
  • Fail dipadam dengan pantasFail tugasan disimpan 1 jam pada akaun percuma dan 2 jam pada Pro dan Business, kemudian ia hilang. DELETE mengalih keluarnya serta-merta.
  • Pemprosesan di UKSetiap tugasan berjalan di pelayan kami di London. Log permintaan tidak pernah menyimpan kandungan fail atau nama fail.
  • Had kadar yang adil120 tugasan baharu seminit bagi setiap pengguna, dengan Retry-After pada setiap 429.
  • Cubaan semula yang selamatHantar Idempotency-Key dan permintaan berulang mengembalikan hasil pertama selama 24 jam.

Harga

Mula secara percuma. Bayar mengikut pertumbuhan anda.

Sandbox

£0

  • Setiap titik akhir, dengan data ujian
  • 10 permintaan seminit
  • Sehingga 5 halaman bagi setiap tugasan
  • Output dicop “Sandbox”
  • Data ujian dipadam selepas 7 hari
Dapatkan kunci sandbox

Langsung, pada Pro atau Business

Dari £4.99sebulan, dibilkan tahunan

  • Menggunakan peruntukan bulanan pelan anda
  • Kemudian kredit: dari £5 untuk 500
  • 1 kredit bagi setiap halaman OCR, 2 kredit bagi setiap penukaran Office
  • 120 tugasan baharu seminit
Bandingkan pelan

Enterprise

Harga mengikut volum

  • Harga mengikut volum untuk halaman dan penukaran
  • Had tersuai, dijual melalui kontrak
  • Pengebilan invois tahunan
  • Kenalan khusus
Bercakap dengan kami

Soalan

Soalan pembangun

Adakah cara percuma untuk mencuba API?

Ya. Mana-mana pengguna yang log masuk boleh mencipta kunci sandbox secara percuma. Panggilan sandbox dihadkan kepada 10 seminit dan 5 halaman bagi setiap tugasan, setiap output dicop “Sandbox”, dan data ujian dipadam selepas 7 hari.

Alat manakah yang boleh saya panggil?

22 alat yang berjalan di pelayan kami, daripada Mampat dan OCR hingga penukaran Office dan PDF/A, serta tandatangan elektronik. GET /tools menyenaraikannya bersama pilihannya. 33 alat pelayar berjalan dalam pelayar pengguna anda, jadi ia tiada dalam API v1.

Bagaimanakah penggunaan API dicaj?

Kunci langsung disertakan dengan Pro dan Business. Panggilan menggunakan peruntukan bulanan yang sama seperti laman web; melebihi peruntukan itu, kredit digunakan. Pek kredit bermula dari £5 untuk 500 kredit dan kekal selama 12 bulan.

Adakah anda mempunyai SDK?

Dokumentasi mempunyai sampel salin-dan-tampal dalam curl, Node dan Python untuk setiap titik akhir, fail OpenAPI 3.1 dan koleksi Postman, jadi anda boleh menjana klien dalam mana-mana bahasa.

Apakah yang berlaku jika titik akhir webhook saya tidak berfungsi?

Kami mencuba semula tiga kali lagi, selepas 1 minit, 10 minit dan 1 jam, kemudian menandakan penghantaran sebagai gagal. Anda boleh menghantarnya semula daripada akaun anda atau dengan API.

Lancarkan ciri PDF minggu ini.

Cipta kunci sandbox dalam seminit. Tiada kad diperlukan.