Autentitseerimine ja võtmed

Bearer-token. Iga lõpppunkt.

Iga PaperOffice-API tootelõpppunkt ootab päise Authorization: Bearer. Puudub OAuth-vool, puudub värskendamine.

Kaks tokenitüüpi, kümme õigustegurit, dokumenteeritud kiiruspiirangud.

API-võtme loomine Esimese API-kutse käivitamine

Üks päis OAuth-i voolu puudumine Igahet tühistatav

app.paperoffice.ai/account/api

Päring 200 OK Token kehtib

Autoriseerimise päis

Authorization: Bearer po_ut_YOUR_API_KEY

Õigused

ocr:read
documents:write
jobs:read

Vastus

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

Oma EL-i infrastruktuur Teie andmed jäävad Euroopasse.
ISO 27001 aktiivne Turvalisuse sertifitseerimine.
SOC 2 tüüp II aktiivne Rahvusvahelised audiitistandardid.
24+ aastat kogemust Proovile pandud. Stabiilne. Tulevikukindel.

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

Esimene kutse

Päise seadmine, torustiku valimine, saatmine

Teek /latest/job/add/ on järjekorra töö nimi: tavaliselt kujul handler___command (nt paperoffice_aiocr___generate), struktureeritud IDP puhul oma torustiku töövoog.

Üks päis
Authorization: Bearer po_ut_… — rohkem ei vaja toote otspunkt. po_sk_ ja po_ut_ ei saata päise Origin.
Torustik tees
handler___command kolme alakriipsuga; töövoog on erand oma slugiga. Punkti kirjutamine vastab API-le HTTP 400 JOB_CONFIG_INVALID-ga.
Tulemus või job_id
client_wait on vaikeaimena true: API hoiab ühenduse avana ja tagastab tulemuse inline. Kui aken ei piisa, saadetakse HTTP 202 koos job_id ja poll_url-ga GET /latest/job/get/{job_id} jaoks.

Vaadake API kataloogi llms-full.txt teie IDE jaoks

idp_collection=invoice puhul on basic-pro-max soovitatud mudel: OCR-first piirab trükitud kogumeid positsioonidega ikka basic-pro-max-ile, saadetud model=premium tagastatakse kui model: basic-pro-max.

Tokeni tüübid

Kaks tokenitüüpi, selgelt eraldatud

Mõlemad kuuluvad serverile. Need luuakse, pööratakse ja tühistatakse rakenduses konto → API kaudu.

po_sk_ Serveristme-server

Salajane võti

Täielik ligipääs konto raames
Ära kunagi brauseri koodis edasta
Origin-päise pole vaja
MCP jaoks blokeeritud

Salajase võtme haldamine

po_ut_ Kasutajapõhine

User Token

Piirata saab üksikutele valdkondadele
Ära kunagi brauseri koodis edasta
Ei vaja Origin-päist
MCP-le lubatud

Kasutaja tokeni loomine

Brauserist otse tehtud päringud ei läbi nende kahe tokeni, vaid avaliku võtme po_pk_ kaudu — päritolupõhine, eelarve- ja kiirusega piiratud. Publishable Keys vaatamine

Õigused

Kümne valdkonda igale kasutaja tokenile

Kasutaja token sisaldab täpselt neid valdkondi, mida talle loomisel määratakse. Kui valdkond puudub, vastab API HTTP 403-ga.

Dokumendid dokumendid
Üles laadimine, allalaadimine, töötlemine
Workspaces tööruumid
Kaustade ja struktuuri haldamine
AI-tööd ai_tööd
OCR, IDP, eraldamine
Arveldus arveldus
Kasutuse ja konto saldo lugemine
Kasutajad kasutajad
Meeskonnaliikmete haldamine
Webhookid võrgukonksud
Sündmuste vastuvõtmine
Teabebaas teadmiste_pank
Teabebaas ja KKK
Agentid agentid
IDP agentide seadistamine
Töövoogud töövoogud
Automaatsete protsesside loomine
Vastavusnõuete täitmine compliance
Audit, GDPR, arhiveerimine

Kiiruspiirangud

Mida API loeb

