PDF API
Fara kyauta

PDF API na Macaaw

PDF API don matsawa, sauyawa da sa hannu

REST API ɗaya don kayan aikin PDF 20 da sa hannu na lantarki. Kowane aiki yana gudana a sabobinmu a London kuma ana goge fayilolin cikin awa 2.

Sami makullin gwaji kyautaKaranta takardun bayani na API

  • OpenAPI 3.1
  • Tarin Postman
  • Gwaji kyauta
  • Webhooks masu sa hannu
Matsa PDF da buƙata ɗaya
Harshen samfurin lamba
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"}
  • 20kayan aikin PDF a wurin haɗi ɗaya
  • Kira 1don ɗorawa da fara aiki
  • < 2 hhar a goge fayilolinka
  • £ 0ga gwaji

Abin da za ka iya ginawa

Ayyukan PDF da bai kamata samfurinka ya mallake su ba

  • Rage abubuwan da aka ɗora kafin ka ajiye su

    Matsa PDF, ko ka daidaita su ƙarƙashin daidai girman da ake so, da zarar masu amfaninka sun ɗora su.

  • Sauya fayilolin Office zuwa PDF

    Word, Excel, PowerPoint, OpenDocument da HTML zuwa PDF, tare da tsari da ke tsayawa.

  • Sa dubawa ta zama mai iya nema

    Gane rubutu a harsuna 27, PDF/A don adanawa, da teburori kai tsaye zuwa Excel.

  • Aika yarjejeniyoyi daga manhajarka

    Ƙirƙiri takarda daga PDF, sanya filaye da alamomin rubutu, aika ta ka sauke kwafin da aka sa wa hannu.

  • Saka sa hannu cikin samfurinka

    Buɗe zaman sa hannu a cikin shafinka, an iyakance shi ga asalin da ka yarda.

  • Gudanar da tarin ayyuka da webhooks

    Fara ayyuka ɗaruruwa ka sami kira da sa hannu idan kowanne ya ƙare.

Yadda yake aiki

Daga makulli zuwa sakamako cikin kira huɗu

  1. Ƙirƙiri makulli

    Ƙirƙiri makullin gwaji a asusunka. Koma makullin aiki na gaske idan ka shirya.

    Asusu › Mai haɓakawa
  2. Fara aiki

    Aika fayilolin da kayan aikin cikin buƙata ɗaya ta multipart.

    POST /public/v1/tasks
  3. Ji idan an gama

    Yi rajista ga task_completed, ko ka riƙa tambayar aikin.

    webhook: task_completed
  4. Sauke

    Ɗauki sakamakon, sannan ka goge shi ko ka bar shi ya ƙare.

    GET /tasks/{id}/download

Wuraren haɗi

API ƙarami mai tsinkaya

Base URL https://macaaw.com/public/v1 · JSON mai makullan snake_case · Authorization: API-Key …

Cikakken bayanin API

Ayyuka · kayan aikin PDF

  • GET/toolsKowane kayan aiki da za ka iya kira, tare da zaɓukansa
  • POST/tasksƊora fayiloli ka fara kayan aiki da kira ɗaya
  • GET/tasks/{id}Matsayi: a jere, ana sarrafawa, an kammala ko ya gaza
  • GET/tasks/{id}/downloadFayil ɗin sakamako, ko ZIP
  • DELETE/tasks/{id}Goge fayilolin yanzu

Takardu · sa hannu na lantarki

  • POST/documentsPDF tare da masu karɓa da filaye, ko alamomin rubutu
  • POST/documents/{id}/sendAika ta imel, ko a shiru don sa hannu a cikin shafi
  • GET/documents/{id}/detailsMasu karɓa, filaye da cikakken jerin abubuwan da suka faru
  • POST/documents/{id}/sessionHanyar haɗin sa hannu don shafinka
  • GET/documents/{id}/downloadPDF da aka sa wa hannu tare da takardar shaidarsa

Webhooks

  • POST/webhook-subscriptionsZaɓi abubuwan da ke jawo aiki kamar task_completed ko document_state_changed
  • GET/webhook-eventsTarihin isarwa, tare da sake aikawa

Tsaro

An gina shi don aiki na gaske tun rana ta farko

