Todennus ja avaimet

Bearer-token. Jokainen päätepiste.

Jokainen PaperOffice-API:n tuotepäätepiste odottaa otsikkoa Authorization: Bearer. Ei OAuth-virtaa, ei refreshia.

Kaksi token-tyyppiä, kymmenen käyttöoikeusalueita, dokumentoidut nopeusrajoitukset.

API-avaimen luonti Ensimmäisen API-kutsun aloitus

Yksi otsikko Ei OAuth-virtuaalista kulkua Peruttavissa milloin tahansa

app.paperoffice.ai/account/api

Pyyntö 200 OK Token voimassa

Valtuutusotsikko

Authorization: Bearer po_ut_YOUR_API_KEY

Oikeudet

ocr:read
documents:write
jobs:read

Vastaus

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

Oma EU-infrastruktuuri Tietonne pysyvät Euroopassa.
ISO 27001 aktiivinen Turvallisuus sertifioitu.
SOC 2 Type II aktiivinen Kansainväliset tarkastusstandardit.
24+ vuoden kokemus Testattu. Vakaa. Tulevaisuuden varma.

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

Ensimmäinen kutsumiskerta

Aseta otsikko, valitse putki, lähetä

Polku /latest/job/add/ on jonojobin nimi: yleensä muodossa handler___command (esim. paperoffice_aiocr___generate), rakenteelliselle IDP:lle oma putkityönkulku.

Yksi otsikko
Authorization: Bearer po_ut_… — enemmän tuotepäätepisteen ei tarvitse. po_sk_ ja po_ut_ eivät lähetä Origin-otsikkoa.
Putki polussa
handler___command kolmella alaviivalla; workflow on poikkeus omalla slugillaan. Pistekirjoitus vastaa API HTTP 400 JOB_CONFIG_INVALID:lla.
Tulos tai job_id
client_wait on oletusarvoisesti tosi: API pitää yhteyden auki ja palauttaa tuloksen inline. Jos aikaväli ei riitä, tulee HTTP 202 vastauksena job_id ja poll_url GET /latest/job/get/{job_id} varten.

Näytä API-katalogi llms-full.txt IDE:llenne

idp_collection=invoice tapauksessa basic-pro-max on suositeltu malli: OCR-first rajaa tulostetut kokoelmat paikoillaan periaatteessa basic-pro-maxiin, lähetetty model=premium palautetaan muodossa model: basic-pro-max.

Token-tyypit

Kaksi token-tyyppiä, selkeästi eroteltuna

Molemmat kuuluvat palvelimelle. Ne luodaan, kierretään ja peruutetaan sovelluksessa kohdassa Tili → API.

po_sk_ Palvelin-palvelun välinen

Salainen avain

Täysi käyttöoikeus tilin puitteissa
Älä koskaan toimita selaimen koodiin
Ei tarvitse Origin-headeria
Lukittu MCP:lle

Salaisen avaimen hallinta

po_ut_ Käyttäjäkohtainen

User Token

Voidaan rajoittaa yksittäisiin alueisiin
Älä koskaan toimita selaimen koodiin
Ei Origin-headeria tarvita
Sallittu MCP:lle

Käyttäjätunnuksen luonti

Selaimesta suoritettavat kutsut eivät käytä näitä kahta tunnuksena, vaan julkaistavaa avainta po_pk_ — peräisin sidottu, budjetti- ja kurssirajoitettu. Publishable Keys

Oikeudet

Kymmenen aluetta per käyttäjätunnus

Käyttäjätunnus sisältää tarkalleen ne alueet, jotka annatte sille luomisen yhteydessä. Jos alue puuttuu, API vastaa HTTP 403:lla.

Dokumentit asiakirjat
Lataa, lataa, käsittely
Workspaces työtilat
Hallinnoi kansioita ja rakennetta
AI-tehtävät tehtaan_tehtävät
OCR, IDP, eritys
Laskutus laskutus
Lue käyttö ja tilin saldo
Käyttäjät käyttäjät
Tiimin jäsenten hallinta
Webhookit webhookit
Tapahtumien vastaanotto
Tietokanta tietokanta
Tietokanta ja FAQ
Agentit agentit
IDP-agenttien määritys
Työkulut työkulut
Automaatioiden luominen
Yhteensopivuus compliance
Auditointi, GDPR, arkistointi

Nopeusrajoitukset

Mitä API laskee

