poai_ خادم إلى خادم مفتاح API
- صلاحيات الحساب الذي ينشئه (المسؤول: كامل الحساب)
- عدم التسليم أبداً في كود المتصفح
- لا حاجة لرأس Origin
- محظور لـ MCP
- يمكن تقييده بعناوين IP
المصادقة والمفاتيح
رمز Bearer. كل نقطة نهاية.
تتوقع كل نقطة نهاية لمنتج PaperOffice-API رأس Authorization: Bearer. لا يوجد تدفق OAuth، ولا يوجد تحديث للرمز.
نوعان من الرموز، صلاحيات واضحة، وحدود معدل استخدام موثقة.
رأس واحد لا يوجد تدفق OAuth قابل للإلغاء في أي وقت
- بنية الاتحاد الأوروبي الخاصة بياناتكم تبقى في أوروبا.
- ISO/IEC 27001 معتمد معتمد من حيث الأمان.
- أكثر من 24 عاماً من الخبرة مجرب. مستقر. آمن للمستقبل.
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());المكالمة الأولى
تعيين الرأس، اختيار خط الأنابيب، الإرسال
المسار بعد /latest/job/add/ هو اسم العملية: عادةً ما يكون بصيغة handler___command (على سبيل المثال paperoffice_aiocr___generate)، ولـ IDP المهيكلة، تُستخدم خط الأنابيب المخصص workflow.
- رأس واحد
Authorization: Bearer po_ut_… — لا يحتاج نقطة نهاية المنتج إلى أكثر من ذلك. poai_ و 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}.
بالنسبة إلى idp_collection=invoice، يُعد basic-pro-max النموذج الموصى به. يتم إرجاع النموذج الفعلي المستخدم في حقل الاستجابة "model"، وقد يختلف عن النموذج المطلوب.
أنواع الرموز المميزة
نوعان من الرموز المميزة، مفصولان بوضوح
كلاهما يُرسل إلى الخادم. يتم إنشاؤها وتداولها وإلغاؤها في التطبيق تحت الحساب ← API.
po_ut_ مخصص للمستخدم User Token
- يساهم بصلاحيات مستخدمه
- عدم التسليم أبداً في كود المتصفح
- لا حاجة لرأس Origin
- مسموح لـ MCP
لا تمر الاستدعاءات المباشرة من المتصفح عبر هذين الرمزَين، بل عبر المفتاح القابل للنشر po_pk_ — مرتبط بالمصدر، ومحدود بالميزانية والمعدلات. عرض المفاتيح القابلة للنشر
الصلاحيات
ما يُسمح لـ User Token بفعله
يتمتع User Token بالضبط بالصلاحيات الخاصة بمستخدمه في هذه المجالات. لا يمكن تعيين مجالات فردية أثناء الإنشاء؛ ويهدف تضييق النطاق إلى استخدام رمز مجموعة (po_gt_) possessing صلاحيات مجموعة المستخدمين.
- المستندات
documentsتحميل، تنزيل، معالجة
- Workspaces
workspacesإدارة المجلدات والهيكل
- وظائف الذكاء الاصطناعي
ai_jobsOCR، IDP، الاستخراج
- الفوترة
billingقراءة الاستخدام ورصيد الحساب
- المستخدمون
usersإدارة أعضاء الفريق
- الويب هوكس
webhooksاستلام الأحداث
- قاعدة المعرفة
knowledge_baseقاعدة البيانات المعرفية والأسئلة الشائعة
- الوكلاء
agentsتكوين وكلاء IDP
- سير العمل
workflowsإنشاء الأتمتة
- الامتثال
complianceالتدقيق، اللائحة العامة لحماية البيانات (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 BEARERTOKEN_EXPIRED، وتعود الرموز غير الصحيحة إلى HTTP 401 INVALID_TOKEN. تنطبق Publishable Keys لمدة 180 يومًا من تاريخ الإنشاء.
- حدود لكل رمز
في خطة Free، تنطبق حدود المعدل (Rate-Limits) لكل رمز. في الخطط المدفوعة، يُحسب حسب الحساب؛ طالما أن Credits متاحة، لا تنطبق حدود المعدل هناك.
- ربط المصدر في المتصفح
تطلب المفاتيح القابلة للنشر رأس Origin من القائمة المسموحة مع كل طلب؛ وإلا ستعيد API استجابة 403 ORIGIN_HEADER_REQUIRED أو DOMAIN_NOT_ALLOWED.
- تتبع الاستخدام
كل استجابة محاسبية تحمل كتلة _billing؛ يوفر التقييم لكل استدعاء GET /latest/billing/usage-detail.
- حظر صارم
تسجيل الدخول إلى الحساب، وإدارة المفاتيح، وOAuth، وإدارة شركاء الأعمال، وتعديلات الدفع وكسر كلمة المرور محظورة لمفاتيح المتصفح. مسموح بمنتج APIs بما في ذلك قراءة الفواتير وWebhooks. يجب حذف Workspace وتفريغ سلة المهملات وإلغاء احتجاز الحفظ القانوني فقط عبر التطبيق (403 UI_ONLY_ENDPOINT).
البدء الآن
إنشاء المفتاح، تعيين الرأس، الإرسال
قم بإنشاء المفتاح في التطبيق تحت الحساب ← API. يظهر الاستدعاء الأول خطوة بخطوة في أول استدعاء لـ API.
التشغيل والثقة
ما تتحقق منه فرق المؤسسات قبل المكالمة الأولى
العقود، والأمان، والدعم، والحدود، كل الروابط في مكان واحد.
- الأمان والامتثال ISO/IEC 27001 معتمد، بنية تحتية خاصة في الاتحاد الأوروبي.
- اتفاقية مستوى الخدمة (SLA) بنسبة 99.9٪ التوفر الشهري حسب التقويم، مضمون تعاقديًا.
- معالجة البيانات نيابة عن العميل (DPA) عقد معالجة البيانات وفقًا للمادة 28 من اللائحة العامة لحماية البيانات (GDPR).
- لا يوجد معالجون فرعيون مورد واحد للمحرك والتخزين والمعالجة.
- الدعم الفني طريقة مباشرة للوصول إلى فريق الدعم، عبر تذكرة.
- حدود المعدلات والرؤوس القيم الدنيا الموثقة لكل رمز مميز، ورؤوس حد المعدل في كل استجابة.
- الأسعار و Credits أسعار Credits شفافة لكل استدعاء.
المحطة التالية
كيف تستمر
الخطوة التالية الموصى بها في قمع المطورين وفرعان مناسبان.
