Autentifikacija i ključevi

Jedan Bearer token. Svaka krajnja točka.

Svaka produktna krajnja točka PaperOffice-API očekuje zaglavlje Authorization: Bearer. Bez OAuth protokola, bez osvježavanja.

Dva tipa tokena, deset opsega ovlasti, dokumentirani limiti brzine.

Izrada API-ključa Pokretanje prvog API-poziva

Jedno zaglavlje Nema OAuth tijeka Bilo kada moguće opozivo

app.paperoffice.ai/account/api

Zahtjev 200 OK Token je valjan

Authorization zaglavlje

Authorization: Bearer po_ut_YOUR_API_KEY

Ovlasti

ocr:read
documents:write
jobs:read

Odgovor

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

Vlastita EU-infrastruktura Vaši podaci ostaju u Europi.
ISO 27001 aktivno Sigurnost certificirana.
SOC 2 Type II aktivno Međunarodni standardi revizije.
Više od 24 godine iskustva Provjereno. Stabilno. Budućnosti sigurno.

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 poziv

Postavite zaglavlje, odaberite cijev, pošaljite

Putanja do /latest/job/add/ je naziv posla u redu: uglavnom u obliku handler___command (npr. paperoffice_aiocr___generate), za strukturirani IDP vlastiti radni tijek pipeline-a.

Jedno zaglavlje
Authorization: Bearer po_ut_… — više produkt-endpoint ne treba. po_sk_ i po_ut_ ne šalju Origin zaglavlje.
Pipeline u putanji
handler___command s tri podcrta; workflow je iznimka s vlastitim slugom. Točkasta notacija odgovara API s HTTP 400 JOB_CONFIG_INVALID.
Rezultat ili job_id
client_wait je standardno true: API zadržava vezu i vraća rezultat inline. Ako vremenski okvir nije dovoljan, dolazi do HTTP 202 s job_id i poll_url za GET /latest/job/get/{job_id}.

Pogledajte API katalog llms-full.txt za vaš IDE

Za idp_collection=invoice preporučeni model je basic-pro-max: OCR-first već ograničava tiskane kolekcije s pozicijama na basic-pro-max; poslani model=premium vraća se kao model: basic-pro-max.

Vrste tokena

Dvije vrste tokena, jasno odvojene

Obje pripadaju poslužitelju. Stvaraju se, rotiraju i opozivaju u aplikaciji pod Račun → API.

po_sk_ Poslužitelj-poslužitelj

Tajni ključ

Potpuni pristup u okviru računa
Nikada ne isporučivati u kôdu preglednika
Nije potreban zaglavlje Origin
Zaključano za MCP

Upravljanje tajnim ključem

po_ut_ Povezano s korisnikom

User Token

Može se ograničiti na pojedinačne područja
Nikada ne isporučivati u kôdu preglednika
Nije potreban Origin zaglavlje
Odobreno za MCP

Izrada korisničkog tokena

Pozivi izravno iz preglednika ne prolaze kroz ova dva tokena, već kroz Publishable Key po_pk_ — vezan uz podrijetlo, s ograničenjem proračuna i stopa. Pregled Publishable ključeva

Ovlasti

Deset područja po korisničkom tokenu

Korisnički token nosi točno ona područja koja mu dodijelite prilikom izrade. Ako nedostaje područje, odgovor će biti API s HTTP 403.

Dokumenti dokumenti
Prijenos, preuzimanje, obrada
Workspaces radni_prostori
Upravljanje mapama i strukturom
AI poslovi ai_jobs
OCR, IDP, ekstrakcija
Naplaćivanje naplata
Čitanje korištenja i stanja računa
Korisnici korisnici
Upravljanje članovima tima
Webhookovi webhookovi
Primanje događaja
Baza znanja baza_znanja
Baza znanja i FAQ
Agenti agenti
Konfigurirajte IDP agente
Radni tokovi radni tokovi
Stvorite automatizacije
Usklađenost compliance
Revizija, GDPR, arhiviranje

Ograničenja brzine

Što API broji

