المصادمة والمفاتيح

رمز البearer. كل نقطة نهاية.

تتوقع كل نقطة نهاية لمنتج PaperOffice-API رأس Authorization: Bearer. لا يوجد تدفق OAuth، ولا يوجد تحديث للرمز.

نوعان من الرموز، عشرة نطاقات صلاحيات، حدود معدل موثقة.

إنشاء مفتاح API بدء أول استدعاء لـ API

رأس واحد لا يوجد تدفق OAuth قابل للإلغاء في أي وقت

app.paperoffice.ai/account/api

طلب 200 OK الرمز صالح

رأس التفويض

Authorization: Bearer po_ut_YOUR_API_KEY

الصلاحيات

ocr:read
documents:write
jobs:read

الاستجابة

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

بنية الاتحاد الأوروبي الخاصة تظل بياناتك في أوروبا.
ISO 27001 نشط معتمد من حيث الأمان.
SOC 2 النوع الثاني نشط معايير التدقيق الدولية.
أكثر من 24 عاماً من الخبرة مجرب. مستقر. آمن للمستقبل.

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

المكالمة الأولى

تعيين الرأس، اختيار خط الأنابيب، الإرسال

المسار إلى /latest/job/add/ هو اسم وظيفة الطابور: عادةً بالصيغة handler___command (مثل paperoffice_aiocr___generate)، بالنسبة لـ IDP المهيكلة، يكون خط أنابيب العمل الخاص بك.

رأس واحد
Authorization: Bearer po_ut_… — لا يحتاج نقطة نهاية المنتج إلى أكثر من ذلك. po_sk_ و po_ut_ لا يرسلان رأس Origin.
خط الأنابيب في المسار
handler___command مع ثلاثة شرطات سفلية؛ workflow هو الاستثناء بـ slug خاص به. الكتابة بنقاط تعيد API بـ HTTP 400 JOB_CONFIG_INVALID.
النتيجة أو job_id
client_wait افتراضيًا صحيح: تحافظ API على الاتصال وتُرجع النتيجة مضمنةً. إذا لم يكن الإطار الزمني كافيًا، يتم إرجاع HTTP 202 مع job_id و poll_url للاستعلام عن GET /latest/job/get/{job_id}.

عرض كتالوج API ملف llms-full.txt لبيئة التطوير الخاصة بك

بالنسبة إلى idp_collection=invoice، يُعد basic-pro-max النموذج الموصى به: تقيّد OCR-first المجموعات المطبوعة ذات البنود فعليًا بـ basic-pro-max؛ وسيتم إرجاع أي model=premium مُرسل كـ model: basic-pro-max.

أنواع الرموز المميزة

نوعان من الرموز المميزة، مفصولان بوضوح

كلاهما يُرسل إلى الخادم. يتم إنشاؤها وتداولها وإلغاؤها في التطبيق تحت الحساب → API.

po_sk_ خادم إلى خادم

المفتاح السري

وصول كامل ضمن نطاق الحساب
عدم التسليم أبداً في كود المتصفح
لا حاجة لرأس Origin
محظور لـ MCP

إدارة مفتاح السرية

po_ut_ مخصص للمستخدم

User Token

قابل للقيود على مناطق محددة
عدم التسليم أبداً في كود المتصفح
لا حاجة لرأس Origin
مسموح لـ MCP

إنشاء رمز المستخدم

لا تمر الاستدعاءات المباشرة من المتصفح عبر هذين الرمزَين، بل عبر المفتاح القابل للنشر po_pk_ — مرتبط بالمصدر، ومحدود بالميزانية والمعدلات. عرض المفاتيح القابلة للنشر

الصلاحيات

عشرة مجالات لكل رمز مستخدم

يحمل رمز المستخدم بالضبط المجالات التي تمنحها له عند الإنشاء. إذا غاب المجال، سيعود الرد بـ API مع HTTP 403.

المستندات مستندات
تحميل، تنزيل، معالجة
Workspaces مساحات العمل
إدارة المجلدات والهيكل
وظائف الذكاء الاصطناعي الوظائف_الذكاء_الاصطناعي
OCR، IDP، الاستخراج
الفوترة الفواتير
قراءة الاستخدام ورصيد الحساب
المستخدمون المستخدمون
إدارة أعضاء الفريق
الويب هوكس الويب هوكس
استلام الأحداث
قاعدة المعرفة قاعدة المعرفة
قاعدة البيانات المعرفية والأسئلة الشائعة
الوكلاء الوكلاء
تكوين وكلاء IDP
سير العمل سير_عملية
إنشاء الأتمتة
الامتثال الامتثال
التدقيق، اللائحة العامة لحماية البيانات (GDPR)، الأرشفة

