Autentifikācija un atslēgas

Bearer tokens. Katrs galapunkts.

Katrs PaperOffice-API produkta galapunkts sagaida Authorization: Bearer galveni. Nav OAuth plūsmas, nav atjaunošanas.

Divi tokenu veidi, desmit piekļuves apjomi, dokumentēti ātruma ierobežojumi.

Izveidot API atslēgu Sākt pirmo API izsaukumu

Viens galvens Nav OAuth plūsmas Jebkurā brīdī atsauktams

app.paperoffice.ai/account/api

Pieprasījums 200 OK Tokens derīgs

Autorizācijas galvene

Authorization: Bearer po_ut_YOUR_API_KEY

Tiesības

ocr:read
documents:write
jobs:read

Atbilde

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

Pašpārvaldes ES infrastruktūra Jūsu dati paliek Eiropā.
ISO 27001 aktīvs Drošība sertificēta.
SOC 2 Type II aktīvs Starptautiskie audita standarti.
Vairāk nekā 24 gadu pieredze Pārbaudīts. Stabilizēts. Nākotnei drošs.

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

Pirmais izsaukums

Iestatīt galveni, izvēlēties caurplūdi, nosūtīt

Ceļš uz /latest/job/add/ ir rindas darba nosaukums: parasti formātā handler___command (piemēram, paperoffice_aiocr___generate), strukturētam IDP — jūsu paša caurplūdes darba plūsma.

Viens galvenais
Authorization: Bearer po_ut_… — produkta galapunktam nav nepieciešams vairāk. po_sk_ un po_ut_ nenosūta Origin galveni.
Caurplūde ceļā
handler___command ar trim apakšsvītrām; darba plūsma ir izņēmums ar savu slug. Punktu pieraksts atgriež API ar HTTP 400 JOB_CONFIG_INVALID.
Rezultāts vai job_id
client_wait ir pēc noklusējuma true: API saglabā savienojumu un nodrošina rezultātu inline. Ja laika logs nepietiek, tiek atgriezts HTTP 202 ar job_id un poll_url GET /latest/job/get/{job_id} izmantošanai.

Apskatīt API katalogu llms-full.txt jūsu IDE

Priekš idp_collection=invoice ir ieteicamais modelis basic-pro-max: OCR-first drukātas kolekcijas ar pozīcijām jebkurā gadījumā ierobežo līdz basic-pro-max; nosūtīts model=premium tiek atgriezts kā model: basic-pro-max.

Token veidi

Divi token veidi, skaidri atdalīti

Abi pieder serverim. Tie tiek izveidoti, rotēti un atsaukti lietotnē: Konts → API.

po_sk_ Server-zu-Server

Slepenais atslēga

Pilna piekļuve saskaņā ar kontu
Ne piegādāt pārlūkprogrammas kodu
Nav nepieciešams Origin galvenes lauks
Bloķēts priekš MCP

Pārvaldīt slepeno atslēgu

po_ut_ Lietotāja loma

User Token

Ierobežojams uz atsevišķiem apgabaliem
Neizsniegt pārlūkprogrammas kodā
Nav nepieciešams Origin galvene
Atļauts MCP

Izveidot lietotāja tokenu

Tiešie pārlūka pieprasījumi nedarbojas caur šiem diviem tokeniem, bet gan caur publicējamo atslēgu po_pk_ — saistīta ar izcelsmi, ar budžeta un ātruma ierobežojumiem. Apskatīt Publishable Keys

Atļaujas

Desmit jomas katram lietotāja tokenam

Lietotāja tokens satur tieši tās jomas, kuras tam piešķirat izveides brīdī. Ja joma trūkst, API atgriezīs HTTP 403.

Dokumenti dokumenti
Augšupielāde, lejupielāde, apstrāde
Workspaces darbavietas
Mapju un struktūras pārvaldība
AI uzdevumi ai_darbi
OCR, IDP, ekstrakcija
Norēķini rēķinu
Izmantošanas un konta atlikuma lasīšana
Lietotāji lietotāji
Pārvaldīt komandas dalībniekus
Tīmekļa āķi tīmekļa āķi
Saņemt notikumus
Zināšanu bāze zināšanu_bāze
Zināšanu bāze un bieži uzdotie jautājumi (FAQ)
Aģenti agenti
Konfigurēt IDP aģentus
Darba plūsmas darbplūsmas
Izveidot automatizācijas
Atbilstība atbilstība
Audits, GDPR, arhivēšana

Ātruma ierobežojumi

