Autentifikacija ir raktai

Bearer token. Kiekvienas galinis taškas.

Kiekvienas PaperOffice-API produkto galinis taškas reikalauja Authorization: Bearer antraštės. Nėra OAuth srauto, nėra atnaujinimo.

Du token tipai, dešimt teisių sričių, dokumentuoti greičio apribojimai.

Sukurti API raktą Pradėti pirmąją API užklausą

Viena antraštė Nėra OAuth srauto Galima bet kada atšaukti

app.paperoffice.ai/account/api

Užklausa 200 OK Žetonas galioja

Autorizacijos antraštė

Authorization: Bearer po_ut_YOUR_API_KEY

Leidimai

ocr:read
documents:write
jobs:read

Atsakymas

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

Savo ES infrastruktūra Jūsų duomenys lieka Europoje.
ISO 27001 aktyvus Sertifikuota saugumas.
SOC 2 II tipo Tarptautiniai audito standartai.
Daugiau nei 24 metų patirtis Įrodyta. Stabilu. Ateities saugumas.

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

Pirmasis kvietimas

Nustatyti antraštę, pasirinkti vamzdelį, pateikti

Kelias iki /latest/job/add/ yra eilės darbo pavadinimas: dažniausiai formos handler___command (pvz., paperoffice_aiocr___generate), struktūruotam IDP – jūsų asmeninis vamzdžio darbas.

Viena antraštė
Authorization: Bearer po_ut_… — daugiau produktų galinės sąsajos nereikia. po_sk_ ir po_ut_ nesiunčia Origin antraštės.
Vamzdis kelyje
handler___command su trimis apatinėmis brūkšneliais; workflow yra išimtis su savo slug'u. Taškų rašymas atsako į API su HTTP 400 JOB_CONFIG_INVALID.
Rezultatas arba job_id
client_wait pagal nutylėjimą yra true: API palaiko ryšį ir pateikia rezultatą tiesiogiai. Jei laiko langas nepakankamas, grąžinama HTTP 202 su job_id ir poll_url GET /latest/job/get/{job_id} užklausai.

Peržiūrėti API katalogą llms-full.txt jūsų IDE

Kai idp_collection=invoice, rekomenduojamas modelis yra basic-pro-max: OCR-first spausdintas kolekcijas su pozicijomis vis tiek riboja iki basic-pro-max; jei nusiųsite model=premium, bus grąžinta kaip model: basic-pro-max.

Token tipai

Du token tipai, aiškiai atskirti

Abu turi būti saugomi serveryje. Jie kuriami, keičiami ir panaikinami programėlėje paskyroje → API.

po_sk_ Serveris nuo serverio

Slapta raktas

Visiška prieiga pagal paskyrą
Niekada neperduoti naršyklės kodu
Nereikia Origin antraštės
Užblokuota MCP

Tvarkyti slaptažodį

po_ut_ Vartotojo lygio

User Token

Galima apriboti atskiriems regionams
Niekada neperduoti naršyklės kodu
Origin-headerio nereikia
Leidžiama naudoti MCP

Sukurti vartotojo tokeną

Prašymai, atliekami tiesiai iš naršyklės, neina per šiuos du tokenus, o per viešąjį raktą po_pk_ — priklausomai nuo kilmės, ribojamas biudžetas ir prašimų skaičius. Peržiūrėti viešuosius raktus

Teisės

Dešimt sričių kiekvienam vartotojo tokenui

Vartotojo tokenas turi tik tas sritis, kurias jam priskiriate jį kuriant. Jei trūksta srities, bus grąžintas API su HTTP 403.

Dokumentai dokumentai
Įkelti, atsisiųsti, apdoroti
Workspaces darbų erdvės
Valdyti aplankus ir struktūrą
AI užduotys ai_darbai
OCR, IDP, ištraukimas
Atsiskaitymas sąskaitos_faktūros
Skaityti naudojimą ir sąskaitos balansą
Vartotojai vartotojai
Tvarkyti komandos narius
Žiniatinklio kabliai sraitynai
Gauti įvykius
Žinių bazė žinių bazė
Žinių bazė ir DUK
Agentai agentai
Konfigūruoti IDP agentus
Darbo srautai darbalaukiai
Sukurti automatizavimus
Atitiktis atitikimas
Auditas, GDPR, archyvavimas

Greitojo ribojimai

Ką skaičiuoja API

