API ya PDF ya Macaaw
API ya PDF ya kubana, kubadilisha na kutia sahihi
API moja ya REST kwa zana 20 za PDF na sahihi za kielektroniki. Kila kazi huendeshwa kwenye seva zetu London na faili hufutwa ndani ya saa 2.
Pata ufunguo wa sandbox bureSoma nyaraka za API
- OpenAPI 3.1
- Mkusanyiko wa Postman
- Sandbox ya bure
- Webhooks zilizosainiwa
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"}- 20zana za PDF kwenye endpoint moja
- Mwito 1kupakia na kuanzisha kazi
- < 2 hhadi faili zako zifutwe
- £ 0kwa sandbox
Unachoweza kujenga
Kazi za PDF ambazo bidhaa yako haipaswi kuzimiliki
Punguza ukubwa wa upakiaji kabla ya kuhifadhi
Bana PDF, au zitoshe chini ya ukubwa kamili, mara tu watumiaji wako wanapozipakia.
Badilisha faili za Office kuwa PDF
Word, Excel, PowerPoint, OpenDocument na HTML kwenda PDF, kwa mipangilio inayodumu.
Fanya skani zitafutike
Utambuzi wa maandishi katika lugha 27, PDF/A kwa kumbukumbu, na majedwali moja kwa moja hadi Excel.
Tuma makubaliano kutoka kwenye programu yako mwenyewe
Unda hati kutoka kwenye PDF, weka sehemu kwa lebo za maandishi, itume na upakue nakala iliyosainiwa.
Jumuisha kusaini kwenye bidhaa yako
Fungua kipindi cha kusaini ndani ya tovuti yako, kikiwekewa mipaka kwa asili ulizoruhusu.
Endesha makundi kwa webhooks
Anzisha mamia ya kazi na upate callback iliyosainiwa kila moja inapokamilika.
Jinsi inavyofanya kazi
Kutoka ufunguo hadi matokeo kwa miito minne
Unda ufunguo
Tengeneza ufunguo wa sandbox kwenye akaunti yako. Badilisha kwenda ufunguo halisi ukiwa tayari.
Akaunti › MsanidiAnzisha kazi
Tuma faili na zana kwa ombi moja la multipart.
POST /public/v1/tasksJua inapokamilika
Jisajili kwa task_completed, au uulize hali ya kazi mara kwa mara.
webhook: task_completedPakua
Pata matokeo, kisha uyafute au uyaache yaishe muda.
GET /tasks/{id}/download
Endpoints
API ndogo, inayotabirika
URL ya msingi https://macaaw.com/public/v1 · JSON yenye funguo za snake_case · Authorization: API-Key …
Kazi · zana za PDF
- GET
/toolsKila zana unayoweza kuita, pamoja na chaguo zake - POST
/tasksPakia faili na uanzishe zana kwa mwito mmoja - GET
/tasks/{id}Hali: queued, processing, completed au failed - GET
/tasks/{id}/downloadFaili ya matokeo, au ZIP - DELETE
/tasks/{id}Futa faili sasa
Hati · sahihi za kielektroniki
- POST
/documentsPDF pamoja na wapokeaji na sehemu, au lebo za maandishi - POST
/documents/{id}/sendTuma kwa barua pepe, au kimya kimya kwa kusaini kulikojumuishwa - GET
/documents/{id}/detailsWapokeaji, sehemu na ratiba kamili - POST
/documents/{id}/sessionKiungo cha kusaini kwa ukurasa wako mwenyewe - GET
/documents/{id}/downloadPDF iliyosainiwa pamoja na cheti chake
Webhooks
- POST
/webhook-subscriptionsChagua vichochezi kama task_completed au document_state_changed - GET
/webhook-eventsHistoria ya uwasilishaji, na kutuma tena
Usalama
Imeundwa kwa matumizi halisi tangu siku ya kwanza
Sheria zilezile za kufuta na uchakataji wa UK kama tovuti, pamoja na vidhibiti ambavyo timu ya uhandisi inatarajia.
- Funguo unazozidhibitiFunguo halisi na za sandbox, huonyeshwa mara moja na kuhifadhiwa kama hash. Batilisha ufunguo wowote kutoka kwenye akaunti yako.
- Webhooks zilizosainiwaKila uwasilishaji hubeba ?signature= yenye HMAC-SHA256 ya mwili wa ombi, iliyotengenezwa kwa ufunguo wako ulioshirikiwa.
- Faili hufutwa harakaFaili za kazi huhifadhiwa saa 1 kwenye akaunti ya bure na saa 2 kwenye Pro na Business, kisha hupotea. DELETE huziondoa mara moja.
- Uchakataji wa UKKila kazi huendeshwa kwenye seva zetu London. Kumbukumbu za maombi hazihifadhi kamwe maudhui ya faili wala majina ya faili.
- Vikomo vya kiwango vya hakiKazi mpya 120 kwa dakika kwa kila mtumiaji, na Retry-After kwenye kila 429.
- Kujaribu tena kwa usalamaTuma Idempotency-Key na ombi lililorudiwa litarudisha matokeo ya kwanza kwa saa 24.
Bei
Anza bure. Lipa unapokua.
Sandbox
£ 0
- Kila endpoint, kwa data ya majaribio
- Maombi 10 kwa dakika
- Hadi kurasa 5 kwa kila kazi
- Matokeo yanawekwa alama “Sandbox”
- Data ya majaribio hufutwa baada ya siku 7
Halisi, kwenye Pro au Business
Kuanzia £ 4.99kwa mwezi, inatozwa kila mwaka
- Hutumia viwango vya kila mwezi vya mpango wako
- Kisha salio: kuanzia £ 5 kwa 500
- Salio 1 kwa kila ukurasa wa OCR, salio 2 kwa kila ubadilishaji wa Office
- Kazi mpya 120 kwa dakika
Enterprise
Bei za kiasi
- Bei za kiasi kwa kurasa na ubadilishaji
- Vikomo maalum, vinauzwa kwa mkataba
- Malipo ya ankara ya kila mwaka
- Mtu wa kuwasiliana naye aliyetajwa
Maswali
Wasanidi huuliza
Je, kuna njia ya bure ya kujaribu API?
Ndiyo. Mtumiaji yeyote aliyeingia anaweza kuunda ufunguo wa sandbox bure. Miito ya sandbox imewekewa kikomo cha 10 kwa dakika na kurasa 5 kwa kila kazi, kila towe linawekwa alama “Sandbox”, na data ya majaribio hufutwa baada ya siku 7.
Ninaweza kuita zana zipi?
Zana 20 zinazoendeshwa kwenye seva zetu, kuanzia Bana na OCR hadi ubadilishaji wa Office na PDF/A, pamoja na sahihi za kielektroniki. GET /tools huziorodhesha pamoja na chaguo zake. Zana 20 za kivinjari huendeshwa kwenye vivinjari vya watumiaji wako, kwa hiyo hazimo kwenye API v1.
Matumizi ya API yanatozwaje?
Funguo halisi huja na Pro na Business. Miito hutumia viwango vilevile vya kila mwezi kama tovuti; zaidi ya hivyo, salio hutumika. Vifurushi vya salio huanza kwa £ 5 kwa salio 500 na hudumu miezi 12.
Je, mna SDK?
Nyaraka zina sampuli za kunakili na kubandika kwa curl, Node na Python kwa kila endpoint, faili ya OpenAPI 3.1 na mkusanyiko wa Postman, kwa hiyo unaweza kutengeneza mteja kwa lugha yoyote.
Nini hutokea endpoint yangu ya webhook ikiwa haipatikani?
Tunajaribu tena mara tatu zaidi, baada ya dakika 1, dakika 10 na saa 1, kisha tunaweka alama kwamba uwasilishaji umeshindwa. Unaweza kuutuma tena kutoka kwenye akaunti yako au kwa API.
Toa vipengele vya PDF wiki hii.
Unda ufunguo wa sandbox kwa dakika moja. Hakuna kadi inayohitajika.