Ko saskaita API

Tiek rēķināts pēc tokena; bez Bearer — pēc IP adrešas. Zemāk minētās vērtības ir dokumentētās minimālās vērtības, kas spēkā katrā tarifu plānā.

5: Pieprasījumi sekundē
30: Pieprasījumi minūtē
100: Pieprasījumi stundā
500: Pieprasījumi dienā

Atlikušās vērtības atrodas atbildes galvnēs
Katras atbildes galvnes RateLimit-* un X-RateLimit-* norāda, cik daudz vēl ir pieejams pašreizējā laika posmā.
Pārsniegšana: HTTP 429
API atgriež kļūdu RATE_LIMIT_EXCEEDED. Atkārtoti izsauciet pēc laika, kas norādīts Retry-After galvnē.
Augstāki tarifi palielina šīs vērtības
Maksas tarifi pārsniedz šīs minimālās vērtības. Kāds tarifs un kāds apjoms ir norādīts cenų lapā.

Apskatīt tarifus un apjomu

Drošība

Kas nodrošina atslēgu

Seši mehānismi, kas darbojas ekspluatācijā — katram ir pārbaudāms statusa kods vai vieta lietotnē.

Rotācija un atsaukšana
Atslēgas tiek izveidotas, uzskaitītas, rotētas un atsauktas lietotnē sadaļā Konts → API. Atsaukts tokens atgriež HTTP 401 TOKEN_NOT_FOUND.
Derīguma termiņš un derīgums
Beigušies vai kļūdaini tokeni tiek atgriezti kā HTTP 401 INVALID_TOKEN. Publishable Keys beidzas visdrīzāk pēc 365 dienām.
Limiti katram tokenam
Rate-limits tiek skaitīti katram tokenam, nevis kontam. Kompromitēta atslēga neapgrūtina visu darbību.
Izcelsmes saistība pārlūkprogrammā
Publishable Keys prasa katrā pieprasījumā Origin no Allowlist; citādi API atbild ar 403 ORIGIN_HEADER_REQUIRED vai DOMAIN_NOT_ALLOWED.
Izmantošanas izsekošana
Katrs norēķinu veidojošais atbildes objekts satur _billing bloku; detalizēta analīze pēc pieprasījuma tiek veikta, izmantojot GET /latest/billing/usage-detail.
Stingri aizliegumi
Pārlūkprogrammas atslēgām ir bloķēti konta pieteikšanās, atslēgu pārvaldība, OAuth, partneru administrators, maksājumu izmaiņas un paroles laušana. Produktam APIs ir atļauta rēķinu lasīšana un tīmekļa āķi. Workspace dzēšana, papīra grosta iztukšošana un juridiskās saglabāšanas atļauja ir pieejama tikai lietotnē (403 UI_ONLY_ENDPOINT).

Video

Autentifikācija darbībā

Apskatiet, kā prakse notiek izsaukums ar Bearer tokeni — video.

Papildu informācija

Saistītās tēmas

Lapas, kas aptver darbību ap autentifikāciju.

Publishable Keys Izsaukumi tieši no pārlūka ar po_pk_. Tīmekļa āķi Saņem notikumus, nevis veic polling. Postman-Kolekcija Visi galapunkti, kurus varat pārlūkot. API-Katalogs Kurš galapunkts veic kuru darbu. llms-full.txt Pilna dokumentācija jūsu IDE. Tarifi Kāds tarifs nes kādu apjomu.

Sākt

Izveidot atslēgu, iestatīt galveni, nosūtīt

Atslēgu izveidojat lietotnē kontā → API. Pirmo izsaukumu soli pa solim skatiet pirmajā API-izsaukumā.

Izveidot API atslēgu Sākt pirmo API izsaukumu

Darbība un uzticamība

Ko uzņēmumu komandas pārbauda pirms pirmā zvana

Līgumi, drošība, atbalsts un ierobežojumi – viss saistīts vienā vietā.

Nākamais solis

Kā turpināt

Ieteicamais nākamais solis izstrādātāja piltuvē un divi atbilstoši novirzieni.

Webhooks & EventsReāllaika notikumi, HMAC Pirmais API izsaukumsSaņemt atslēgu, nosūtīt pieprasījumu, pārbaudīt atbildi Postman CollectionImportēt, testēt, kļūdām meklēt Postman

Atpakaļ uz izstrādātāja sākumu

Izprotiet PaperOffice AI 14 minūtēs.

Kā vēlaties izmantot PaperOffice?