אימות ומפתחות

אסימון Bearer. כל נקודת קצה.

כל נקודת הקצה של מוצר ב-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 סוג II פעיל תקני ביקורת בינלאומיים.
מעל 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 הוא החריג עם סלאג ייעודי. שימוש בנקודות עונה על API עם HTTP 400 JOB_CONFIG_INVALID.
תוצאה או job_id
client_wait הוא true כברירת מחדל: API שומר על החיבור ומחזיר את התוצאה באופן מיידי. אם חלון הזמן אינו מספיק, יוחזר HTTP 202 עם job_id ו-poll_url עבור GET /latest/job/get/{job_id}.

צפה בקטלוג API llms-full.txt עבור ה-IDE שלך

עבור 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

יצירת אסימון משתמש

קריאות ישירות מהדפדפן אינן עוברות דרך שני האסימונים הללו, אלא דרך מפתח ה-Publishable po_pk_ — קשור למקור, עם תקציב ומגבלות קצב. צפייה במפתחות Publishable

הרשאות

עשרה תחומים לכל אסימון משתמש

אסימון משתמש נושא בדיוק את התחומים שאתה מעניק לו בעת יצירתו. אם התחום חסר, API ישיב עם HTTP 403.

מסמכים מסמכים
העלאה, הורדה, עיבוד
Workspaces מרחבי עבודה
ניהול תיקיות ומבנה
משימות AI ai_jobs
OCR, IDP, חילוץ
חיוב חשבונית
קריאת שימוש ויתרת חשבון
משתמשים משתמשים
ניהול חברי צוות
ווב hooks וובהוקים
קבלת אירועים
בסיס ידע מאגר_ידע
מאגר ידע ושאלות נפוצות
סוכנים סוכנים
תצורת סוכני 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. מפתחות Publishable פגים לכל המאוחר לאחר 365 ימים.
מגבלות לכל אסימון
מגבלות קצב נספרות לכל אסימון, לא לחשבון. מפתח שנפרץ אינו מטעין את כל הפעילות.
קשירת מקור בדפדפן
מפתחות ציבוריים (Publishable Keys) דורשים מקור (Origin) מרשימת ההיתרים בכל בקשה; אחרת התגובה תהיה API עם סטטוס 403 ORIGIN_HEADER_REQUIRED או DOMAIN_NOT_ALLOWED.
מעקב אחר השימוש
כל תגובה שנספרת כוללת בלוק _billing; הערכה לפי קריאה מספקת GET /latest/billing/usage-detail.
חסימות קפדניות
כניסה לחשבון, ניהול מפתחות, OAuth, מנהל שותפים, פעולות תשלום ופריצת סיסמאות חסומים למפתחות דפדפן. מוצר APIs כולל קריאת חיוב ו-webhooks מותרים. מחיקת Workspace, ריקת סל המיחזור והעברת Legal-Hold מתבצעים רק באפליקציה (403 UI_ONLY_ENDPOINT).

וידאו

אימות בשימוש

צפה כיצד קריאה עם אסימון Bearer פועלת בפועל — בסרטון.

לקריאה נוספת

מה שנמצא ליד

הדפים שמכסים את הפעילות סביב האימות.

Publishable Keys קריאות ישירות מהדפדפן עם po_pk_. ווב hooks קבל אירועים במקום לבצע polling. אוסף Postman כל הנקודות הקצה לדפדוף. קטלוג API איזו נקודת קצה מבצעת איזו פעולה. llms-full.txt התיעוד המלא עבור ה-IDE שלך. תעריפים היקף התעריף הרלוונטי.

תחילת עבודה

צור מפתח, הגדר כותרת, שלח

הגדר את המפתח באפליקציה תחת חשבון → API. הקריאה הראשונה מתוארת צעד אחר צעד ב-API-Call הראשון.

יצירת מפתח API התחלת קריאת ה-API הראשונה

תפעול ואמון

מה צוותי ארגוניים בודקים לפני השיחה הראשונה

חוזה, אבטחה, תמיכה ומגבלות, הכל מקושר במקום אחד.

התחנה הבאה

המשך התהליך

הצעד המומלץ הבא במשפך המפתחים ושני מסלולים נלווים.

Webhooks & Eventsאירועים בזמן אמת, HMAC קריאת API ראשונהקבל מפתח, שלח בקשה, בדוק תגובה Postman Collectionייבוא, בדיקה ותיקון באפליקציית Postman

חזרה להתחלת המפתחים

להבין את PaperOffice AI ב-14 דקות.

כיצד תרצו להשתמש ב-PaperOffice?