Naplaćuje se po tokenu; bez Bearera po IP adresi. Sljedeće vrijednosti su dokumentirane minimalne vrijednosti koje vrijede u svakom tarifu.

5: Zahtjevi po sekundi
30: Zahtjevi po minuti
100: Zahtjevi po satu
500: Zahtjevi po danu

Preostale vrijednosti nalaze se u zaglavlju odgovora
Zaglavlja RateLimit-* i X-RateLimit-* svakog odgovora govore koliko je još preostalo u trenutnom prozoru.
Prekoračenje: HTTP 429
API odgovara s RATE_LIMIT_EXCEEDED. Ponovite poziv nakon vremena navedenog u Retry-After zaglavlju.
Viši tarifi povećavaju vrijednosti
Plaćeni tarifni paketi nalaze se iznad ovih minimalnih vrijednosti. Koja je opseg svakog paketa, možete vidjeti na stranici s cijenama.

Pregled tarifa i opsega

Sigurnost

Što štiti ključ

Šest mehanizama koji djeluju u radu — svaki s provjerljivim statusnim kodom ili mjestom u aplikaciji.

Rotacija i opoziv
Ključevi se stvaraju, popisuju, rotiraju i opozivaju u aplikaciji pod Račun → API. Opozvani token odgovara s HTTP 401 TOKEN_NOT_FOUND.
Rok valjanosti
Istekli ili neispravni tokeni vraćaju se kao HTTP 401 INVALID_TOKEN. Publishable ključevi ističu najkasnije nakon 365 dana.
Ograničenja po tokenu
Rate-limiti se računaju po token, a ne po računu. Kompromitirani ključ ne opterećuje cijelu organizaciju.
Povezivanje podrijetla u pregledniku
Publishable ključevi zahtijevaju pri svakom zahtjevu Origin iz Allowlista; inače API odgovara s 403 ORIGIN_HEADER_REQUIRED ili DOMAIN_NOT_ALLOWED.
Praćenje korištenja
Svaki obračunati odgovor sadrži _billing-blok; procjena po pozivu daje GET /latest/billing/usage-detail.
Stroga ograničenja
Prijava na račun, upravljanje ključevima, OAuth, partner-administrator, promjene plaćanja i lomljenje lozinke blokirani su za ključeve preglednika. Dozvoljeno je čitanje proizvoda APIs uključujući naplatu i webhooks. Brisanje Workspace, pražnjenje smeća i oslobađanje pravnog zadržavanja mogu se izvršiti samo u aplikaciji (403 UI_ONLY_ENDPOINT).

Video

Autentifikacija u praksi

Pogledajte kako poziv s Bearer-tokenom funkcionira u praksi — u videu.

Daljnje informacije

Što stoji uz to

Stranice koje pokrivaju operacije oko autentifikacije.

Publishable Keys Pozivi izravno iz preglednika s po_pk_. Webhookovi Primajte događaje umjesto upita. Postman-Kolekcija Sve krajnje točke za pregledavanje. API-katalog Koja krajnja točka što radi. llms-full.txt Cijela dokumentacija za vaš IDE. Tarifi Koji opseg nosi koji tarifni paket.

Početak rada

Stvorite ključ, postavite zaglavlje, pošaljite

Ključ postavite u aplikaciji pod Račun → API. Prvi poziv je korak po korak opisan u prvom API-pozivu.

Izrada API-ključa Pokretanje prvog API-poziva

Operacije i povjerenje

Što enterprise timovi provjeravaju prije prvog poziva

Ugovori, sigurnost, podrška i limiti, sve povezano na jednom mjestu.

Sljedeća stanica

Kako nastaviti

Preporučeni sljedeći korak u developer funnelu i dva odgovarajuća odstupanja.

Webhooks & EventsDogađaji u stvarnom vremenu, HMAC Prvi API pozivDohvatite ključ, pošaljite zahtjev, provjerite odgovor Postman CollectionUvoz, testiranje i odlažanje u Postman

Natrag na developer ulaz

Razumijte PaperOffice AI za 14 minuta.

Kako želite koristiti PaperOffice?