CHƯƠNG 4: DANH MỤC API (API REFERENCE)
Tất cả các API dưới đây đều được Proxy chuyển tiếp (Forward) tới các Service Backend tương ứng. Proxy thực hiện việc ánh xạ Header và xử lý lỗi mạng tự động.
Trang 1: Nhóm API Ký số (Signing Proxy)
| Endpoint |
Method |
Mô tả |
/api/sign/scan-keywords |
POST |
Quét tọa độ từ khóa (keywords) trong file PDF để xác định vị trí ký. |
/api/sign/request-otp |
POST |
Gửi yêu cầu lấy mã OTP phục vụ ký số. |
/api/sign/verify-otp |
POST |
Xác thực mã OTP trước khi thực hiện ký. |
/api/sign/document |
POST |
Ký một tài liệu PDF đơn lẻ (truyền file Multipart). |
/api/sign/document-json |
POST |
Ký tài liệu PDF thông qua dữ liệu JSON (Base64). |
/api/sign/document-with-image |
POST |
Ký tài liệu có chèn hình ảnh chữ ký tươi (Insert Image). |
/api/sign/document-initial-signature |
POST |
Ký nháy tài liệu (Initial Signature) dựa trên tọa độ hoặc từ khóa. |
/api/sign/document-formal-initial-signature |
POST |
Ký nháy chính thức (Formal Initial Signature). |
/api/sign/revoke-p12/{username} |
DELETE |
Thu hồi chứng thư số P12 của người dùng. |
Trang 2: Nhóm API Quy trình (BPMN Proxy)
| Endpoint |
Method |
Mô tả |
/api/proxy/start |
POST |
Khởi tạo một phiên quy trình nghiệp vụ (Process Start). |
/api/proxy/tasks/{pid} |
GET |
Lấy danh sách nhiệm vụ (Tasks) của một Process Instance ID. |
/api/proxy/tasks/{tid}/complete |
POST |
Đánh dấu hoàn thành một nhiệm vụ cụ thể. |
/api/proxy/bpmn/find-and-update |
PUT |
Tìm kiếm và cập nhật thông tin quy trình BPMN. |
/api/proxy/bpmn/find-and-submit-form |
POST |
Tìm và gửi dữ liệu Form trong quy trình. |
/api/proxy/integration-signature/callback |
POST |
Gửi phản hồi (callback) sau khi ký số hoàn tất. |