Arvutamine toimub tokeni kaupa; ilma Bearer-ta IP-aadressi kohta. Järgmised väärtused on dokumenteeritud miinimumväärtused, mis kehtivad igas tarifi puhul.

5: Päringuid sekundis
30: Päringuid minutis
100: Päringuid tunnis
500: Päringuid päevas

Järelejäänud väärtused vastuse päises
Iga vastuse päised RateLimit-* ja X-RateLimit-* näitavad, kui palju on praeguses aknas veel kasutada.
Ületamine: HTTP 429
API vastab RATE_LIMIT_EXCEEDED-ga. Korrake päringut pärast Retry-After-päises määratud aega.
Kõrgemad tarifid tõstavad väärtusi
Tasutud hinnakirjad asuvad nende miinimumväärtuste kohal. Milline hinnakiri millise mahuga on, on toodud hinnalehel.

Hinnakirjade ja mahu vaatamine

Turvalisus

Mida võti kindlustab

Kuus mehhanismi, mis töös toimivad — igaüks oma kontrollitava staatusekoodi või rakenduses asuva kohaga.

Pööramine ja tühistamine
Võtmed luuakse, loetletakse, pööratakse ja tühistatakse rakenduses konto → API all. Tühistatud token vastab HTTP 401 TOKEN_NOT_FOUND-ga.
Aegumine ja kehtivus
Aegunud või vigased tokenid tagastatakse kui HTTP 401 INVALID_TOKEN. Avaldatavad võtmed aeguvad hiljemalt pärast 365 päeva.
Piirangud tokeni kohta
Määrake piirangud loendatakse iga tokeni kohta, mitte konto kohta. Kompromiteeritud võti ei koorma kogu operatsiooni.
Päritolu sidumine brauseris
Avaldatavad võtmed nõuavad igal päringul Origin-i lubatud loendist; muidu vastab API 403 ORIGIN_HEADER_REQUIRED või DOMAIN_NOT_ALLOWED-ga.
Kasutuse jälgimine
Iga arvestatud vastus sisaldab _billing-plokki; iga päringu hindamine annab GET /latest/billing/usage-detail.
Range blokeeringud
Konto-logi, võtme haldus, OAuth, partneri administreerimine, makse muudatused ja parooli murdmine on brauserivõtmete jaoks blokeeritud. Toode APIs koos arve lugemisega ja veebihookidega on lubatud. Workspace kustutamine, prügikasti tühjendamine ja juriidiline hoidmine vabastamine toimuvad ainult rakenduses (403 UI_ONLY_ENDPOINT).

Video

Autentimine kasutusel

Vaadake, kuidas Bearer-tokeniga kutse praktikas toimib — videos.

Edasijõudnud

Mis kõrvale jääb

Lehed, mis katavad operatsiooni ümber autentimist.

Publishable Keys Kutsut otse brauserist po_pk_ kaudu. Webhookid Saada sündmusi, mitte poleeri. Postman-Kollektsioon Kõik lõpppunktid sirvimiseks. API-Kataloog Milline lõpppunkt mida teeb. llms-full.txt Terve dokumentatsioon teie IDE jaoks. Tarifid Milline tarif kann ulatusega kaasas käia.

Alustada

Keyi loomine, päise seadmine, saatmine

Keyi saate luua rakenduses konto → API. Esimene API-kutse on samm-sammult videojuhendis.

API-võtme loomine Esimese API-kutse käivitamine

Töö ja usaldusväärsus

Mida ettevõtete meeskonnad kontrollivad enne esimest kõnet

Lepingud, turvalisus, tugi ja piirangud – kõik lingid ühes kohas.

Järgmine peatus

Nii jätkub

Soovitatav järgmine samm arendaja tuubis ja kaks sobivat haru.

Webhooks & EventsReaalajas sündmused, HMAC Esimene API-kõneHanki võti, saada päring, kontrolli vastust Postman CollectionImportige, testige, vigastage Postmanis

Tagasi arendaja sissejuhatusele

Mõistke PaperOffice AI-d 14 minutiga.

Kuidas soovite PaperOffice’i kasutada?