3.2. Danh sách Web API Chính (Server-Side)

Đây là các endpoint chủ lực trên máy chủ,chủ (nằm trong SigningController), sử dụng JSON làm phương tiện trao đổi (application/json hoặc multipart/form-data). Hệ thống yêu cầu TokenHeader AuthenticationToken-Signing (JWT/OAuth2)phiên ký hợp lệ) cho hầu hết các API nghiệp vụ.

 

1. Nhóm API Xác thực OTP & Cấp quyền

• POST /api/sign/request-otp: Yêu cầu tạo mã OTP quatừ hệ thống. Dùng cho luồng bảo mật bước 2 trước khi áp con dấu cá nhân vào văn bản quan trọng.2.
• POST /api/auth/loginsign/verify-otp: ĐăngXác nhậpthực lấyOTP Bearerđể Tokenhệ phụcthống vụcấp/kiểm việctra gọi các API quản lý vàphiên ký sốhợp tiếp theo.lệ.

2. Nhóm API Ký số Cơ& bảnXử lý Tài liệu

• POST /api/signsign/document (Controller: SigningController):
  • API chính để ký dữ liệu tập trung (Dùng chứng thư máy chủ hoặc khai báo định danh)EJBCA).
  • Input: Hỗ trợ Upload File qua(@ModelAttribute @RequestParamWebSignRequestDTO), tự động nhận diện định dạng (đãDOCX, đượcXLSX, fix bỏ @RequestPartPDF) để tránhconvert lỗiqua boundary parser). Cung cấp mảng Metadata để chỉ định vị trí chèn ảnh Visual Signature lên bề mặt file.
  • Xử lý: Tư động cấu hình EJBCA -> Convert Word/Excel sang PDF (nếu cần) -> Hash -> Gọi EJBCA -> Apply PDFBox Visuals.PDF.
• POST /api/sign/visual-onlydocument-with-image (Dự& án:POST /sign-visual-onlyapi/sign/documents-with-image):
  • API hỗHỗ trợ đóngký hìnhsố và chèn ảnh lên(Visual tàiSignature). liệuYêu nhanhcầu (Chỉtruyền xửmảng lýimageMetadata Convertchứa &thông thêmtin tọa độ.
• POST /api/sign/document-initial-signature:
  • Chuyên dùng cho nghiệp vụ Ký nháy, chèn hình ảnh/con dấu).
  dấu
  • LƯUchữ Ý:ký Khôngở dùngcác mãtọa hóađộ Cryptographylinh chứng thư PKCS#7 qua đường này (nhanh và ứng dụng cho thư mời, thông báo phê duyệt nháy).hoạt.

3. Nhóm API Quản trị & Audit Log

• GET /api/admin/audit-logslogs/range (Controller: AuditLogAdminController): Lấy danh sách vết giao dịch ký của toàn bộ hệ thống dưới dạng phân trang (Pagination).ký.
• POSTGET /api/admin/sys-diagnosticdiagnostic/test-connection (Controller: EmailDiagnosticController): Gửi cảnh báo SMS/Email kiểm tra tình trạng kết nối.