Nhảy đến nội dung chính

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

Đây là các endpoint chủ lực trên máy 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 Header Token-Signing (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 từ hệ thống. Dùng cho luồng bảo mật bước 2.
  • POST /api/sign/verify-otp: Xác thực OTP để hệ thống cấp/kiểm tra phiên ký hợp lệ.

2. Nhóm API Ký số & Xử lý Tài liệu

  • POST /api/sign/document:
    • API chính để ký dữ liệu tập trung (Dùng chứng thư máy chủ EJBCA).
    • Input: Hỗ trợ Upload File (@ModelAttribute WebSignRequestDTO), tự động nhận diện định dạng (DOCX, XLSX, PDF) để convert qua PDF.
  • POST /api/sign/document-with-image & POST /api/sign/documents-with-image:
    • Hỗ trợ ký số và chèn ảnh (Visual Signature). Yêu cầu truyền mảng imageMetadata chứa thông tin 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 chữ ký ở các tọa độ linh hoạt.

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

  • GET /api/admin/audit-logs/range (Controller: AuditLogAdminController): Lấy danh sách vết giao dịch ký.
  • GET /api/diagnostic/test-connection (Controller: EmailDiagnosticController): Gửi cảnh báo SMS/Email kiểm tra tình trạng kết