Laskutus tapahtuu tokenin perusteella; ilman Beareria IP-osoitteen perusteella. Seuraavat arvot ovat dokumentoituja minimiarvoja, jotka pätevät kaikissa hinnoitteluasteikoissa.

5: Pyyntöä sekunnissa
30: Pyyntöä minuutissa
100: Pyyntöä tunnissa
500: Pyyntöä päivässä

Jäljellä olevat arvot löytyvät vastausotsikoista
Vastauksen RateLimit-* ja X-RateLimit-* -otsikot kertovat, kuinka paljon jäljellä on nykyisessä ikkunassa.
Ylitys: HTTP 429
API vastaa viestillä RATE_LIMIT_EXCEEDED. Toistakaa pyyntö Retry-After -otsikossa ilmoitetun ajan jälkeen.
Korkeammat hinnoitteluasteikot nostavat arvoja
Maksulliset tariffit ovat näiden minimiarvojen yläpuolella. Minkä laajuuden tariffi on, näkee hintasivulta.

Tariffit ja laajuus

Turvallisuus

Mikä varmistaa avaimen

Kuusi toiminnassa olevaa mekanismia — jokaisella tarkastettavissa oleva statuskoodi tai sovelluksen sijainti.

Kierto ja peruutus
Avaimet luodaan, listataan, kierretään ja peruutetaan sovelluksessa kohdasta Tili → API. Peruutettu token palauttaa HTTP 401 TOKEN_NOT_FOUND.
Vanhentuminen ja voimassaolo
Vanhentuneet tai virheelliset tokenit palautuvat muodossa HTTP 401 INVALID_TOKEN. Publishable Keys vanhenevat viimeistään 365 päivän kuluttua.
Rajoitukset per token
Maksurajoitukset lasketaan tokenia kohden, ei tiliä kohden. Komproimoidun avaimen kuormitus ei vaikuta koko toimintaan.
Alkuperän sitominen selaimessa
Publishable Keys vaativat jokaisessa pyynnössä Originin Allowlistista; muuten API vastaa koodilla 403 ORIGIN_HEADER_REQUIRED tai DOMAIN_NOT_ALLOWED.
Käytön seuranta
Jokainen laskutettu vastaus sisältää _billing-lohkoon; pyyntökohtainen arviointi antaa GET /latest/billing/usage-detail.
Kovat estot
Kontotunnistautuminen, avaintenhallinta, OAuth, kumppanin hallinta, maksutapahtumat ja salasanakriikka ovat estetty selaimen avaimille. Tuote-APIs mukaan lukien laskutuksen lukeminen ja webhotkit ovat sallittuja. Workspace poistaa, roskakorin tyhjentää ja oikeudellisen säilytyksen vapauttaa vain sovelluksessa (403 UI_ONLY_ENDPOINT).

Video

Todennus käytössä

Katsokaa, miten Bearer-tokenilla varustettu kutsu toimii käytännössä — videolla.

Jatkokehitys

Mitä sivulla näkyy

Sivut, jotka kattavat toiminnan autentikoinnin ympärillä.

Publishable Keys Hoida puhelut suoraan selaimessa po_pk_:llä. Webhookit Vastaanota tapahtumia pollauksen sijaan. Postman-Kokoelma Kaikki selattavat päätepisteet. API-Luettelo Mikä päätepiste tekee mitäkin. llms-full.txt Koko dokumentaatio IDE:si varten. Tariffit Mikä laajuus kuuluu millekin tariffille.

Aloitus

Luo avain, aseta otsikko, lähetä

Asettakaa avain sovelluksessa kohdasta Tili → API. Ensimmäinen kutsu esitetään vaiheittain ensimmäisessä API-kutsussa.

API-avaimen luonti Ensimmäisen API-kutsun aloitus

Toiminta ja luottamus

Mitä yritystiimit tarkistavat ennen ensimmäistä puhelua

Sopimukset, turvallisuus, tuki ja rajat, kaikki linkitetty yhteen paikkaan.

Seuraava pysäkki

Näin se etenee

Suositeltu seuraava askel kehittäjän suppilossa ja kaksi sopivaa haarautumaa.

Webhooks & EventsReaaliaikaiset tapahtumat, HMAC Ensimmäinen API-kutsuHae avain, lähetä pyyntö, tarkista vastaus Postman CollectionTuo, testaa ja korjaa Postmanissa

Takaisin kehittäjän aloitukseen

PaperOffice AI 14 minuutissa.

Miten haluaisitte käyttää PaperOfficea?