حدود المعدل

ما تحسبه API

يتم الحساب لكل رمز؛ بدون Bearer لكل عنوان IP. القيم التالية هي القيم الدنيا الموثقة التي تنطبق على كل باقة.

5: طلبات في الثانية
30: طلبات في الدقيقة
100: طلبات في الساعة
500: طلبات في اليوم

القيم المتبقية موجودة في رأس الاستجابة
تخبرك رؤوس RateLimit-* و X-RateLimit-* في كل استجابة بكمية الموارد المتبقية في النافذة الحالية.
الانتهاك: HTTP 429
ترد API برمز RATE_LIMIT_EXCEEDED. أعد إرسال الطلب بعد الوقت المحدد في رأس Retry-After.
الباقات الأعلى ترفع القيم
تقع الأسعار المدفوعة فوق هذه القيم الدنيا. يوضح صفحة الأسعار نطاق كل باقة.

عرض الباقات والنطاق

الأمان

ما الذي يؤمن المفتاح الرئيسي

ستة آليات تعمل أثناء التشغيل - لكل منها رمز حالة قابل للتحقق أو موقع في التطبيق.

التدوير والإلغاء
يتم إنشاء المفاتيح وعرضها وتدويرها وإلغاؤها في التطبيق تحت الحساب → API. يعيد الرمز الملغي استجابة HTTP 401 TOKEN_NOT_FOUND.
الانتهاء والصلاحية
تعود الرموز المنتهية أو الخاطئة كـ HTTP 401 INVALID_TOKEN. تنتهي صلاحية المفاتيح القابلة للنشر بعد 365 يوماً كحد أقصى.
حدود لكل رمز
تُحسب حدود المعدل لكل رمز مميز، وليس لكل حساب. المفتاح المخترق لا يثقل كاهل العملية بأكملها.
ربط المصدر في المتصفح
تطلب المفاتيح القابلة للنشر رأس Origin من القائمة المسموحة مع كل طلب؛ وإلا ستعيد API استجابة 403 ORIGIN_HEADER_REQUIRED أو DOMAIN_NOT_ALLOWED.
تتبع الاستخدام
كل استجابة محاسبية تحمل كتلة _billing؛ يوفر التقييم لكل استدعاء GET /latest/billing/usage-detail.
حظر صارم
تسجيل الدخول إلى الحساب، وإدارة المفاتيح، وOAuth، وإدارة شركاء الأعمال، وتعديلات الدفع وكسر كلمة المرور محظورة لمفاتيح المتصفح. مسموح بمنتج APIs بما في ذلك قراءة الفواتير وWebhooks. يجب حذف Workspace وتفريغ سلة المهملات وإلغاء احتجاز الحفظ القانوني فقط عبر التطبيق (403 UI_ONLY_ENDPOINT).

فيديو

المصادقة في الاستخدام

شاهد كيف يعمل الاستدعاء مع رمز البearer في الممارسة العملية — في الفيديو.

لمزيد من القراءة

ما هو موجود هناك

الصفحات التي تغطي العمليات حول المصادقة.

Publishable Keys اتصالات مباشرة من المتصفح باستخدام po_pk_. ويب هوكس استقبال الأحداث بدلاً من الاستعلام الدوري. مجموعة Postman جميع نقاط النهاية للتنقل بينها. كتالوج API نقطة النهاية التي تقوم بأي عمل. llms-full.txt الوثائق الكاملة لبيئة التطوير الخاصة بك. الأسعار أي حزمة تغطي أي نطاق.

البدء الآن

إنشاء المفتاح، تعيين الرأس، الإرسال

قم بإنشاء المفتاح في التطبيق تحت الحساب → API. يظهر الاستدعاء الأول خطوة بخطوة في أول استدعاء لـ API.

إنشاء مفتاح API بدء أول استدعاء لـ API

التشغيل والثقة

ما تتحقق منه فرق المؤسسات قبل المكالمة الأولى

العقود، والأمان، والدعم، والحدود، كل الروابط في مكان واحد.

المحطة التالية

كيف تستمر

الخطوة التالية الموصى بها في قمع المطورين وفرعان مناسبان.

Webhooks & Eventsأحداث فورية بتوقيع HMAC أول استدعاء APIاحصل على المفتاح، أرسل الطلب، تحقق من الاستجابة Postman Collectionاستيراد، اختبار، وتصحيح في Postman

العودة إلى بداية المطور

افهموا PaperOffice AI في 14 دقيقة.

كيف ترغبون في استخدام PaperOffice؟