Ƙa’idojin gogewa da sarrafawa a UK iri ɗaya da gidan yanar gizo, tare da sarrafawar da ƙungiyar injiniyoyi ke tsammani.

  • Makullan da kake sarrafawaMakullan aiki na gaske da na gwaji, ana nuna su sau ɗaya kuma ana ajiye su a matsayin hash. Soke kowane makulli daga asusunka.
  • Webhooks masu sa hannuKowane isarwa yana ɗauke da ?signature= tare da HMAC-SHA256 na abin da aka aika, wanda aka yi da makullinka da aka raba.
  • Ana goge fayiloli da sauriAna riƙe fayilolin aiki awa 1 a asusu na kyauta da awa 2 a Pro da Business, sannan su ɓace. DELETE yana cire su nan take.
  • Sarrafawa a UKKowane aiki yana gudana a sabobinmu a London. Rajistar buƙatu ba ta taɓa ajiye abin da ke cikin fayiloli ko sunayensu ba.
  • Iyakokin adadi masu adalciSababbin ayyuka 120 a minti ɗaya ga kowane mai amfani, tare da Retry-After a kowane 429.
  • Sake gwadawa lafiyaAika Idempotency-Key kuma buƙatar da aka maimaita tana mayar da sakamakon farko na awa 24.

Farashi

Fara kyauta. Biya yayin da kake girma.

Gwaji (Sandbox)

£ 0

  • Kowane wurin haɗi, da bayanan gwaji
  • Buƙatu 10 a minti ɗaya
  • Har shafuka 5 ga kowane aiki
  • Sakamako da aka sanya wa alamar “Sandbox”
  • Ana goge bayanan gwaji bayan kwana 7
Sami makullin gwaji

Na aiki na gaske, a Pro ko Business

Daga £ 4.99a wata, ana biya a shekara

  • Yana amfani da hakkokin wata na tsarinka
  • Sannan kuɗin sarrafawa: daga £ 5 don 500
  • kuɗin sarrafawa 1 ga kowane shafin OCR, kuɗin sarrafawa 2 ga kowane sauya tsarin Office
  • Sababbin ayyuka 120 a minti ɗaya
Kwatanta tsare-tsare

Enterprise

Farashin yawa

  • Farashin yawa a kan shafuka da sauyawa
  • Iyakoki na musamman, ana sayarwa ta kwangila
  • Biyan takardar kuɗi ta shekara
  • Mutum da aka sa wa suna don tuntuɓa
Yi magana da mu

Tambayoyi

Masu haɓakawa suna tambaya

Akwai hanyar gwada API kyauta?

Eh. Kowane mai amfani da ya shiga zai iya ƙirƙirar makullin gwaji kyauta. Kiran gwaji an iyakance shi zuwa 10 a minti ɗaya da shafuka 5 ga kowane aiki, ana sanya wa kowane sakamako alamar “Sandbox”, kuma ana goge bayanan gwaji bayan kwana 7.

Waɗanne kayan aiki zan iya kira?

Kayan aiki 20 da ke gudana a sabobinmu, daga Matsa da OCR zuwa sauya tsarin Office da PDF/A, tare da sa hannu na lantarki. GET /tools yana lissafa su tare da zaɓukansu. Kayan aikin burauza 20 suna gudana a burauzar masu amfaninka, don haka ba sa cikin API v1.

Yaya ake caji don amfani da API?

Makullan aiki na gaske suna zuwa da Pro da Business. Kiran yana amfani da hakkokin wata iri ɗaya da gidan yanar gizo; bayan haka, ana amfani da kuɗin sarrafawa. Fakitin kuɗin sarrafawa suna farawa daga £ 5 don kuɗin sarrafawa 500 kuma suna ɗaukar watanni 12.

Kuna da SDK?

Takardun bayani suna da samfuran kwafi-da-liƙa a curl, Node da Python ga kowane wurin haɗi, fayil ɗin OpenAPI 3.1 da tarin Postman, don haka za ka iya samar da abokin hulɗa a kowane harshe.

Me zai faru idan wurin haɗin webhook ɗina ya daina aiki?

Muna sake gwadawa sau uku, bayan minti 1, minti 10 da awa 1, sannan mu yi wa isarwar alamar ta gaza. Za ka iya sake aika ta daga asusunka ko da API.

Kaddamar da siffofin PDF a wannan mako.

Ƙirƙiri makullin gwaji cikin minti ɗaya. Ba a buƙatar kati.