การตรวจสอบสิทธิ์และคีย์

Bearer Token หนึ่งตัว ทุกจุดปลาย

จุดปลายผลิตภัณฑ์ทุกจุดของ PaperOffice-API ต้องการส่วนหัว Authorization: Bearer ไม่มีขั้นตอน OAuth ไม่มีการรีเฟรช

ประเภทโทเค็นสองประเภท, ขอบเขตสิทธิ์สิบประการ, อัตราจำกัดที่บันทึกไว้

สร้างคีย์ API เริ่มการเรียก API ครั้งแรก

ส่วนหัวหนึ่งตัว ไม่มี OAuth Flow เพิกถอนได้ตลอดเวลา

app.paperoffice.ai/account/api

คำขอ 200 OK โทเค็นถูกต้อง

ส่วนหัว Authorization

Authorization: Bearer po_ut_YOUR_API_KEY

สิทธิ์

ocr:read
documents:write
jobs:read

การตอบกลับ

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

โครงสร้างพื้นฐาน EU ของตนเอง ข้อมูลของคุณยังคงอยู่ในยุโรป
ISO 27001 เปิดใช้งาน ความปลอดภัยได้รับการรับรอง
SOC 2 Type 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());

การเรียกใช้ครั้งแรก

ตั้งค่า Header, เลือก Pipeline, ส่ง

เส้นทางไปยัง /latest/job/add/ คือชื่อ Job ในคิว: โดยทั่วไปอยู่ในรูปแบบ handler___command (เช่น paperoffice_aiocr___generate) สำหรับ IDP แบบมีโครงสร้างคือ workflow ของ Pipeline ของคุณเอง

หนึ่ง Header
Authorization: Bearer po_ut_… — จุดสิ้นสุดของผลิตภัณฑ์ไม่ต้องการมากกว่านี้ po_sk_ และ po_ut_ ไม่ส่ง Header Origin
Pipeline ในเส้นทาง
handler___command ด้วยขีดล่างสามตัว; workflow เป็นข้อยกเว้นด้วย Slug ของตนเอง การเขียนแบบจุดจะตอบกลับ 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

สามารถจำกัดให้เข้าถึงเฉพาะพื้นที่บางส่วนได้
ห้ามส่งมอบในโค้ดเบราว์เซอร์โดยเด็ดขาด
ไม่จำเป็นต้องมี Header ของ Origin
อนุญาตสำหรับ MCP

สร้างโทเค็นผู้ใช้

การเรียกโดยตรงจากเบราว์เซอร์จะไม่ผ่านโทเค็นทั้งสองนี้ แต่จะผ่าน Publishable Key po_pk_ — ซึ่งผูกกับแหล่งที่มา มีงบประมาณและจำกัดอัตรา ดู Publishable Keys

สิทธิ์

สิบพื้นที่สำหรับโทเค็นผู้ใช้แต่ละตัว

โทเค็นผู้ใช้จะมีเฉพาะพื้นที่ที่คุณกำหนดไว้เมื่อสร้าง หากขาดพื้นที่นั้น ระบบจะตอบกลับด้วย HTTP 403 พร้อมรหัส API

เอกสาร เอกสาร
อัปโหลด ดาวน์โหลด ประมวลผล
Workspaces พื้นที่ทำงาน
จัดการโฟลเดอร์และโครงสร้าง
งาน AI ai_jobs
OCR, IDP, การดึงข้อมูล
การเรียกเก็บเงิน การเรียกเก็บเงิน
อ่านการใช้งานและยอดคงเหลือ
ผู้ใช้ ผู้ใช้
จัดการสมาชิกทีม
เว็บฮุก webhooks
รับเหตุการณ์
ฐานความรู้ ฐานความรู้
ฐานข้อมูลความรู้และคำถามที่พบบ่อย
เอเจนต์ เอเจนต์
กำหนดค่า IDP Agents
เวิร์กโฟลว์ เวิร์กโฟลว์
สร้างระบบอัตโนมัติ
การปฏิบัติตามกฎระเบียบ การปฏิบัติตามกฎระเบียบ
การตรวจสอบ, GDPR, การเก็บรักษาข้อมูล

อัตราจำกัด

สิ่งที่ API นับ

การนับจะดำเนินการตามโทเค็น; โดยไม่ใช้ Bearer จะนับตามที่อยู่ IP ค่าต่อไปนี้คือค่าขั้นต่ำที่เอกสารระบุซึ่งจะใช้ได้ในทุกแพ็กเกจ

5: คำขอต่อวินาที
30: คำขอต่อนาที
100: คำขอต่อชั่วโมง
500: คำขอต่อวัน

ค่าคงเหลือปรากฏในหัวข้อความตอบกลับ
เฮดเดอร์ RateLimit-* และ X-RateLimit-* ในแต่ละความตอบกลับจะแสดงปริมาณที่ยังคงเหลืออยู่ในช่วงเวลาปัจจุบัน
การเกินขีดจำกัด: HTTP 429
รหัส API จะตอบกลับด้วยสถานะ RATE_LIMIT_EXCEEDED กรุณาลองเรียกใหม่หลังจากเวลาตามที่ระบุในเฮดเดอร์ Retry-After
แพ็กเกจระดับสูงจะเพิ่มขีดจำกัดเหล่านี้
อัตราค่าใช้บริการที่ชำระเงินจะสูงกว่าค่าขั้นต่ำเหล่านี้ รายละเอียดของแพ็กเกจแต่ละประเภทอยู่ที่หน้าราคา

