Kimlik Doğrulama ve Anahtarlar

Bir Bearer Token. Her uç nokta.

PaperOffice-API'ün her ürün uç noktası Authorization: Bearer başlığını bekler. OAuth akışı yok, yenileme yok.

İki token türü, on yetki kapsamı, belgelenmiş hız limitleri.

API Anahtarı Oluşturma İlk API çağrısını başlatma

Bir başlık OAuth akışı yok Her an iptal edilebilir

app.paperoffice.ai/account/api

İstek 200 OK Token geçerli

Yetkilendirme Başlığı

Authorization: Bearer po_ut_YOUR_API_KEY

İzinler

ocr:read
documents:write
jobs:read

Yanıt

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

Kendi AB Altyapısı Verileriniz Avrupa'da kalır.
ISO 27001 aktif Güvenlik sertifikalı.
SOC 2 Tip II aktif Uluslararası denetim standartları.
24+ yıl deneyim Kanıtlı. Sağlam. Geleceğe yönelik.

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

İlk çağrı

Başlık ayarlayın, boru hattı seçin, gönderin

/latest/job/add/ yolundaki yol kuyruk işi adıdır: genellikle handler___command biçimindedir (örneğin paperoffice_aiocr___generate); yapılandırılmış IDP için kendi boru hattı iş akışınız.

Bir başlık
Authorization: Bearer po_ut_… — bir ürün uç noktasının ihtiyacı olan daha fazlası yoktur. po_sk_ ve po_ut_ Origin başlığı göndermez.
Yoldaki boru hattı
Üç alt çizgi ile handler___command; iş akışı, kendi slug'ı olan istisnadır. Nokta yazımı API'e HTTP 400 JOB_CONFIG_INVALID yanıtı verir.
Sonuç veya job_id
client_wait varsayılan olarak true'dur: API bağlantıyı tutar ve sonucu satır içi olarak sağlar. Zaman penceresi yetersizse, job_id ve GET /latest/job/get/{job_id} için poll_url ile birlikte HTTP 202 döndürülür.

API kataloğunu görüntüleyin IDE'niz için llms-full.txt

idp_collection=invoice için basic-pro-max önerilen modeldir: OCR-first, konumları olan basılı koleksiyonları zaten basic-pro-max ile sınırlar; gönderilen model=premium, model: basic-pro-max olarak döndürülür.

Token türleri

Net şekilde ayrılmış iki token türü

Her ikisi de sunucuya aittir. Hesap → API altında oluşturulur, döndürülür ve iptal edilir.

po_sk_ Sunucu ile Sunucu

Gizli Anahtar

Hesap kapsamında tam erişim
Tarayıcı koduna asla teslim etmeyin
Origin başlığı gerekmez
MCP için engellendi

Secret Key yönetimi

po_ut_ Kullanıcıya yönelik

User Token

Tek alanlarla sınırlanabilir
Tarayıcı koduna asla teslim etmeyin
Origin başlığı gerekmez
MCP için izinli

Kullanıcı belirteci oluşturma

Tarayıcıdan doğrudan yapılan çağrılar bu iki belirteç üzerinden değil, kökene bağlı, bütçe ve oran sınırlı olan po_pk_ yayımlanabilir anahtarı üzerinden gerçekleşir. Publishable Keys Görüntüleme

İzinler

Her Kullanıcı Belirteci İçin On Alan

Bir Kullanıcı Belirteci, oluşturulurken ona verilen tam olarak o alanları taşır. Alan eksikse, API HTTP 403 yanıtı verir.

Belgeler belgeler
Yükleme, İndirme, İşleme
Workspaces çalışma alanları
Klasör ve yapıyı yönetin
AI Görevleri ai_isleri
OCR, IDP, Çıkarma
Faturalandırma faturalandırma
Kullanım ve bakiye bilgilerini okuyun
Kullanıcılar kullanıcılar
Ekip üyelerini yönetin
Web Kancaları webhooklar
Olayları alın
Bilgi Bankası bilgi_tabani
Bilgi tabanı ve SSS
Ajanlar ajanlar
IDP Ajanlarını yapılandırın
İş Akışları iş akışları
Otomasyonlar oluşturun
Uyumluluk uyumluluk
Denetim, KVKK, arşivleme

Hız Sınırları

API neyi sayar

