Overovanie a kľúče

Bearer-token. Každý endpoint.

Každý produktový endpoint PaperOffice-API očakáva hlavičku Authorization: Bearer. Žiadny OAuth-flow, žiadne obnovenie.

Dva typy tokenov, desať oprávnených oblastí, zdokumentované limity rýchlosti.

Vytvoriť kľúč API Spustiť prvé volanie API

Jedna hlavička Žiadny OAuth-flow Kedykoľvek odvolateľné

app.paperoffice.ai/account/api

Požiadavka 200 OK Token platný

Autorizačná hlavička

Authorization: Bearer po_ut_YOUR_API_KEY

Oprávnenia

ocr:read
documents:write
jobs:read

Odpoveď

{
  "status": "success",
  "job_id": "8f2c1a…",
  "result": { "pages": 3 }
}

Vlastná infraštruktúra EÚ Vaše údaje zostávajú v Európe.
ISO 27001 aktívne Bezpečnosť certifikovaná.
SOC 2 Typ II aktívny Medzinárodné audítorské štandardy.
Viac ako 24 rokov skúseností Overené. Stabilné. Budúcnosť zabezpečené.

cURL

1curl -X POST "https://api.paperoffice.ai/latest/job/add/workflow" \2  -H "Authorization: Bearer po_ut_YOUR_API_KEY" \3  -F "[email protected]" \4  -F "idp_collection=invoice" \5  -F "model=basic-pro-max"

1import requests23response = requests.post(4    "https://api.paperoffice.ai/latest/job/add/workflow",5    headers={"Authorization": "Bearer po_ut_YOUR_API_KEY"},6    files={"file_1": open("invoice.pdf", "rb")},7    data={"idp_collection": "invoice", "model": "basic-pro-max"},8)9print(response.json())

1const form = new FormData();2form.append("file_1", new Blob([await readFile("invoice.pdf")]), "invoice.pdf");3form.append("idp_collection", "invoice");4form.append("model", "basic-pro-max");56const response = await fetch("https://api.paperoffice.ai/latest/job/add/workflow", {7  method: "POST",8  headers: { Authorization: "Bearer po_ut_YOUR_API_KEY" },9  body: form,10});11console.log(await response.json());

Prvý výzva

Nastaviť hlavičku, vybrať pipeline, odoslať

Cesta k /latest/job/add/ je názov frontového úlohy: zvyčajne v tvare handler___command (napr. paperoffice_aiocr___generate), pre štruktúrované IDP vlastná pipeline workflow.

Jedna hlavička
Authorization: Bearer po_ut_… — viac produktový endpoint nepotrebuje. po_sk_ a po_ut_ neposielajú Origin-hlavičku.
Pipeline v ceste
handler___command so tromi podčiarkovníkmi; workflow je výnimka s vlastným slugom. Bodová notácia odpovedá API s HTTP 400 JOB_CONFIG_INVALID.
Výsledok alebo job_id
client_wait je predvolené true: API udržiava pripojenie a vracia výsledok inline. Ak časové okno nestačí, vráti sa HTTP 202 s job_id a poll_url pre GET /latest/job/get/{job_id}.

Zobraziť katalóg API llms-full.txt pre vašu IDE

Pre idp_collection=invoice je basic-pro-max odporúčaný model: OCR-first obmedzuje tlačené zbierky s pozíciami aj tak na basic-pro-max; odoslaný model=premium sa vráti ako model: basic-pro-max.

Typy tokenov

Dva typy tokenov, jasne oddelené

Oba patria na server. Vytvárajú sa, rotujú a rušia v aplikácii pod Účet → API.

po_sk_ Server-to-server

Tajný kľúč

Plný prístup v rámci účtu
Neposkytovať v kóde prehliadača
Nie je potrebný originálny hlavičkový riadok
Pre MCP zablokované

Spravovať tajný kľúč

po_ut_ Podľa používateľa

User Token

Obmedzené na jednotlivé oblasti
Nedodávať do kódu prehliadača
Nie je potrebný Origin-header
Povolené pre MCP

Vytvoriť používateľský token

Volania priamo z prehliadača neprebiehajú cez tieto dva tokeny, ale cez Publishable Key po_pk_ — viazaný na pôvod, s rozpočtovým a počtom požiadaviek obmedzením. Zobraziť Publishable Keys

Oprávnenia

Desať oblastí pre každý používateľský token

Používateľský token obsahuje presne tie oblasti, ktoré mu pridelíte pri vytváraní. Ak chýba oblasť, vráti sa odpoveď API s HTTP 403.

