Macaaw PDF API
PDF API para sa pag-compress, pag-convert at pagpirma
Isang REST API para sa 20 PDF tool at e-signature. Tumatakbo sa aming mga server sa London ang bawat task at binubura ang mga file sa loob ng 2 oras.
Kumuha ng libreng sandbox keyBasahin ang dokumentasyon ng API
- OpenAPI 3.1
- Postman collection
- Libreng sandbox
- Mga nilagdaang webhook
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"}- 20PDF tool sa iisang endpoint
- 1 tawagpara mag-upload at magsimula ng task
- < 2 hhanggang mabura ang iyong mga file
- £0para sa sandbox
Ang maaari mong buuin
Mga gawaing PDF na hindi dapat ikaw pa ang gumagawa sa iyong produkto
Paliitin ang mga upload bago iimbak
I-compress ang mga PDF, o iangkop ang mga ito sa eksaktong laki, sa sandaling i-upload ng iyong mga user.
I-convert ang mga Office file tungo sa PDF
Word, Excel, PowerPoint, OpenDocument at HTML tungo sa PDF, na nananatili ang layout.
Gawing mahahanap ang mga scan
Pagkilala ng text sa 27 wika, PDF/A para sa mga archive, at mga table diretso sa Excel.
Magpadala ng mga kasunduan mula sa sarili mong app
Gumawa ng dokumento mula sa PDF, maglagay ng mga field gamit ang text tag, ipadala ito at i-download ang napirmahang kopya.
Isama ang pagpirma sa iyong produkto
Magbukas ng signing session sa loob ng iyong site, limitado sa mga origin na pinapayagan mo.
Magpatakbo ng mga batch gamit ang webhook
Magsimula ng daan-daang task at tumanggap ng nilagdaang callback sa pagtatapos ng bawat isa.
Paano ito gumagana
Mula key hanggang resulta sa apat na tawag
Gumawa ng key
Gumawa ng sandbox key sa iyong account. Lumipat sa live key kapag handa ka na.
Account › DeveloperMagsimula ng task
Ipadala ang mga file at ang tool sa isang multipart request.
POST /public/v1/tasksMalaman kapag tapos na
Mag-subscribe sa task_completed, o i-poll ang task.
webhook: task_completedI-download
Kunin ang resulta, saka burahin ito o hayaang mag-expire.
GET /tasks/{id}/download
Mga endpoint
Isang maliit at predictable na API
Base URL https://macaaw.com/public/v1 · JSON na may snake_case na mga key · Authorization: API-Key …
Mga task · PDF tool
- GET
/toolsBawat tool na maaari mong tawagin, kasama ang mga opsyon nito - POST
/tasksMag-upload ng mga file at simulan ang isang tool sa isang tawag - GET
/tasks/{id}Status: queued, processing, completed o failed - GET
/tasks/{id}/downloadAng file ng resulta, o isang ZIP - DELETE
/tasks/{id}Burahin ang mga file ngayon
Mga dokumento · e-signature
- POST
/documentsIsang PDF kasama ang mga tatanggap at field, o mga text tag - POST
/documents/{id}/sendIpadala sa email, o tahimik para sa naka-embed na pagpirma - GET
/documents/{id}/detailsMga tatanggap, field at ang buong timeline - POST
/documents/{id}/sessionIsang signing link para sa sarili mong pahina - GET
/documents/{id}/downloadAng napirmahang PDF kasama ang certificate nito
Mga webhook
- POST
/webhook-subscriptionsPumili ng mga trigger tulad ng task_completed o document_state_changed - GET
/webhook-eventsHistory ng delivery, na may resend
Seguridad
Ginawa para sa production mula pa sa unang araw
Parehong mga panuntunan sa pagbura at pagpoproseso sa UK tulad ng website, kasama ang mga kontrol na inaasahan ng isang engineering team.
- Mga key na kontrolado moMga live at sandbox key, isang beses lang ipinapakita at iniimbak bilang hash. Bawiin ang anumang key mula sa iyong account.
- Mga nilagdaang webhookBawat delivery ay may dalang ?signature= na may HMAC-SHA256 ng body, na ginawa gamit ang iyong shared key.
- Mabilis na binubura ang mga fileItinatago ang mga file ng task nang 1 oras sa libreng account at 2 oras sa Pro at Business, saka mawawala ang mga ito. Agad itong inaalis ng DELETE.
- Pagpoproseso sa UKTumatakbo sa aming mga server sa London ang bawat task. Hindi kailanman iniimbak ng mga request log ang nilalaman o pangalan ng file.
- Patas na mga rate limit120 bagong task kada minuto bawat user, na may Retry-After sa bawat 429.
- Ligtas na mga retryMagpadala ng Idempotency-Key at ibabalik ng paulit-ulit na request ang unang resulta sa loob ng 24 oras.
Presyo
Magsimula nang libre. Magbayad habang lumalago.
Sandbox
£0
- Bawat endpoint, na may test data
- 10 request kada minuto
- Hanggang 5 pahina bawat task
- Mga output na may tatak na “Sandbox”
- Binubura ang test data pagkalipas ng 7 araw
Live, sa Pro o Business
Mula £4.99kada buwan, sinisingil taun-taon
- Gumagamit ng buwanang allowance ng iyong plan
- Pagkatapos ay credits: mula £5 para sa 500
- 1 credit bawat OCR page, 2 credit bawat conversion ng Office
- 120 bagong task kada minuto
Enterprise
Volume pricing
- Volume pricing sa mga pahina at conversion
- Mga custom na limitasyon, ibinebenta sa pamamagitan ng kontrata
- Taunang invoice billing
- Isang itinalagang contact
Mga tanong
Mga tanong ng mga developer
May libreng paraan ba para subukan ang API?
Oo. Maaaring gumawa nang libre ng sandbox key ang sinumang naka-sign in na user. Limitado ang mga tawag sa sandbox sa 10 kada minuto at 5 pahina bawat task, may tatak na “Sandbox” ang bawat output, at binubura ang test data pagkalipas ng 7 araw.
Aling mga tool ang maaari kong tawagin?
Ang 20 tool na tumatakbo sa aming mga server, mula Compress at OCR hanggang sa mga conversion ng Office at PDF/A, kasama ang mga e-signature. Inililista ng GET /tools ang mga ito kasama ang kanilang mga opsyon. Tumatakbo sa mga browser ng iyong mga user ang 20 browser tool, kaya wala ang mga ito sa API v1.
Paano sinisingil ang paggamit ng API?
Kasama sa Pro at Business ang mga live key. Gumagamit ang mga tawag ng parehong buwanang allowance tulad ng website; lampas doon, may credits na nalalapat. Nagsisimula sa £5 ang mga credit pack para sa 500 credits at tumatagal ng 12 buwan.
May mga SDK ba kayo?
May mga sample na maaaring kopyahin at i-paste sa curl, Node at Python para sa bawat endpoint ang dokumentasyon, pati OpenAPI 3.1 file at Postman collection, kaya makakabuo ka ng client sa anumang wika.
Ano ang mangyayari kung down ang aking webhook endpoint?
Susubukan namin ulit nang tatlong beses pa, pagkalipas ng 1 minuto, 10 minuto at 1 oras, saka namin mamarkahang pumalya ang delivery. Maaari mo itong ipadala ulit mula sa iyong account o gamit ang API.
Maglabas ng mga feature ng PDF ngayong linggo.
Gumawa ng sandbox key sa loob ng isang minuto. Hindi kailangan ng card.