Xác thực và Khóa

Một Bearer-token. Mỗi điểm cuối.

Mỗi điểm cuối sản phẩm của PaperOffice-API yêu cầu tiêu đề Authorization: Bearer. Không có luồng OAuth, không có làm mới.

Hai loại token, mười phạm vi quyền, giới hạn tốc độ được tài liệu hóa.

Tạo khóa API Bắt đầu lệnh gọi API đầu tiên

Một tiêu đề Không có luồng OAuth Có thể thu hồi bất cứ lúc nào

app.paperoffice.ai/account/api

Yêu cầu 200 OK Token hợp lệ

Tiêu đề Authorization

Authorization: Bearer po_ut_YOUR_API_KEY

Quyền hạn

ocr:read
documents:write
jobs:read

Phản hồi

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

Cơ sở hạ tầng EU riêng Dữ liệu của bạn vẫn ở châu Âu.
ISO 27001 đang hoạt động Bảo mật đã được chứng nhận.
SOC 2 Type II đang hoạt động Tiêu chuẩn kiểm toán quốc tế.
Hơn 24 năm kinh nghiệm Đã được chứng minh. Ổn định. An toàn cho tương lai.

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

Lời gọi đầu tiên

Đặt tiêu đề, chọn pipeline, gửi đi

Đường dẫn đến /latest/job/add/ là tên công việc hàng đợi: thường theo dạng handler___command (ví dụ paperoffice_aiocr___generate), đối với IDP có cấu trúc là workflow pipeline của riêng bạn.

Một tiêu đề
Authorization: Bearer po_ut_… — một điểm cuối sản phẩm không cần thêm gì khác. po_sk_ và po_ut_ không gửi tiêu đề Origin.
Pipeline trong đường dẫn
handler___command với ba dấu gạch dưới; workflow là ngoại lệ với slug riêng. Cách viết chấm sẽ trả về API với HTTP 400 JOB_CONFIG_INVALID.
Kết quả hoặc job_id
client_wait mặc định là true: API giữ kết nối và trả về kết quả trực tiếp. Nếu khung thời gian không đủ, sẽ nhận được HTTP 202 với job_id và poll_url để GET /latest/job/get/{job_id}.

Xem danh mục API llms-full.txt cho IDE của bạn

Đối với idp_collection=invoice, model basic-pro-max là mô hình được khuyến nghị: OCR-first giới hạn các bộ sưu tập in có vị trí tối đa ở basic-pro-max; việc gửi model=premium sẽ trả về model: basic-pro-max.

Loại token

Hai loại token, phân biệt rõ ràng

Cả hai đều cần được gửi lên máy chủ. Chúng được tạo, xoay vòng và thu hồi trong ứng dụng dưới Tài khoản → API.

po_sk_ Máy đến Máy

Khóa bí mật

Quyền truy cập đầy đủ trong phạm vi tài khoản
Không bao giờ cung cấp trong mã trình duyệt
Không cần tiêu đề Origin
Bị khóa đối với MCP

Quản lý Khóa Bí mật

po_ut_ Theo người dùng

User Token

Có thể giới hạn ở các khu vực cụ thể
Không bao giờ cung cấp trong mã trình duyệt
Không cần Origin-Header
Được phép sử dụng MCP

Tạo User Token

Các yêu cầu trực tiếp từ trình duyệt không đi qua hai token này, mà thông qua Publishable Key po_pk_ — gắn liền với nguồn gốc, có giới hạn ngân sách và tỷ lệ. Xem Publishable Keys

Quyền

Mười lĩnh vực cho mỗi User Token

Một User Token chỉ chứa đúng các lĩnh vực mà bạn cung cấp khi tạo. Nếu thiếu lĩnh vực, API sẽ trả về HTTP 403.

Tài liệu tài liệu
Tải lên, Tải xuống, Xử lý
Workspaces khu_làm_việc
Quản lý thư mục và cấu trúc
Công việc AI ai_jobs
OCR, IDP, Trích xuất
Thanh toán billing
Đọc mức sử dụng và số dư tài khoản
Người dùng người dùng
Quản lý thành viên nhóm
Webhook webhooks
Nhận sự kiện
Cơ sở kiến thức knowledge_base
Cơ sở dữ liệu kiến thức và FAQ
Các tác nhân tác nhân
Konfigurieren Sie IDP Agents
Quy trình làm việc công_việc
Erstellen Sie Automatisierungen
Tuân thủ tuân thủ
Kiểm toán, GDPR, Lưu trữ

Giới hạn tốc độ

Những gì API tính đến

Tính phí theo từng token; không có Bearer thì tính theo địa chỉ IP. Các giá trị sau đây là các mức tối thiểu được tài liệu hóa, áp dụng cho mọi gói dịch vụ.

