Autentikasi dan Kunci

Sebuah Token Bearer. Setiap titik akhir.

Setiap titik akhir produk PaperOffice-API mengharapkan header Authorization: Bearer. Tidak ada alur OAuth, tidak ada pembaruan otomatis.

Dua jenis token, sepuluh ruang lingkup izin, batas laju yang terdokumentasi.

Membuat kunci API Memulai panggilan API pertama

Satu header Tidak ada alur OAuth Dapat ditarik kembali kapan saja

app.paperoffice.ai/account/api

Permintaan 200 OK Token valid

Header Otorisasi

Authorization: Bearer po_ut_YOUR_API_KEY

Izin

ocr:read
documents:write
jobs:read

Respons

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

Infrastruktur Uni Eropa Sendiri Data Anda tetap berada di Eropa.
ISO 27001 aktif Keamanan bersertifikat.
SOC 2 Tipe II aktif Standards audit internasional.
Pengalaman lebih dari 24 tahun Terbukti. Stabil. Siap untuk masa depan.

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

Panggilan pertama

Atur header, pilih pipeline, kirim

Path ke /latest/job/add/ adalah nama job antrian: biasanya dalam bentuk handler___command (misalnya paperoffice_aiocr___generate), untuk IDP terstruktur gunakan workflow pipeline Anda sendiri.

Satu header
Authorization: Bearer po_ut_… — lebih dari itu tidak diperlukan oleh endpoint produk. po_sk_ dan po_ut_ tidak mengirim header Origin.
Pipeline dalam path
handler___command dengan tiga underscore; workflow adalah pengecualian dengan slug sendiri. Penulisan titik menjawab API dengan HTTP 400 JOB_CONFIG_INVALID.
Hasil atau job_id
client_wait secara default adalah true: API menjaga koneksi dan memberikan hasil secara inline. Jika jendela waktu tidak mencukupi, akan muncul HTTP 202 dengan job_id dan poll_url untuk GET /latest/job/get/{job_id}.

Lihat katalog API llms-full.txt untuk IDE Anda

Untuk idp_collection=invoice, basic-pro-max adalah model yang direkomendasikan: OCR-first membatasi kumpulan cetak dengan posisi pada basic-pro-max; model=premium yang dikirim akan dikembalikan sebagai model: basic-pro-max.

Jenis Token

Dua Jenis Token, Terpisah Jelas

Keduanya harus disimpan di server. Dibuat, diputar, dan dicabut di aplikasi melalui Akun → API.

po_sk_ Server ke Server

Kunci Rahasia

Akses penuh dalam batas akun
Jangan pernah di-deliver ke kode browser
Tidak diperlukan header Origin
Diblokir untuk MCP

Kelola Kunci Rahasia

po_ut_ Peran Pengguna

User Token

Dapat dibatasi pada area tertentu
Jangan pernah diimplementasikan dalam kode browser
Tidak diperlukan header Origin
Diizinkan untuk MCP

Buat Token Pengguna

Panggilan langsung dari browser tidak berjalan melalui kedua token ini, melainkan melalui Publishable Key po_pk_ — terikat pada asal, dibatasi anggaran dan rate. Lihat Publishable Keys

Izin

Sepuluh area per Token Pengguna

Sebuah Token Pengguna hanya mencakup area yang Anda berikan saat pembuatannya. Jika area tersebut tidak ada, API akan merespons dengan HTTP 403.

Dokumen dokumen
Unggah, Unduh, Pemrosesan
Workspaces ruang_kerja
Kelola folder dan struktur
Pekerjaan AI ai_jobs
OCR, IDP, Ekstraksi
Penagihan billing
Baca penggunaan dan saldo akun
Pengguna pengguna
Kelola anggota tim
Webhook webhooks
Terima peristiwa
Basis Pengetahuan basis_pengetahuan
Database pengetahuan dan FAQ
Agen agen
Konfigurasi Agen IDP
Alur Kerja aliran kerja
Buat otomatisasi
Kepatuhan kepatuhan
Audit, GDPR, pengarsipan

Batas Rasio

Apa yang dihitung API

