Kysymyksiä?PaperOffice AI Phone Agent 24/7+49 69 3487102-0

+49 69 3487102-0 Aloitus

Yhteydenotto Yhteys Aloitus Aloitus

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ä, selkeät oikeudet, dokumentoidut nopeusrajoitukset.

API-avaimen luonti Ensimmäisen API-kutsun aloitus

Yksi otsikko Ei OAuth-virtuaalista kulkua Peruttavissa milloin tahansa

Bearer-token. Jokainen päätepiste.

Oma EU-infrastruktuuri Tietonne pysyvät Euroopassa.
ISO/IEC 27001 -sertifioitu Turvallisuus sertifioitu.
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 "file_1=@invoice.pdf" \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/:n jälkeen on toiminnon nimi: yleensä muodossa handler___command (esimerkiksi paperoffice_aiocr___generate), ja rakenteellisille IDP:lle omistettu workflow-putki.

Yksi otsikko
Authorization: Bearer po_ut_… — enemmän tuotepäätepisteen ei tarvitse. poai_ 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

Kun kyseessä on idp_collection=invoice, suositeltu malli on basic-pro-max. Käytetty malli palautetaan vastauksen kentässä "model" ja se voi poiketa pyydetystä mallista.

Token-tyypit

Kaksi token-tyyppiä, selkeästi eroteltuna

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

poai_ Palvelin-palvelun välinen

API-avain

Sen tilin oikeudet, joka luo sen (hallinnoija: koko tili)
Älä koskaan toimita selaimen koodiin
Ei tarvitse Origin-headeria
Lukittu MCP:lle
Voidaan rajoittaa IP-osoitteisiin

API-avainten hallinta

po_ut_ Käyttäjäkohtainen

User Token

Kantaa käyttäjän oikeudet
Ä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

Mitä User Token saa tehdä

User Token:llä on täsmälleen ne oikeudet, jotka käyttäjällä on näillä alueilla. Yksittäisiä alueita ei voida määrittää luomisen yhteydessä; rajaukseen käytetään ryhmätunnusta (po_gt_), jolla on käyttäjäryhmän oikeudet.

Dokumentit documents
Lataa, lataa, käsittely
Workspaces workspaces
Hallinnoi kansioita ja rakennetta
AI-tehtävät ai_jobs
OCR, IDP, eritys
Laskutus billing
Lue käyttö ja tilin saldo
Käyttäjät users
Tiimin jäsenten hallinta
Webhookit webhooks
Tapahtumien vastaanotto
Tietokanta knowledge_base
Tietokanta ja FAQ
Agentit agents
IDP-agenttien määritys
Työkulut workflows
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 tokenit palauttavat koodit HTTP 401 ja BEARERTOKEN_EXPIRED, virheelliset koodit HTTP 401 ja INVALID_TOKEN. Publishable Keys voimassa 180 päivää luonnista.
Rajoitukset per token
Free-tariffissa voimassa olevat nopeusrajoitukset lasketaan tokenia kohden. Maksullisissa tariffeissa tiliä lasketaan; kunnes Credits on saatavilla, nopeusrajoituksia ei sovelleta.
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).

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