Dokumenty dokumenty
Nahrať, Stiahnuť, Spracovanie
Workspaces priestorové priestory
Spravovať priečinky a štruktúru
AI úlohy ai_jobs
OCR, IDP, Extrakcia
Fakturácia faktúrovanie
Čítať používanie a zostatok účtu
Používatelia používatelia
Spravovať členov tímu
Webhooky webhooky
Prijímať udalosti
Znalostná základňa zberatelná_databáza
Databáza vedomostí a FAQ
Agenti agenti
Konfigurácia IDP agentov
Pracovné postupy pracovné postupy
Vytváranie automatizácií
Súlad s predpismi zlučnosť
Audit, GDPR, archivácia

Obmedzenia rýchlosti

Čo API počíta

Zúčtovanie prebieha na základe tokenov; bez Bearera podľa IP adresy. Nasledujúce hodnoty sú zdokumentované minimálne hodnoty, ktoré platia v každom tarife.

5: Požiadavky za sekundu
30: Požiadavky za minútu
100: Požiadavky za hodinu
500: Požiadavky za deň

Zvyškové hodnoty sú v hlavičke odpovede
Hlavičky RateLimit-* a X-RateLimit-* každej odpovede uvádzajú, koľko zostáva vo aktuálnom okne.
Prekročenie: HTTP 429
API odpovedá s RATE_LIMIT_EXCEEDED. Opakujte požiadavku po čase uvedenom v hlavičke Retry-After.
Vyššie tarify zvyšujú hodnoty
Platené tarify sú nad týmit minimálnymi hodnotami. Ktorý tarif má aký rozsah, je uvedené na strane s cenami.

Zobraziť tarify a rozsah

Bezpečnosť

Čo zabezpečuje kľúč

Šesť mechanizmov, ktoré fungujú v prevádzke – každý s overiteľným stavovým kódom alebo miestom v aplikácii.

Rotácia a zrušenie platnosti
Kľúče sa vytvárajú, zobrazujú, rotujú a rušia v aplikácii pod Účet → API. Zrušený token odpovedá HTTP 401 TOKEN_NOT_FOUND.
Platnosť a expirácia
Expirované alebo chybné tokeny vracajú HTTP 401 INVALID_TOKEN. Publishable Keys expirujú najneskôr po 365 dňoch.
Limity na token
Rate obmedzenia sa počítajú na token, nie na účet. Kompromitovaný kľúč tak nezaťažuje celý prevádzku.
Viazanosť pôvodu v prehliadači
Publishable keys vyžadujú pri každej požiadavke origin z allowlistu; inak odpovie API s 403 ORIGIN_HEADER_REQUIRED alebo DOMAIN_NOT_ALLOWED.
Sledovanie využitia
Každá fakturovaná odpoveď obsahuje _billing-blok; vyhodnotenie na požiadanie poskytuje GET /latest/billing/usage-detail.
Prísne zablokovania
Prihlásenie do účtu, správa kľúčov, OAuth, partner-admin, zmena platby a cracking hesla sú pre prehliadačové kľúče zablokované. Produkt APIs vrátane čítania fakturácie a webhookov je povolený. Odstránenie Workspace, vyprázdnenie koša a uvoľnenie právneho držania sú možné iba v aplikácii (403 UI_ONLY_ENDPOINT).

Video

Autentifikácia v praxi

Pozrite si, ako funguje výzov s bearer tokenom v praxi — vo videu.

Pokračovanie

Čo je vedľa

Stránky, ktoré pokrúcajú prevádzku okolo autentifikácie.

Publishable Keys Volania priamo z prehliadača s po_pk_. Webhooky Prijímať udalosti namiesto pravidelného dotazovania. Postman-Kolekcia Všetky endpointy na prehliadanie. API-Katálogo Ktorý endpoint akú prácu vykonáva. llms-full.txt Celá dokumentácia pre vaše IDE. Tarify Aký tarif nesie aký rozsah.

Začať

Vytvoriť kľúč, nastaviť hlavičku, odoslať

Kľúč vytvoríte v aplikácii pod Účet → API. Prvý výzov je krok za krokom popísaný v prvom volaní API.

Vytvoriť kľúč API Spustiť prvé volanie API

Prevádzka a dôvera

Čo enterprise tímy skontrolujú pred prvým hovorom

Zmluvy, bezpečnosť, podpora a limity, všetko prepojené na jednom mieste.

Ďalšia zastávka

Ako pokračovať

Odporúčaný ďalší krok vo vývojárskom lieviky a dve vhodné odbočky.

Webhooks & EventsUdalosti v reálnom čase, HMAC Prvé volanie APIZískať kľúč, poslať požiadavku, skontrolovať odpoveď Postman CollectionImportovať, testovať, ladiť v Postmane

Späť na vstup pre vývojárov

Pochopte PaperOffice AI za 14 minút.

Ako si želáte PaperOffice používať?