Penagihan dilakukan per token; tanpa Bearer per alamat IP. Nilai-nilai berikut adalah nilai minimum yang didokumentasikan dan berlaku untuk setiap paket layanan.

5: Permintaan per detik
30: Permintaan per menit
100: Permintaan per jam
500: Permintaan per hari

Nilai sisa terdapat di header respons
Header RateLimit-* dan X-RateLimit-* pada setiap respons menunjukkan berapa banyak kuota yang masih tersisa dalam jendela waktu berjalan.
Pelanggaran: HTTP 429
API merespons dengan RATE_LIMIT_EXCEEDED. Ulangi panggilan setelah waktu yang ditentukan dalam header Retry-After.
Paket layanan yang lebih tinggi meningkatkan nilai batas
Tarif yang dibayar berada di atas nilai minimum ini. Tarif mana memiliki cakupan apa, dapat dilihat di halaman harga.

Lihat tarif dan cakupan

Keamanan

Apa yang mengamankan sebuah Key

Enam mekanisme yang beroperasi — masing-masing dengan kode status yang dapat diverifikasi atau lokasi di aplikasi.

Rotasi dan Pencabutan
Keys dibuat, didaftarkan, diputar, dan dicabut di aplikasi di bawah Akun → API. Token yang dicabut akan merespons dengan HTTP 401 TOKEN_NOT_FOUND.
Kedaluwarsa dan Validitas
Token yang kedaluwarsa atau tidak valid akan dikembalikan sebagai HTTP 401 INVALID_TOKEN. Publishable Keys akan kedaluwarsa paling lambat setelah 365 hari.
Batas per Token
Batas laju dihitung per token, bukan per akun. Kunci yang telah dikompromikan tidak membebani seluruh operasi.
Pengikatan Asal di Browser
Publishable Keys memerlukan Origin dari daftar yang diizinkan pada setiap permintaan; jika tidak, API akan merespons dengan 403 ORIGIN_HEADER_REQUIRED atau DOMAIN_NOT_ALLOWED.
Pelacakan Penggunaan
Setiap respons yang ditagih menyertakan blok _billing; evaluasi per panggilan menyediakan GET /latest/billing/usage-detail.
Pemblokiran Ketat
Login akun, manajemen kunci, OAuth, admin mitra, mutasi pembayaran, dan cracking kata sandi diblokir untuk kunci browser. Produk APIs termasuk pembacaan penagihan dan webhook diizinkan. Workspace dihapus, tempat sampah dikosongkan, dan pelepasan hold hukum hanya dapat dilakukan melalui aplikasi (403 UI_ONLY_ENDPOINT).

Video

Authentifizierung in der Praxis

Lihat bagaimana panggilan dengan Bearer-token berjalan dalam praktiknya — dalam video.

Selanjutnya

Yang Terkait

Halaman-halaman yang mencakup operasi seputar autentikasi.

Publishable Keys Panggilan langsung dari browser dengan po_pk_. Webhook Terima peristiwa alih-alih polling. Postman-Koleksi Semua titik akhir untuk dijelajahi. Katalog API Titik akhir mana yang melakukan pekerjaan apa. llms-full.txt Dokumentasi lengkap untuk IDE Anda. Tarif Tarif mana yang menanggung volume mana.

Mulai

Buat kunci, atur header, kirim

Anda dapat mengatur Key di aplikasi di bawah Akun → API. Panggilan pertama API dijelaskan langkah demi langkah.

Membuat kunci API Memulai panggilan API pertama

Operasi dan Kepercayaan

Yang diperiksa tim perusahaan sebelum panggilan pertama

Kontrak, keamanan, dukungan, dan batas semua terhubung di satu tempat.

Berikutnya

Lanjutkan seperti ini

Langkah selanjutnya yang direkomendasikan dalam funnel pengembang dan dua cabang yang sesuai.

Webhooks & EventsPeristiwa waktu nyata, HMAC Panggilan API PertamaDapatkan kunci, kirim permintaan, periksa respons Postman CollectionImpor, uji, dan debug di Postman

Kembali ke awal pengembang

Pahami PaperOffice AI dalam 14 menit.

Bagaimana Anda ingin menggunakan PaperOffice?