Avtentifikacija in ključi

Bearer-token. Vsaka končna točka.

Vsaka produktna končna točka PaperOffice-API zahteva glavo Authorization: Bearer. Brez OAuth-poteka, brez osveževanja.

Dva tipa tokenov, deset dovoljenih obsegov, dokumentirane omejitve hitrosti.

Ustvarjanje ključa API Začetek prvega klica API

Ena glava Brez OAuth-poteka Poljubno preklicljivo

app.paperoffice.ai/account/api

Zahteva 200 OK Žeton veljaven

Glava Authorization

Authorization: Bearer po_ut_YOUR_API_KEY

Dovoljenja

ocr:read
documents:write
jobs:read

Odgovor

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

Lastna infrastruktura v EU Vaši podatki ostajajo v Evropi.
ISO 27001 aktiven Varnost certificirana.
Aktivno SOC 2 Type II Mednarodni standardi revizije.
Več kot 24 let izkušenj Preizkušeno. Stabilno. Prihodnost-varno.

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());

Prvi klic

Nastavite glavo, izberite cevovod, oddajte

Pot do /latest/job/add/ je ime čakalne vrste naloge: običajno v obliki handler___command (npr. paperoffice_aiocr___generate), za strukturirano IDP pa lastni delovni tok pipeline-a.

Ena glava
Authorization: Bearer po_ut_… — več produktovni končni točki ne potrebuje. po_sk_ in po_ut_ ne pošiljata glave Origin.
Cevovod v poti
handler___command s tremi podčrtaji; workflow je izjema z lastnim slugom. Točkovna notacija odgovori na API z HTTP 400 JOB_CONFIG_INVALID.
Rezultat ali job_id
client_wait je privzeto resnično: API vzdržuje povezavo in vrne rezultat v istem odzivu. Če časovno okno ne zadostuje, se vrne HTTP 202 z job_id in poll_url za GET /latest/job/get/{job_id}.

Oglejte si katalog API llms-full.txt za vaš IDE

Za idp_collection=invoice je basic-pro-max priporočeni model: OCR-first omeji tiskane zbiralnike s položaji dejansko na basic-pro-max; poslani model=premium se vrne kot model: basic-pro-max.

Vrste žetonov

Dve vrsti žetonov, jasno ločeni

Obe pripadata strežniku. Ustvarite jih, rotirajte in prekličite v aplikaciji pod Račun → API.

po_sk_ Strežnik do strežnika

Skrbni ključ

Poln dostop v okviru računa
Nikoli ne izdajajte v kodi brskalnika
Ni potreben glava Origin
Blokirano za MCP

Upravljanje skrivnega ključa

po_ut_ Uporabniško usmerjeno

User Token

Omejeno na posamezna območja
Nikoli ne izdajajte v kodi brskalnika
Ni potreben glave Origin
Dovoljeno za MCP

Ustvarjanje žetona uporabnika

Povabili neposredno iz brskalnika ne potekajo skozi ta dva žetona, temveč prek objavljenega ključa po_pk_ — vezan na izvor, z omejitvijo proračuna in števila klicev. Ogled Publishable Keys

Dovoljenja

Deset področij na žeton uporabnika

Žeton uporabnika nosi natanko tista področja, ki mu jih dodelite ob ustvarjanju. Če področje manjka, se vrne odgovor API z HTTP 403.

Dokumenti dokumenti
Nalaganje, prenos, obdelava
Workspaces delovni prostori
Upravljanje map in strukture
Naloge AI naloge_ai
OCR, IDP, ekstrakcija
Obračun računovodstvo
Pregled uporabe in stanja računa
Uporabniki uporabniki
Upravljanje članov ekipe
Spletni klici spletni klici
Sprejemanje dogodkov
Baza znanja znanstvena_baza
Zbirka znanja in pogosta vprašanja
Agenti agenti
Konfigurirajte IDP agente
Poteki dela delovni tokovi
Ustvarjajte avtomatizacije
Skladnost skladnost
Revizija, GDPR, arhiviranje

Omejitve hitrosti

Kaj šteje API

