po_sk_ सर्वर से सर्वर गुप्त कुंजी
- खाते के दायरे में पूर्ण पहुंच
- ब्राउज़र कोड में कभी न दें
- ओरिजिन हेडर की आवश्यकता नहीं
- MCP के लिए ब्लॉक किया गया
प्रमाणीकरण और कुंजियाँ
एक बेयरर टोकन। हर एंडपॉइंट।
PaperOffice-API का हर उत्पाद एंडपॉइंट Authorization: Bearer हेडर की अपेक्षा करता है। कोई OAuth फ्लो नहीं, कोई रिफ्रेश नहीं।
दो टोकन प्रकार, दस अधिकार क्षेत्र, दस्तावेज़ीकृत दर सीमाएँ।
एक हेडर कोई OAuth फ्लो नहीं कभी भी वापस लिया जा सकता है
- स्वयं की यूरोपीय संघ बुनियादी ढांचा आपका डेटा यूरोप में सुरक्षित रहता है।
- ISO 27001 सक्रिय सुरक्षा प्रमाणित।
- SOC 2 प्रकार II सक्रिय अंतर्राष्ट्रीय ऑडिट मानक।
- 24+ वर्षों का अनुभव परीक्षित। स्थिर। भविष्य-सुरक्षित।
curl -X POST "https://api.paperoffice.ai/latest/job/add/workflow" \ -H "Authorization: Bearer po_ut_YOUR_API_KEY" \ -F "[email protected]" \ -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 के लिए अपनी पाइपलाइन वर्कफ़्लो।
- एक हेडर
Authorization: Bearer po_ut_… — एक उत्पाद अंत बिंदु को इससे अधिक की आवश्यकता नहीं है। po_sk_ और po_ut_ कोई Origin हेडर नहीं भेजते हैं।
- पाइपलाइन पथ में
तीन अंडरस्कोर के साथ handler___command; वर्कफ़्लो एक अपवाद है जिसका अपना स्लग है। डॉट नोटेशन API को HTTP 400 JOB_CONFIG_INVALID के साथ उत्तर देता है।
- परिणाम या job_id
client_wait डिफ़ॉल्ट रूप से true है: API कनेक्शन को बनाए रखता है और परिणाम को inline में प्रदान करता है। यदि समय सीमा पर्याप्त नहीं है, तो HTTP 202 job_id और poll_url के साथ आता है GET /latest/job/get/{job_id} के लिए।
idp_collection=invoice के लिए basic-pro-max अनुशंसित मॉडल है: OCR-first मुद्रित संग्रहों को स्थितिओं सहित मूल रूप से basic-pro-max तक सीमित करता है, एक भेजा गया model=premium वापस model: basic-pro-max के रूप में आता है।
टोकन प्रकार
दो टोकन प्रकार, स्पष्ट रूप से अलग
दोनों सर्वर पर होने चाहिए। ऐप में खाता → API के तहत बनाए, घुमाए और रद्द किए जाते हैं।
po_ut_ उपयोगकर्ता-आधारित User Token
- व्यक्तिगत क्षेत्रों तक सीमित किया जा सकता है
- ब्राउज़र कोड में कभी न दें
- कोई Origin हेडर आवश्यक नहीं
- MCP के लिए अनुमोदित
ब्राउज़र से सीधे किए गए कॉल इन दोनों टोकन के माध्यम से नहीं चलते, बल्कि Publishable Key po_pk_ के माध्यम से चलते हैं — उत्पत्ति-आधारित, बजट और दर सीमा वाले। Publishable Keys देखना
अनुमतियाँ
प्रत्येक यूजर टोकन के लिए दस क्षेत्र
एक यूजर टोकन में केवल वही क्षेत्र होते हैं जो आप इसे बनाने पर देते हैं। यदि क्षेत्र अनुपस्थित है, तो API HTTP 403 के साथ उत्तर देता है।
- दस्तावेज़
दस्तावेज़अपलोड, डाउनलोड, प्रसंस्करण
- Workspaces
कार्यालयफ़ोल्डर और संरचना प्रबंधित करें
- AI जॉब्स
ai_jobsOCR, IDP, निष्कर्षण
- बिलिंग
बिलिंगउपयोग और खाता शेष पढ़ें
- उपयोगकर्ता
उपयोगकर्ताटीम के सदस्यों का प्रबंधन करें
- वेबहुक
वेबहुकघटनाएं प्राप्त करें
- ज्ञान आधार
ज्ञान_आधारज्ञान डेटाबेस और FAQ
- एजेंट्स
एजेंट्सIDP एजेंट्स कॉन्फ़िगर करें
- वर्कफ़्लो
कार्यप्रवाहस्वचालन बनाएं
- अनुपालन
अनुपालनऑडिट, जीडीपीआर, आर्काइविंग
रेट-लिमिट्स
API क्या गिनता है
प्रति टोकन शुल्क लिया जाता है; बेयरर के बिना प्रति 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 दिनों बाद समाप्त हो जाती हैं।
- प्रति टोकन सीमाएँ
रेट लिमिट प्रति टोकन के आधार पर गिनी जाती हैं, न कि प्रति खाते। एक संदिग्ध कुंजी से संपूर्ण ऑपरेशन प्रभावित नहीं होता है।
- ब्राउज़र में उत्पत्ति बाइंडिंग
Publishable Keys प्रत्येक अनुरोध पर Allowlist से Origin की मांग करते हैं; अन्यथा API 403 ORIGIN_HEADER_REQUIRED या DOMAIN_NOT_ALLOWED के साथ उत्तर देता है।
- उपयोग का पता लगाना
प्रत्येक बिल किए गए उत्तर में एक _billing ब्लॉक होता है; प्रत्येक कॉल के आधार पर मूल्यांकन के लिए GET /latest/billing/usage-detail का उपयोग करें।
- कठोर प्रतिबंध
ब्राउज़र कुंजियों के लिए खाता लॉगिन, कुंजी प्रबंधन, OAuth, भागीदार एडमिन, भुगतान म्यूटेशन और पासवर्ड क्रैक अवरुद्ध हैं। उत्पाद-APIs सहित बिलिंग पढ़ना और वेबहुक अनुमत हैं। Workspace को हटाएं, रिसाइक्लिंग बास्केट खाली करें और कानूनी होल्ड जारी करें केवल ऐप में (403 UI_ONLY_ENDPOINT)।
वीडियो
प्रमाणीकरण का उपयोग
देखें कि बेयरर टोकन के साथ एक कॉल व्यावहारिक रूप से कैसे काम करता है — वीडियो में।
आगे की जानकारी
जो गलतफहमी हो सकती है
वे पृष्ठ जो प्रमाणीकरण के आसपास संचालन को कवर करते हैं।
शुरू करना
कुंजी बनाएं, हेडर सेट करें, भेजें
ऐप में खाता → API के तहत अपनी कुंजी सेट करें। पहला API कॉल चरण-दर-चरण दिखाया गया है।
संचालन और विश्वास
पहले कॉल से पहले एंटरप्राइज़ टीमें क्या जांचती हैं
अनुबंध, सुरक्षा, सहायता और सीमाएं, सब एक ही स्थान पर लिंक किए गए।
- सुरक्षा और अनुपालन ISO 27001, SOC 2 प्रकार II, स्वयं की यूरोपीय संघ बुनियादी ढांचा।
- SLA 99.9% सेवा स्तर समझौता प्रत्येक कैलेंडर माह में उपलब्धता, अनुबंध द्वारा सुनिश्चित।
- अपने द्वारा संसाधन प्रसंस्करण (DPA) अपने द्वारा संसाधन प्रसंस्करण के लिए GDPR-अनुकूल अनुबंध।
- उप-प्रोसेसर सूची सभी उप-उप-अनुबंधकर्ता, पारदर्शी रूप से सूचीबद्ध।
- तकनीकी सहायता सहायता टीम तक सीधा रास्ता, टिकट के साथ।
- रेट सीमाएं और हेडर प्रत्येक टोकन के लिए दस्तावेज़ीकृत न्यूनतम मान, प्रत्येक प्रतिक्रिया में रेटलिमिट हेडर।
- मूल्य और Credits प्रत्येक कॉल के लिए पारदर्शी Credits मूल्य।
अगला स्टेशन
आगे कैसे बढ़ें
डेवलपर फनल में अनुशंसित अगला कदम और दो उपयुक्त शाखाएं।