Autentificare și chei

Un token Bearer. Fiecare endpoint.

Fiecare endpoint al produsului PaperOffice-API așteaptă antetul Authorization: Bearer. Fără flux OAuth, fără reîmprospătare.

Două tipuri de token, zece arii de aplicare, limite de rată documentate.

Creare cheie API Lansarea primului apel API

Un antet Fără flux OAuth Revocabili în orice moment

app.paperoffice.ai/account/api

Cerere 200 OK Token valid

Antetul de autorizare

Authorization: Bearer po_ut_YOUR_API_KEY

Permisiuni

ocr:read
documents:write
jobs:read

Răspuns

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

Infrastructură proprie UE Datele dumneavoastră rămân în Europa.
ISO 27001 activ Securitate certificată.
SOC 2 Tipul II activ Standarde internationale de audit.
Peste 24 de ani de experiență Dovedită. Stabilă. Pregătită pentru viitor.

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

Primul apel

Setați antetul, alegeți pipeline-ul, trimiteți

Calea către /latest/job/add/ este numele job-ului din coadă: de obicei sub forma handler___command (de exemplu paperoffice_aiocr___generate), pentru IDP structurat, utilizați fluxul de lucru al propriei dvs. pipeline-uri.

Un antet
Authorization: Bearer po_ut_… — un punct final de produs nu are nevoie de mai mult. po_sk_ și po_ut_ nu trimit un antet Origin.
Pipeline în cale
handler___command cu trei underscore-uri; workflow este excepția cu propriul slug. Notarea prin puncte răspunde la API cu HTTP 400 JOB_CONFIG_INVALID.
Rezultat sau job_id
client_wait este true implicit: API menține conexiunea și returnează rezultatul inline. Dacă fereastra de timp nu este suficientă, se primește HTTP 202 cu job_id și poll_url pentru GET /latest/job/get/{job_id}.

Vizualizează catalogul API llms-full.txt pentru IDE-ul dumneavoastră

Pentru idp_collection=invoice, modelul recomandat este basic-pro-max: OCR-first limitează deja colecțiile tipărite cu poziții la basic-pro-max; un model=premium trimis va fi returnat ca model: basic-pro-max.

Tipuri de token-uri

Două tipuri de token-uri, clar separate

Ambele trebuie trimise către server. Ele sunt create, rotite și revocate în aplicație la contul → API.

po_sk_ Server la server

Cheie secretă

Acces complet în cadrul contului
Nu se livrează niciodată în codul browserului
Nu este necesar antetul Origin
Blocat pentru MCP

Gestionare cheie secretă

po_ut_ Legat de utilizator

User Token

Limitabil la zone individuale
Nu se livrează niciodată în codul browserului
Nu este necesar un antet Origin
Autorizat pentru MCP

Creare token de utilizator

Cererea directă din browser nu trece prin cele două token-uri, ci prin cheia publicabilă po_pk_ — legată de origine, cu buget și limitare de rate. Vizualizare Publishable Keys

Permisiuni

Zece domenii per token de utilizator

Un token de utilizator are exact domeniile pe care le-ați atribuit la creare. Dacă lipsește un domeniu, API răspunde cu HTTP 403.

Documente documente
Încărcare, descărcare, procesare
Workspaces spații de lucru
Gestionarea dosarelor și structurii
Job-uri AI sarcini_ai
OCR, IDP, extragere
Facturare facturare
Citirea utilizării și soldului contului
Utilizatori utilizatori
Gestionați membrii echipei
Webhook-uri webhook-uri
Primiți evenimente
Bază de cunoștințe cunostinte_baza
Bază de cunoștințe și FAQ
Agenți agenți
Configurați agenții IDP
Fluxuri de lucru fluxuri_de_lucru
Creați automatizări
Conformitate conformitate
Audit, GDPR, arhivare

Limite de rată

Ce numără API

Se facturează pe bază de token; fără Bearer, pe adresă IP. Valorile următoare sunt valorile minime documentate care se aplică în fiecare tarif.

5: Cereri pe secundă
30: Cereri pe minut
100: Cereri pe oră
500: Cereri pe zi

Valorile rămase se află în antetul răspunsului
Anteturile RateLimit-* și X-RateLimit-* ale fiecărui răspuns indică cât mai este disponibil în fereastra curentă.
Depășire: HTTP 429
API răspunde cu RATE_LIMIT_EXCEEDED. Repetați apelul după timpul indicat în antetul Retry-After.
Tarifele superioare cresc valorile
Tarife plătite se află peste aceste valori minime. Detaliile privind volumul fiecărui tarif sunt disponibile pe pagina de prețuri.

Vizualizare tarife și volum

Siguranță

Ce protejează un cheie (key)

Șase mecanisme care intră în funcțiune în timpul operațiunilor — fiecare având un cod de stare verificabil sau o locație în aplicație.

Rotare și revocare
Cheile sunt create, listate, rotite și revocate în aplicație la Cont → API. Un token revocat răspunde cu HTTP 401 TOKEN_NOT_FOUND.
Expirare și valabilitate
Tokenurile expirate sau eronate sunt returnate ca HTTP 401 INVALID_TOKEN. Cheile publicabile expiră cel târziu după 365 de zile.
Limite per token
Rate-limitările se calculează per token, nu per cont. O cheie compromisă nu afectează astfel întregul operațional.
Legarea la origine în browser
Cheile publicabile cer un Origin din Allowlist la fiecare cerere; altfel, API-ul răspunde cu 403 ORIGIN_HEADER_REQUIRED sau DOMAIN_NOT_ALLOWED.
Urmărirea utilizării
Fiecare răspuns facturat conține un bloc _billing; evaluarea per apel se face prin GET /latest/billing/usage-detail.
Blocări stricte
Autentificarea contului, gestionarea cheilor, OAuth, admin-ul partenerului, modificarea plăților și spargerea parolei sunt blocate pentru cheile browser-ului. Produsul APIs inclusiv citirea facturării și webhooks sunt permise. Ștergeți Workspace, goliti coșul de gunoi și eliberați Legal-Hold doar în aplicație (403 UI_ONLY_ENDPOINT).

Video

Autentificare în acțiune

Vedeți cum funcționează un apel cu token Bearer în practică — în video.

Continuare

Ce este alăturat

Paginile care acoperă operaționalul în jurul autentificării.

Publishable Keys Apeluri directe din browser cu po_pk_. Webhook-uri Primirea evenimentelor în loc de polling. Postman-Colecție Toate punctele finale pentru navigare. API-Catalog Ce funcționalitate are fiecare punct final. llms-full.txt Documentația completă pentru IDE-ul dumneavoastră. Pricing Ce tarif acoperă ce volum.

Start acum

Creați cheia, setați antetul, trimiteți

În aplicație, creați cheia la Cont → API. Primul apel este descris pas cu pas în Primul apel API.

Creare cheie API Lansarea primului apel API

Operațiuni și încredere

Ce verifică echipele enterprise înainte de primul apel

Contracte, securitate, suport și limite, toate link-urile într-un singur loc.

Următoarea stație

Iată cum continuăm

Următorul pas recomandat în funnel-ul dezvoltatorilor și două ramificații potrivite.

Webhooks & EventsEvenimente în timp real, HMAC Primul apel APIObțineți cheia, trimiteți cererea, verificați răspunsul Postman CollectionImportare, testare, depanare în Postman

Înapoi la începutul pentru dezvoltatori

Înțelegeți PaperOffice AI în 14 minute.

Cum doriți să folosiți PaperOffice?