API & SDKs — a11yfy

Példahívás

curl -X POST https://a11yfy.com/v1/jobs \
  -H "Authorization: Bearer $A11YFY_API_KEY" \
  -F "file=@szabalyzat.pdf" \
  -F "webhook_url=https://pelda.hu/hooks/a11yfy"

# {"job_id": "job_01HX…", "status": "queued"}

curl https://a11yfy.com/v1/jobs/job_01HX… \
  -H "Authorization: Bearer $A11YFY_API_KEY"

curl -OJ https://a11yfy.com/v1/jobs/job_01HX…/result \
  -H "Authorization: Bearer $A11YFY_API_KEY"

from a11yfy import A11yfy

client = A11yfy(token="ak_live_...")        # vagy az A11YFY_API_KEY változóból
result = client.remediate("szabalyzat.pdf") # feltöltés + várakozás + eredmény
print(result.output_url)                    # a javított PDF letöltési linkje
if result.certificate:
    print(result.certificate.verify_url)

import { A11yfyClient } from "@a11yfy/sdk";

const client = new A11yfyClient({ token: process.env.A11YFY_API_KEY! });
const result = await client.remediate("szabalyzat.pdf");
console.log(result.output_url);

Hogyan illeszkedik a stack-edbe

Feltöltéskor — javítsd a dokumentumokat abban a pillanatban, amikor a felhasználóid vagy rendszereid publikálják őket.
Kötegelve — dolgozz végig egy hátralékot mappáról mappára, ugyanazzal az oldalankénti árazással.
A termékedben — add vissza ugyanazt a PDF/UA-1 kimenetet és hibaszintű riportot a saját felhasználóidnak, a saját felületed alatt.

A folyamat

POST /v1/jobs — küldj be egy PDF-et multipart fájlként, opcionálisan egy webhook_url-lel. Azonnal visszakapsz egy job_id-t. A szerver ezután a teljes pipeline-t automatikusan lefuttatja — diagnózis, címkézés vagy teljes újraépítés, majd validálás — és a dokumentumnak megfelelő kreditet levonja.
Kövesd az állapotot — GET /v1/jobs/{id} pollozással, vagy ha megadtál webhook_url-t, aláírt értesítést kapsz, amint a munka végállapotba ér.
GET /v1/jobs/{id}/result — töltsd le a PDF/UA-1 szerint címkézett kimenetet és a hozzá tartozó hibaszintű ellenőrzési riportot.

A számlázásod és a monitorozásod bekötéséhez használd a GET /v1/balance (kredit-egyenleg) és a GET /v1/usage (felhasználás) végpontokat.

Hivatalos SDK-k: Python és npm

Ha nem akarsz kézzel HTTP-hívásokat írni, használd a hivatalos klienskönyvtárakat — mindkettő a fenti v1 API vékony, típusozott burkolata:

Python — az a11yfy csomag a PyPI-on: pip install a11yfy
JavaScript / TypeScript — az @a11yfy/sdk csomag az npm-en: npm install @a11yfy/sdk

Mindkét SDK nyílt forráskódú: github.com/a11yfy/sdk.

Miért érdemes a saját rendszeredbe építeni

Nyelvfüggetlen REST. Nincs kötelező SDK: bármely nyelvből egy HTTP-hívás — a fájlt multipart/form-data-ként küldöd.
Aszinkron, webhookkal. Nem kell pollozni: a saját workflow-d a végállapotra ébred, az értesítés kriptográfiailag aláírt.
Idempotens beküldés. Ugyanaz a fájl véletlen újraküldésre sem számláz kétszer.
Közös főkönyv. Az API-kulcsok csapat-hatáskörűek; a felhasználás ugyanabban a munkaterületi keretben jelenik meg, mint a webes feltöltések.
EU-s feldolgozás, automatikus törlés. A bemenetek 7, a kimenetek 30 nap után törlődnek — beavatkozás nélkül.

Gyakorlati tudnivalók

A v1 API angolul válaszol; a dokumentum nyelvi kezelése (alt szöveg, metaadatok) a dokumentumot követi, nem az API locale-t.
A kreditek a webes árazással azonosak: technikai javítás és teljes újraépítés oldalanként, a dokumentum profilja szerint.

API referencia → · Árazás →