Her Token için sayılır; Bearer olmadan her IP adresi için. Aşağıdaki değerler, her tarifede geçerli olan belgelenmiş minimum değerlerdir.

5: Saniye başına istek
30: Dakika başına istek
100: Saat başına istek
500: Gün başına istek

Kalan değerler yanıt başlığında yer alır
Her yanıtın RateLimit-* ve X-RateLimit-* başlıkları, geçerli pencerede ne kadar kaldığını gösterir.
Aşım: HTTP 429
API RATE_LIMIT_EXCEEDED ile yanıt verir. Retry-After başlığındaki süreden sonra isteği tekrarlayın.
Daha yüksek tarifeler değerleri artırır
Ödenli tarifler bu minimum değerlerin üzerindedir. Hangi tarife hangi kapsama sahip olduğu fiyat sayfasında belirtilmiştir.

Tarifeleri ve kapsamları görüntüleme

Güvenlik

Bir anahtarı ne korur

İşletimde devreye giren altı mekanizma — her biri doğrulanabilir bir durum kodu veya uygulamada bir konum ile.

Döndürme ve iptal
Anahtarlar uygulamada Hesap → API altında oluşturulur, listelenir, döndürülür ve iptal edilir. İptal edilmiş bir token HTTP 401 TOKEN_NOT_FOUND yanıtı verir.
Süre sonu ve geçerlilik
Süresi dolmuş veya hatalı tokenlar HTTP 401 INVALID_TOKEN olarak döner. Yayımlanabilir anahtarlar en geç 365 gün sonra süresi dolar.
Token başına limitler
Rate limitleri token başına hesaplanır, hesap başına değil. Kompromise olmuş bir anahtar tüm operasyonu etkilemez.
Tarayıcıda Köken Bağlama
Publishable Keys her istek için Allowlist'ten bir Origin gerektirir; aksi takdirde API ile 403 ORIGIN_HEADER_REQUIRED veya DOMAIN_NOT_ALLOWED yanıtı döner.
Kullanımı İzleme
Her faturalandırılan yanıt bir _billing bloğu taşır; her çağrı başına değerlendirme GET /latest/billing/usage-detail sağlar.
Sıkı Kısıtlamalar
Hesap girişi, anahtar yönetimi, OAuth, ortak yönetici, ödeme değişiklikleri ve parola kırma işlemi tarayıcı anahtarları için engellenmiştir. APIs ürünü dahil fatura okuma ve webhooks izinlidir. Workspace silme, çöp kutusunu boşaltma ve yasal tutak serbest bırakma yalnızca uygulamada yapılabilir (403 UI_ONLY_ENDPOINT).

Video

Kimlik Doğrulama Kullanımda

Bearer token ile bir çağrının uygulamada nasıl çalıştığını videoda izleyin.

İleri Düzey

Yanında Yer Alanlar

Operasyonu kimlik doğrulama etrafında kapsayan sayfalar.

Publishable Keys Tarayıcıdan doğrudan aramalar po_pk_ ile. Web Kancaları Poloing yerine olayları alın. Postman-Koleksiyon Tüm uç noktalar gezilebilir. API-Kataloğu Hangi uç nokta hangi işi yapar. llms-full.txt IDE'niz için tüm dokümantasyon. Tarifler Herhangi bir tarifin hangi kapsamı kapsadığı.

Başlayalım

Anahtar oluşturun, başlık ayarlayın, gönderin

Anahtarı uygulamada Hesap → API altında oluşturursunuz. İlk çağrı adım adım ilk API çağrısında açıklanmıştır.

API Anahtarı Oluşturma İlk API çağrısını başlatma

Operasyon ve güven

Kurumsal ekiplerin ilk çağrıdan önce neyi kontrol ettiği

Sözleşmeler, güvenlik, destek ve limitler, her şey tek bir yerde bağlantılı.

Sonraki durak

Devamı şöyle

Developer hunisindeki önerilen bir sonraki adım ve iki uygun yan dal.

Webhooks & EventsGerçek zamanlı olaylar, HMAC İlk API ÇağrısıAnahtarı alın, isteği gönderin, yanıtı kontrol edin Postman CollectionPostman'da içe aktarma, test etme ve hata ayıklama

Developer girişine dönüş

PaperOffice AI’yı 14 dakikada anlayın.

PaperOffice’i nasıl kullanmak istersiniz?