poai_ Sunucu ile Sunucu API anahtarı
- Oluşturan hesabın yetkileri (yönetici: tüm hesap)
- Tarayıcı koduna asla teslim etmeyin
- Origin başlığı gerekmez
- MCP için engellendi
- IP adresleriyle sınırlandırılabilir
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ü, net haklar, belgelenmiş hız sınırları.
Bir başlık OAuth akışı yok Her an iptal edilebilir
- Kendi AB Altyapısı Verileriniz Avrupa'da kalır.
- ISO/IEC 27001 sertifikalı Güvenlik sertifikalı.
- 24+ yıl deneyim Kanıtlı. Sağlam. Geleceğe yönelik.
curl -X POST "https://api.paperoffice.ai/latest/job/add/workflow" \ -H "Authorization: Bearer po_ut_YOUR_API_KEY" \ -F "file_1=@invoice.pdf" \ -F "idp_collection=invoice" \ -F "model=basic-pro-max"import requestsresponse = requests.post( "https://api.paperoffice.ai/latest/job/add/workflow", headers={"Authorization": "Bearer po_ut_YOUR_API_KEY"}, files={"file_1": open("invoice.pdf", "rb")}, data={"idp_collection": "invoice", "model": "basic-pro-max"},)print(response.json())const form = new FormData();form.append("file_1", new Blob([await readFile("invoice.pdf")]), "invoice.pdf");form.append("idp_collection", "invoice");form.append("model", "basic-pro-max");const response = await fetch("https://api.paperoffice.ai/latest/job/add/workflow", { method: "POST", headers: { Authorization: "Bearer po_ut_YOUR_API_KEY" }, body: form,});console.log(await response.json());İlk çağrı
Başlık ayarlayın, boru hattı seçin, gönderin
/latest/job/add/ sonrası yol işlem adıdır: genellikle handler___command biçimindedir (örneğin paperoffice_aiocr___generate) ve yapılandırılmış IDP için özel workflow hattı kullanılır.
- Bir başlık
Authorization: Bearer po_ut_… — bir ürün uç noktasının ihtiyacı olan daha fazlası yoktur. poai_ 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.
idp_collection=invoice için basic-pro-max önerilen modeldir. Gerçekte kullanılan model, yanıt alanı olan 'model' içinde döndürülür ve istenen modelden farklı olabilir.
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_ut_ Kullanıcıya yönelik User Token
- Kullanıcısının yetkilerini taşır
- Tarayıcı koduna asla teslim etmeyin
- Origin başlığı gerekmez
- MCP için izinli
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
User Token'ün yapabilecekleri
User Token, bu alanlarda kullanıcısının tam yetkilerine sahiptir. Oluşturma sırasında tek tek alanlar atanamaz; daraltma için bir kullanıcı grubunun yetkilerini içeren bir grup belirteci (po_gt_) kullanılır.
- Belgeler
documentsYükleme, İndirme, İşleme
- Workspaces
workspacesKlasör ve yapıyı yönetin
- AI Görevleri
ai_jobsOCR, IDP, Çıkarma
- Faturalandırma
billingKullanım ve bakiye bilgilerini okuyun
- Kullanıcılar
usersEkip üyelerini yönetin
- Web Kancaları
webhooksOlayları alın
- Bilgi Bankası
knowledge_baseBilgi tabanı ve SSS
- Ajanlar
agentsIDP Ajanlarını yapılandırın
- İş Akışları
workflowsOtomasyonlar oluşturun
- Uyumluluk
complianceDenetim, 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.
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 dolan tokenlar HTTP 401 BEARERTOKEN_EXPIRED ile, hatalı olanlar ise HTTP 401 INVALID_TOKEN ile yanıt verir. Publishable Keys oluşturulmasından itibaren 180 gün geçerlidir.
- Token başına limitler
Free tarifesinde belirteç başına hız sınırlamaları geçerlidir. Ücretli tarifelerde hesap bazlı sayım yapılır; Credits mevcut olduğu sürece ücretli tarifelerde hız sınırlaması uygulanmaz.
- 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).
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.
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ı.
- Güvenlik ve Uyumluluk ISO/IEC 27001 sertifikalı, kendi AB altyapısı.
- %99,9 SLA Her takvim ayı için kullanılabilirlik, sözleşme ile garanti edilir.
- Veri İşleme Sözleşmesi (DPA) GDPR Madde 28 uyarınca veri işleme sözleşmesi.
- Alt İşleyici Yok Motor, depolama ve işleme için tek sağlayıcı.
- Teknik Destek Destek ekibine doğrudan erişim ve bir destek talebi.
- Hız Limitleri ve Başlıklar Her token için belgelenen minimum değerler, her yanıtta RateLimit başlığı.
- Fiyatlar ve Credits Her çağrı için şeffaf Credits fiyatları.
Sonraki durak
Devamı şöyle
Developer hunisindeki önerilen bir sonraki adım ve iki uygun yan dal.
