po_sk_ Szerver közötti Titkos kulcs
- Teljes hozzáférés a fiók keretében
- Soha ne szolgáltatja ki böngésző kódhoz
- Nincs szükség Origin fejlécra
- MCP-hez zárolva
Hitelesítés és kulcsok
Egy Bearer-token. Minden végpont.
A PaperOffice-API minden termék-végpontja az Authorization: Bearer fejlécet várja. Nincs OAuth-folyamat, nincs frissítés.
Két token típus, tíz jogosultsági hatókör, dokumentált sebességkorlátok.
Egy fejléc Nincs OAuth-folyamat Bármikor visszavonható
- Saját EU-infrastruktúra Az adatai Európában maradnak.
- ISO 27001 aktív Biztonság tanúsítva.
- SOC 2 Type II aktív Nemzetközi auditstandardok.
- 24+ év tapasztalat Bepróbaált. Stabil. Jövőbiztos.
curl -X POST "https://api.paperoffice.ai/latest/job/add/workflow" \ -H "Authorization: Bearer po_ut_YOUR_API_KEY" \ -F "[email protected]" \ -F "idp_collection=invoice" \ -F "model=basic-pro-max"import requestsresponse = requests.post( "https://api.paperoffice.ai/latest/job/add/workflow", headers={"Authorization": "Bearer po_ut_YOUR_API_KEY"}, files={"file_1": open("invoice.pdf", "rb")}, data={"idp_collection": "invoice", "model": "basic-pro-max"},)print(response.json())const form = new FormData();form.append("file_1", new Blob([await readFile("invoice.pdf")]), "invoice.pdf");form.append("idp_collection", "invoice");form.append("model", "basic-pro-max");const response = await fetch("https://api.paperoffice.ai/latest/job/add/workflow", { method: "POST", headers: { Authorization: "Bearer po_ut_YOUR_API_KEY" }, body: form,});console.log(await response.json());Első hívás
Fejléc beállítása, pipeline kiválasztása, elküldés
A /latest/job/add/ elérési út a queue-job neve: általában handler___command formátumban (pl. paperoffice_aiocr___generate), strukturált IDP esetén a saját pipeline workflow.
- Egy fejléc
Authorization: Bearer po_ut_… — egy termék végpontnak ennyi elég. A po_sk_ és po_ut_ nem küldenek Origin-fejlécet.
- Pipeline az elérési útvonalban
handler___command három aláhúzással; a workflow kivétel, saját slug-gal. A pontozott szintaxis a API-at HTTP 400 JOB_CONFIG_INVALID hibával válaszolja meg.
- Eredmény vagy job_id
A client_wait alapértelmezetten true: A API fenntartja a kapcsolatot, és inline adja vissza az eredményt. Ha az időablak nem elegendő, HTTP 202 válasz érkezik job_id-val és poll_url-lel a GET /latest/job/get/{job_id} végponthoz.
Az idp_collection=invoice esetén a basic-pro-max az ajánlott modell: Az OCR-first alapértelmezetten basic-pro-max-ra korlátozza a nyomtatott gyűjteményeket pozíciókkal; egy elküldött model=premium kérés esetén is model: basic-pro-max kerül visszaadásra.
Token típusok
Két token típus, tisztán elválasztva
Mindkettőt a szerverre kell küldeni. Az alkalmazásban az Account → API menüpont alatt hozhatók létre, forgathatók és visszavonhatók.
po_ut_ Felhasználóhoz kötött User Token
- Egyes területekre korlátozható
- Soha ne szolgáltatja ki böngésző kódhoz
- Nincs szükség Origin-fejlécra
- MCP-hez engedélyezve
A böngészőből közvetlenül történő hívások nem ezen két tokenen keresztül futnak, hanem a publishable key (po_pk_) segítségével — eredethez kötött, költség- és sebességkorlátokkal. Publishable keys megtekintése
Engedélyek
Tíz terület felhasználói tokenenként
A felhasználói token pontosan azokat a területeket tartalmazza, amelyeket létrehozáskor adtunk meg neki. Ha egy terület hiányzik, a API HTTP 403-vallal válaszol.
- Dokumentumok
dokumentumokFeltöltés, letöltés, feldolgozás
- Workspaces
munkaterekMappák és struktúra kezelése
- AI feladatok
ai_jobsOCR, IDP, kinyerés
- Számlázás
számlázásHasználat és számlaállapot lekérése
- Felhasználók
felhasználókCsapattagok kezelése
- Webhookok
webhookokEsemények fogadása
- Tudásbázis
tudásbázisTudásbázis és GYIK
- Ügynökök
ügynökökIDP ügynökök konfigurálása
- Munkafolyamatok
munkafolyamatokAutomatizációk létrehozása
- Megfelelőség
megfelelőségEllenőrzés, GDPR, archiválás
Sebességkorlátok
Mi számít a API esetén
A díjazás tokenenként történik; Bearer nélkül IP-címenként. Az alábbi értékek a dokumentált minimumértékek, amelyek minden csomagban érvényesek.
- 5
- Kérések másodpercenként
- 30
- Kérések percenként
- 100
- Kérések óránként
- 500
- Kérések naponta
- A megmaradt értékek a válaszfejlécekben találhatók
A RateLimit-* és X-RateLimit-* fejlécek minden válasznál azt mutatják, hogy a jelenlegi ablakban mennyi még elérhető.
- Túllépés: HTTP 429
A API a RATE_LIMIT_EXCEEDED választ adja. Ismételje meg a kérést a Retry-After fejlécben megadott idő után.
- Magasabb csomagok növelik az értékeket
A fizetett tarifák ezen minimális értékek felett vannak. A tarifák terjedelme az oldalon található.
Biztonság
Mi véd egy kulcsot
Hat mechanizmus, amelyek a működtetés során érvényesülnek — mindegyik ellenőrizhető státuskóddal vagy az alkalmazásban található hellyel.
- Forgatás és visszavonás
A kulcsok az alkalmazásban az Account → API alatt kerülnek létrehozásra, felsorolásra, forgatásra és visszavonásra. Egy visszavont token HTTP 401 TOKEN_NOT_FOUND választ ad.
- Lejárat és érvényesség
A lejárt vagy hibás tokenek HTTP 401 INVALID_TOKEN hibával térnek vissza. A Publishable Keys legkésőbb 365 nap után járnak le.
- Korlátok tokenenként
A sebességkorlátok tokenenként, nem fiókonként számítanak. Egy kiszolgáltatott kulcs így nem terheli az egész üzemeltetést.
- Eredet-kötés a böngészőben
A Publishable Keys minden kérésnél engedélyezett eredetet igényelnek; ellenkező esetben a API 403 ORIGIN_HEADER_REQUIRED vagy DOMAIN_NOT_ALLOWED hibával válaszol.
- Használat nyomon követése
Minden elszámolt válasz tartalmaz egy _billing blokkot; a hívásonkénti kiértékeléshez a GET /latest/billing/usage-detail hívás szolgál.
- Szigorú letiltások
A böngészőkulcsok számára letiltva a fiókbejelentkezés, a kulcsmenedzsment, az OAuth, a partneradminisztráció, a fizetési módosítás és a jelszófeltörés. A termék-APIs (beleértve a számlázási olvasást és a webhookokat) engedélyezett. A Workspace törlése, a kukka ürítése és a jogi megőrzés feloldása csak az alkalmazáson keresztül lehetséges (403 UI_ONLY_ENDPOINT).
Videó
Hitelesítés a gyakorlatban
Nézze meg, hogyan működik egy Bearer-tokenes hívás a gyakorlatban — videóban.
További információk
A mellette lévő oldalak
Azok az oldalak, amelyek a hitelesítés körüli üzemeltetést lefedik.
Publishable Keys Hívások közvetlenül a böngészőből po_pk_ segítségével. Webhookok Események fogadása helyett lekérdezés. Postman-Kollekció Minden végpont kattintgatáshoz. API-Katalógus Melyik végpont mit csinál. llms-full.txt A teljes dokumentáció az IDE-dhez. Díjak Melyik díj milyen terjedelmet fedez.
Kezdés
Key létrehozása, fejléc beállítása, küldés
A Key-t az alkalmazásban az Account → API alatt hozhatja létre. Az első hívás lépésről lépésre a 'First API-Call' részben található.
Üzemeltetés és megbízhatóság
Mit ellenőriznek az enterprise csapatok az első hívás előtt
Szerződések, biztonság, támogatás és limitek, minden egy helyen összefoglalva.
- Biztonság és megfelelőség ISO 27001, SOC 2 Type II, saját EU-infrastruktúra.
- SLA 99,9% Havi elérhetőség, szerződésesen garantált.
- Adatfeldolgozási megállapodás (DPA) GDPR-nak megfelelő adatfeldolgozási szerződés.
- Al-vállalkozói lista Minden al-vállalkozó átláthatóan felsorolva.
- Műszaki támogatás Közvetlen elérhetőség a támogatási csapat felé, jegykezeléssel.
- Sebességkorlátok és fejlécek Dokumentált minimális értékek tokenenként, RateLimit-fejléc minden válaszban.
- Árak és Credits Átlátható Credit-árak hívásonként.
Következő állomás
Így haladjon tovább
Az ajánlott következő lépés a fejlesztői tölcsérben és két megfelelő elágazás.