API và webhook
Việc tải lên và đọc tài liệu có sẵn thông qua REST API. Quản lý tài khoản, hồ sơ, nhãn và kết nối vẫn nằm trong ứng dụng.
Khóa
Khóa được tạo trong Cài đặt → Dành cho nhà phát triển. Khóa sẽ được hiển thị một lần, khi tạo — sau đó không còn nữa, vì chỉ lưu dấu vân tay của nó. Khóa bị mất sẽ không thể phục hồi, phải tạo mới và xóa khóa cũ. Có thể có tối đa năm khóa, mỗi khóa có thời gian hiệu lực tùy chọn lên đến hai năm.
Khóa được gửi trong tiêu đề X-API-Key.
API có thể làm gì
| Hoạt động | Mô tả |
|---|---|
POST /api/upload | Tải lên tệp với các tùy chọn: định dạng, hướng, loại, tiền tệ, sơ đồ, hồ sơ, webhook |
POST /api/upload/url | Tương tự từ địa chỉ công khai; chúng tôi tự tải xuống tệp |
GET /api/jobs | Danh sách tài liệu với bộ lọc và phân trang |
GET /api/jobs/{id} | Trạng thái, dữ liệu đã đọc, tìm kiếm và kết quả ở định dạng đích |
GET /api/jobs/{id}/original | Tệp đã tải lên |
DELETE /api/jobs/{id} | Xóa vào thùng rác |
Excel và PDF được gửi dưới dạng Base64 trong kết quả. Ai không cần kết quả, hãy gửi
includeResult=false, tiết kiệm chuyển đổi trên máy chủ.
Mô tả giao diện ở định dạng OpenAPI có tại địa chỉ /api/docs; liên kết có trong cài đặt
tại khóa. Mô tả được tạo ra từ mã đang chạy, vì vậy nó phù hợp với những gì API thực hiện.
Kiểm tra tài liệu từ API
Kiểm tra trước khi gửi áp dụng theo mặc định cho cả tài liệu được tải lên bằng khóa: tài liệu chờ xác nhận trong ứng dụng và webhook sẽ được gửi đi sau đó. Ai đang xây dựng tích hợp mà không ai ngồi trước màn hình, có thể xóa kênh API trong Cài đặt → Kiểm tra trước khi gửi, hoặc tắt kiểm tra.
MCP
Đối với các tác nhân AI, có địa chỉ /api/mcp máy chủ MCP với cùng một khóa. Có thể đọc và tìm kiếm tài liệu, không thể tải lên; việc tải lên sẽ trả về như một lệnh hoàn chỉnh, mà tác nhân sẽ tự thực thi.
Webhook
Thay vì truy vấn trạng thái, hãy nhận kết quả khi nó đã hoàn thành. Địa chỉ được
cài đặt cho toàn bộ tài khoản trong Cài đặt → Dành cho nhà phát triển, hoặc với từng tải lên
bằng tham số targetWebhookUrl. Nút trong cài đặt sẽ gửi tin nhắn thử nghiệm.
Một POST với JSON sẽ được gửi: định danh tài liệu, tên tệp, định dạng và kết quả
ở định dạng đích. Khi tài liệu vượt qua kiểm tra hoặc được xử lý lại, webhook sẽ được gửi hai lần với dấu hiệu sửa chữa (IsCorrection).
Tin nhắn không được ký. Xác thực người gửi của bạn bằng cách thêm mã thông báo bí mật riêng vào địa chỉ. Các địa chỉ vào mạng riêng bị từ chối.
Việc giao hàng không thành công sẽ được lặp lại với thời gian trễ tăng dần, với mười một lần thử trong khoảng bốn tiếng rưỡi. Mỗi lần thử sẽ có trong hoạt động cùng với phản hồi từ phía bạn; với tài liệu trong danh sách sẽ có biểu tượng với kết quả giao hàng.
Giới hạn
API không có giới hạn riêng về số lượng cuộc gọi mỗi phút; việc tải lên bị hạn chế bởi tín dụng, kích thước tệp theo gói và hai mươi trang cho mỗi tài liệu. Từ chối sẽ được gửi dưới dạng lỗi 400 với mã, cho biết lý do. Máy chủ MCP bị giới hạn ở mười truy vấn mỗi giây.