Zaračunavanje se izvaja na podlagi tokena; brez Bearerja po naslovu IP. Spodaj navedene vrednosti so dokumentirane minimalne vrednosti, ki veljajo v vsakem tarifi.

5: Zahteve na sekundo
30: Zahteve na minuto
100: Zahteve na uro
500: Zahteve na dan

Preostale vrednosti so v odgovornem glavi
Glave RateLimit-* in X-RateLimit-* vsakega odgovora kažejo, koliko je še na voljo v trenutnem oknu.
Prekoračitev: HTTP 429
API odgovarja z RATE_LIMIT_EXCEEDED. Ponovite klic po času iz glave Retry-After.
Višje tarife dvignejo vrednosti
Plačljivi tarifi so višji od teh minimalnih vrednosti. Kateri tarifni paket obsega kaj, je navedeno na strani s cenami.

Ogled tarif in obsega

Varnost

Kaj varuje ključ

Šest mehanizmov, ki delujejo v obratovanju — vsak s preverljivo kodo stanja ali lokacijo v aplikaciji.

Rotacija in odvzem veljavnosti
Ključi se ustvarijo, prikažejo, rotirajo in odvzamejo v aplikaciji pod Account → API. Odvzeti žeton vrne HTTP 401 TOKEN_NOT_FOUND.
Potek veljavnosti in veljavnost
Potečeni ali neveljavni tokeni se vrnejo kot HTTP 401 INVALID_TOKEN. Objavljeni ključi potečejo najkasneje po 365 dneh.
Omejitve na žeton
Omejitve hitrosti se štejejo na žeton, ne na račun. Kompromitiran ključ tako ne obremeni celotnega poslovanja.
Veza s poreklom v brskalniku
Objavljeni ključi zahtevajo pri vsaki zahtevi Origin iz dovoljenega seznama; sicer API odgovori z 403 ORIGIN_HEADER_REQUIRED ali DOMAIN_NOT_ALLOWED.
Sledenje uporabi
Vsak zaračunan odgovor vsebuje _billing-blok; ocena na poziv zagotavlja GET /latest/billing/usage-detail.
Trdne blokade
Prijava na račun, upravljanje ključev, OAuth, skrbništvo partnerjev, spremembe plačil in razbijanje gesla so za brskalnik ključev blokirani. Izdelki API vključno z branjem obračunavanja in spletnimi klici so dovoljeni. Workspace izbriši, prazni koš za smeti in sprosti pravno shranjevanje gre samo v aplikaciji (403 UI_ONLY_ENDPOINT).

Video

Avtentikacija v uporabi

Oglejte si, kako poteka klic z žetonom Bearer v praksi — na videu.

Naprej

Kar stoji ob strani

Strani, ki pokrivajo okolico avtentikacije.

Publishable Keys Pozivi neposredno iz brskalnika s po_pk_. Spletni kaveljčki Prejem dogodkov namesto poliranja. Postman-Kolekcija Vsi končni točki za brskanje. API-katalog Katera končna točka kaj opravlja. llms-full.txt Celotna dokumentacija za vaš IDE. Tarifi Kateri tarif nosi kateri obseg.

Začetek

Ustvarite ključ, nastavite glavo, pošljite

Ključ ustvarite v aplikaciji pod Račun → API. Prvi klic je korak za korakom opisan v prvem klicu API.

Ustvarjanje ključa API Začetek prvega klica API

Poslovanje in zaupanje

Kaj ekipe podjetij preverijo pred prvim klicem

Pogodbe, varnost, podpora in omejitve – vse povezane na enem mestu.

Naslednja postaja

Tako gre naprej

Priporočeni naslednji korak v developerjevem lijaku in dve ustrezni razvejitvi.

Webhooks & EventsDogodki v realnem času, HMAC Prvi klic API-jaPridobite ključ, pošljite zahtevo, preverite odgovor Postman CollectionUvoz, preizkus, odpravljanje napak v Postman

Nazaj na začetek za developrje

Razumite PaperOffice AI v 14 minutah.

Kako želite uporabljati PaperOffice?