Skaičiuojama pagal tokeną; be Bearer — pagal IP adresą. Toliau pateiktos vertės yra dokumentuotos minimalios vertės, kurios galioja kiekviename tarife.

5: Prašymų per sekundę
30: Prašymų per minutę
100: Prašymų per valandą
500: Prašymų per dieną

Liekamos vertės pateikiamos atsakymo galvutėje
Kiekvieno atsakymo „RateLimit-*“ ir „X-RateLimit-*“ galvutės rodo, kiek laiko lango dar liko.
Viršijimas: HTTP 429
API grąžina „RATE_LIMIT_EXCEEDED“. Pakartokite užklausą pagal „Retry-After“ galvutėje nurodytą laiką.
Didesni tarifai padidina vertes
Mokami tarifai viršija šias minimalias vertes. Koks tarifas ir kokio apimties yra, nurodyta kainų puslapyje.

Peržiūrėti tarifus ir apimtį

Saugumas

Kas užtikrina rakto saugumą

Šeši mechanizmai, veikiantys eksploatavimo metu – kiekvienas su tikrinamu būsenos kodu arba vieta programėlėje.

Sukimas ir panaikinimas
Raktai programėlėje kuriami, sąrašuojami, sukami ir panaikinami paskyroje → API. Panaikintas tokenas grąžina HTTP 401 TOKEN_NOT_FOUND.
Galiojimo laikas ir galiojimas
Pasibaigę arba netinkami tokeniai grąžina HTTP 401 INVALID_TOKEN. Viešieji raktai galioja ne ilgiau kaip 365 dienas.
Ribojimai vienam tokenui
Greifklausel ribojamos pagal tokeną, o ne pagal paskyrą. Pažeistas raktas nepažeidžia visos sistemos.
Kilmės nustatymas naršyklėje
Viešieji raktai kiekvienos užklausos metu reikalauja Origin iš Allowlist; kitaip API atsako 403 ORIGIN_HEADER_REQUIRED arba DOMAIN_NOT_ALLOWED.
Naudojimo stebėjimas
Kiekviena apmokestinama atsakymo dalis turi _billing bloką; kiekvieno skambučio vertinimas pateikia GET /latest/billing/usage-detail.
Sankcijos
Prieiga naršyklės raktams užblokuota: sąskaitos prisijungimas, rakto valdymas, OAuth, partnerio administratorius, mokėjimo modifikavimas ir slaptažodžių laužimas. Leidžiama: produktas APIs įskaitant sąskaitų faktūrų skaitymą ir webhook'us. Veiksmai „Workspace“ ištrynimas, šiukšliadėžės valymas ir teisinio sulaikymo atlaisvinimas atliekami tik programėlėje (klaida 403 UI_ONLY_ENDPOINT).

Vaizdo įrašas

Autentifikavimas praktikoje

Pažiūrėkite, kaip praktiškai veikia kvietimas su Bearer žetonu — vaizdo įraše.

Toliau

Kas yra šalia

Puslapiai, kurie apima veiklą aplink autentifikaciją.

Publishable Keys Skambučiai tiesiogiai iš naršyklės su po_pk_. Webhook'ai Gauti įvykius vietoj nuolatinio užklausų siuntimo. Postman-Kolekcija Visi galiniai taškai naršymui. API-Katalogas Kuris galinis taikas kokią funkciją atlieka. llms-full.txt Visa dokumentacija jūsų IDE. Tarifai Kuris tarifas kokį apimtį dengia.

Pradėti

Sukurti raktą, nustatyti antraštę, siųsti

Raktą programėlėje sukurkite skiltyje Paskyra → API. Pirmas žingsnis po žingsnio aprašytas pirmame API kvietime.

Sukurti API raktą Pradėti pirmąją API užklausą

Eksploatacija ir pasitikėjimas

Ką įmonių komandos tikrina prieš pirmąjį skambutį

Sutartys, saugumas, palaikymas ir apribojimai – visos nuorodos vienoje vietoje.

Kita stotelė

Kaip judėti toliau

Rekomenduojamas kitas žingsnis kūrėjo kelyje ir du tinkami šakojimai.

Webhooks & EventsĮvykiai realiuoju laiku, HMAC Pirmasis API iškvietimasGauti raktą, siųsti užklausą, tikrinti atsakymą Postman CollectionImportuokite, testuokite ir derinkite Postman

Grįžti prie kūrėjo pradžios

Supraskite PaperOffice AI per 14 minučių.

Kaip norėtumėte naudoti PaperOffice?