ดูแพ็กเกจและขอบเขตการใช้งาน

ความปลอดภัย

สิ่งที่ปกป้อง Key ของคุณ

กลไกหกประการที่ทำงานระหว่างการใช้งาน — แต่ละตัวมีรหัสสถานะที่ตรวจสอบได้หรือตำแหน่งในแอปพลิเคชัน

การหมุนเวียนและการเพิกถอน
Key ถูกสร้าง แสดงรายการ หมุนเวียน และเพิกถอนในแอปภายใต้ Account → API Token ที่ถูกเพิกถอนจะตอบกลับด้วย HTTP 401 TOKEN_NOT_FOUND
วันหมดอายุและความถูกต้อง
Token ที่หมดอายุหรือผิดพลาดจะส่งกลับเป็น HTTP 401 INVALID_TOKEN Publishable Keys จะหมดอายุภายในเวลาไม่เกิน 365 วัน
ขีดจำกัดต่อ Token
อัตราจำกัดนับต่อโทเค็น ไม่ใช่ต่อบัญชี คีย์ที่ถูกละเมิดจึงไม่ส่งผลกระทบต่อการทำงานทั้งหมด
การผูกแหล่งที่มาในเบราว์เซอร์
Publishable Keys ต้องการส่วนหัว Origin จากบัญชีอนุญาตในการเรียกแต่ละครั้ง มิฉะนั้น API จะตอบกลับด้วย 403 ORIGIN_HEADER_REQUIRED หรือ DOMAIN_NOT_ALLOWED
ติดตามการใช้งาน
คำตอบที่เรียกเก็บเงินทุกครั้งมีบล็อก _billing; การประเมินผลต่อคำขอทำได้ผ่าน GET /latest/billing/usage-detail
การบล็อกแบบเข้มงวด
การเข้าสู่ระบบบัญชี, การจัดการคีย์, OAuth, ผู้ดูแลระบบพาร์ทเนอร์, การเปลี่ยนแปลงการชำระเงิน และการแฮชรหัสผ่านถูกบล็อกสำหรับคีย์เบราว์เซอร์ ผลิตภัณฑ์ APIs รวมถึงการอ่านบิลลิ่งและเว็บฮุ๊กได้รับอนุญาต Workspace ลบ, ล้างถังขยะ และปลดปล่อย Legal-Hold ทำได้เฉพาะในแอปพลิเคชัน (403 UI_ONLY_ENDPOINT)

วิดีโอ

การใช้งานการตรวจสอบสิทธิ์

ชมวิดีโอเพื่อเห็นภาพจริงของการเรียกใช้ข้อมูลด้วยโทเค็น Bearer

เพิ่มเติม

สิ่งที่อยู่ข้างเคียง

หน้าเว็บที่ครอบคลุมการดำเนินงานรอบระบบตรวจสอบสิทธิ์

Publishable Keys โทรโดยตรงจากเบราว์เซอร์ด้วย po_pk_. เว็บฮุก รับเหตุการณ์แทนการ polling. Postman Collection จุดสิ้นสุดทั้งหมดสำหรับการคลิกผ่าน. API-แคตตาล็อก จุดสิ้นสุดแต่ละจุดทำงานอะไร. llms-full.txt เอกสารทั้งหมดสำหรับ IDE ของคุณ อัตราค่าบริการ อัตราค่าบริการแต่ละประเภทครอบคลุมอะไรบ้าง

เริ่มต้นเลย

สร้างคีย์ ตั้งค่าส่วนหัว และส่งข้อมูล

คุณสามารถสร้างคีย์ในแอปได้ที่บัญชี → API การเรียกใช้ครั้งแรกมีขั้นตอนละเอียดอยู่ในบทช่วยสอน 'การเรียกใช้ API ครั้งแรก'

สร้างคีย์ API เริ่มการเรียก API ครั้งแรก

การดำเนินงานและความน่าเชื่อถือ

สิ่งที่ทีมองค์กรตรวจสอบก่อนการโทรครั้งแรก

สัญญา ความปลอดภัย การสนับสนุน และขีดจำกัด ทั้งหมดเชื่อมโยงในที่เดียว

สถานีถัดไป

ขั้นตอนต่อไป

ขั้นตอนถัดไปแนะนำในฟันเนลนักพัฒนา และสองเส้นทางแยกที่สอดคล้องกัน

Webhooks & Eventsเหตุการณ์เรียลไทม์, HMAC API Call แรกรับคีย์ ส่ง Request ตรวจสอบการตอบกลับ Postman Collectionนำเข้า ทดสอบ และแก้ไขข้อบกพร่องใน Postman

กลับสู่หน้าเริ่มต้นสำหรับนักพัฒนา

เข้าใจ PaperOffice AI ใน 14 นาที

ท่านต้องการใช้ PaperOffice อย่างไร