5: Yêu cầu mỗi giây
30: Yêu cầu mỗi phút
100: Yêu cầu mỗi giờ
500: Yêu cầu mỗi ngày

Giá trị còn lại nằm trong phần đầu của phản hồi
Các tiêu đề RateLimit-* và X-RateLimit-* trong mỗi phản hồi cho biết còn bao nhiêu giới hạn trong khoảng thời gian hiện tại.
Vượt quá: HTTP 429
API trả về lỗi RATE_LIMIT_EXCEEDED. Vui lòng thử lại sau khoảng thời gian được chỉ định trong tiêu đề Retry-After.
Các gói dịch vụ cao hơn sẽ tăng các mức giới hạn này
Các gói trả phí nằm trên các giá trị tối thiểu này. Gói nào có phạm vi như thế nào được nêu trên trang giá.

Xem gói và phạm vi

Bảo mật

Điều gì bảo vệ một Key

Sáu cơ chế hoạt động trong vận hành — mỗi cơ chế đều có mã trạng thái có thể kiểm tra hoặc vị trí trong ứng dụng.

Xoay vòng và thu hồi
Keys được tạo, liệt kê, xoay vòng và thu hồi trong ứng dụng dưới Tài khoản → API. Một token bị thu hồi sẽ trả về HTTP 401 TOKEN_NOT_FOUND.
Hết hạn và tính hợp lệ
Các token hết hạn hoặc lỗi sẽ trả về HTTP 401 INVALID_TOKEN. Publishable Keys sẽ hết hạn muộn nhất sau 365 ngày.
Giới hạn theo token
Các giới hạn tốc độ được tính theo mỗi Token, không phải theo mỗi tài khoản. Một khóa bị xâm phạm do đó không ảnh hưởng đến toàn bộ hoạt động.
Liên kết nguồn gốc trong trình duyệt
Khóa công khai yêu cầu một Origin từ danh sách cho phép trong mọi yêu cầu; nếu không API sẽ trả về 403 ORIGIN_HEADER_REQUIRED hoặc DOMAIN_NOT_ALLOWED.
Theo dõi việc sử dụng
Mỗi phản hồi đã tính phí đều chứa một khối _billing; việc đánh giá theo từng lệnh gọi cung cấp GET /latest/billing/usage-detail.
Khóa cứng
Đăng nhập tài khoản, quản lý khóa, OAuth, quản trị viên đối tác, thay đổi thanh toán và bẻ khóa mật khẩu bị chặn đối với khóa trình duyệt. Sản phẩm APIs bao gồm đọc hóa đơn và webhook được cho phép. Xóa Workspace, làm trống thùng rác và cấp phép giữ pháp lý chỉ có thể thực hiện trong ứng dụng (403 UI_ONLY_ENDPOINT).

Video

Xác thực trong thực tế

Xem cách một cuộc gọi với Bearer-token hoạt động trong thực tế — qua video.

Mở rộng

Những gì nằm bên cạnh

Các trang bao phủ hoạt động xung quanh xác thực.

Publishable Keys Gọi trực tiếp từ trình duyệt với po_pk_. Webhooks Nhận sự kiện thay vì polling. Postman-Bộ sưu tập Tất cả các điểm cuối để duyệt qua. API-Catalog Điểm cuối nào thực hiện công việc gì. llms-full.txt Toàn bộ tài liệu cho IDE của bạn. Tariff Umfang của gói dịch vụ nào.

Bắt đầu

Tạo Key, đặt Header, gửi

Bạn tạo Key trong ứng dụng tại Tài khoản → API. Cuộc gọi API đầu tiên được hướng dẫn từng bước.

Tạo khóa API Bắt đầu lệnh gọi API đầu tiên

Vận hành và niềm tin

Những gì các nhóm doanh nghiệp kiểm tra trước cuộc gọi đầu tiên

Hợp đồng, bảo mật, hỗ trợ và giới hạn, tất cả đều được liên kết tại một nơi.

Trạm tiếp theo

Cách thức thực hiện tiếp theo

Bước tiếp theo được khuyến nghị trong phễu nhà phát triển và hai nhánh rẽ phù hợp.

Webhooks & EventsSự kiện thời gian thực, HMAC Lệnh gọi API đầu tiênLấy khóa, gửi yêu cầu, kiểm tra phản hồi Postman CollectionNhập, kiểm tra, gỡ lỗi trong Postman

Quay lại trang bắt đầu dành cho nhà phát triển

Hiểu PaperOffice AI trong 14 phút.

Quý vị muốn dùng PaperOffice như thế nào?