Quickstart theo tuyến tích hợp
Chọn Gateway, RSS hoặc SIC; liên kết thao tác với operation, mã theo dõi và cách đối soát. Ví dụ tham chiếu nằm riêng bên dưới.
Tích hợp GoPaperless Gateway
| Bước | Thao tác | Trách nhiệm và kết quả | Tài liệu |
|---|---|---|---|
| 1 | Tải tài liệu lên | Lưu file token và kiểm tra trạng thái upload; chốt encoding trước gọi thật. | Chi tiết |
| 2 | Tạo giao dịch từ mẫu | Chốt người ký, quyền đại diện, file token và process_type đúng đơn vị. | Chi tiết |
| 3 | Chuẩn bị dữ liệu ký | Chứng thư và signer_id liên kết đúng phiên bản; đọc dtbs/dtbs_hash. | Chi tiết |
| 4 | Cấp quyền và ký | Chọn RSS hoặc SIC; đồng ý ký khác đăng nhập và chia sẻ dữ liệu. | Phạm vi và điều kiện |
| 5 | Hoàn thiện tài liệu | Nhận signature_value rồi hoàn thiện tài liệu theo contract; không coi chữ ký rời là file cuối. | Chi tiết |
| 6 | Trạng thái và kiểm chứng | Đọc file cuối, đối soát trạng thái và kiểm chứng riêng. | Chi tiết |
Đây là hướng dẫn đọc contract, chưa phải chương trình gọi API thật. Khi mất phản hồi, giữ yêu cầu và mã liên kết rồi đối soát trước khi tạo lại.
Xem thao tác Viewer tương ứngTích hợp RSS / RS-HUB
| Bước | Thao tác | Trách nhiệm và kết quả | Tài liệu |
|---|---|---|---|
| 1 | Xác thực hệ thống | Lấy token dịch vụ từ SSO theo §2.1 ở backend; không đưa bí mật vào Viewer. | Phạm vi và điều kiện |
| 2 | Thông tin chứng thư và khóa | Chọn provider/gói và lưu x-rp-id, x-billcode-id khi được trả về. | Chi tiết |
| 3 | Tra cứu chứng thư | Liên kết credential_id với chứng thư đúng chủ thể; trạng thái credential khác kiểm chứng chữ ký. | Chi tiết |
| 4 | Ký giá trị băm | Chuẩn bị digest từ đúng tài liệu; lưu mã dịch vụ, chờ người dùng và kết quả. | Chi tiết |
| 5 | Đối soát | Tra cứu theo mã đã lưu khi callback thiếu hoặc kết quả chưa rõ. | Chi tiết |
| 6 | Tài liệu và kiểm chứng | Hoàn thiện tài liệu và kiểm chứng theo kiến trúc đã xác nhận; citizen ID check không thay bước này. | Phạm vi và điều kiện |
Đây là hướng dẫn đọc contract, chưa phải chương trình gọi API thật. Khi mất phản hồi, giữ yêu cầu và mã liên kết rồi đối soát trước khi tạo lại.
Xem thao tác Viewer tương ứngTích hợp Trusted SIC
| Bước | Thao tác | Trách nhiệm và kết quả | Tài liệu |
|---|---|---|---|
| 1 | Thông tin chứng thư và khóa | Phát hành hoặc chọn credential đủ điều kiện; chưa suy mode S/A khi nguồn mâu thuẫn. | Chi tiết |
| 2 | Giá trị băm của tài liệu | Liên kết documentDigests.hashes và hashAlgorithmOID với đúng tài liệu. | Chi tiết |
| 3 | Yêu cầu cấp quyền | 202 tiếp nhận chưa phải cấp quyền hoàn tất. Mở UI theo token/URL được xác nhận. | Chi tiết |
| 4 | SAD | Nhận dữ liệu cấp quyền theo contract; token ứng dụng và token mở UI không thay SAD. | Phạm vi và điều kiện |
| 5 | Ký giá trị băm | Truyền credentialID, SAD, hashes và signAlgo theo nguồn; chưa xuất payload đầy đủ khi thông số chưa chốt. | Chi tiết |
| 6 | Kết quả và tài liệu | Nhận chữ ký, hoàn thiện tài liệu và kiểm chứng; Compact thiếu polling không chứng minh polling bị loại bỏ. | Phạm vi và điều kiện |
Đây là hướng dẫn đọc contract, chưa phải chương trình gọi API thật. Khi mất phản hồi, giữ yêu cầu và mã liên kết rồi đối soát trước khi tạo lại.
Xem thao tác Viewer tương ứngTừ hồ sơ đến kết quả
Mô hình tham chiếu; chưa phải hợp đồng API vận hành thực tế. Ví dụ chỉ dùng dữ liệu giả lập.
- 1. Chuẩn bị hồ sơ
Chốt phiên bản tài liệu và người có quyền ký tại hệ thống nguồn.
- 2. Tạo giao dịch
Dùng document_ref, signer_ref, purpose và route của ví dụ tham chiếu.
- 3. Lưu và theo dõi
Lưu transaction_id khi nhận 202; chưa đánh dấu hoàn tất.
- 4. Cấp quyền người dùng
Người dùng xem tài liệu và quyết định theo tuyến triển khai được duyệt.
- 5. Nhận kết quả
Theo dõi trạng thái hoặc sự kiện đã xác thực; chống xử lý trùng.
- 6. Kiểm chứng và bàn giao
Kiểm chứng trong hệ thống thật; lưu kết quả và bằng chứng tại hệ thống nguồn.
Một bộ dữ liệu xuyên suốt
POST /v1/signing-transactions
{
"document_ref": "doc_demo_001",
"signer_ref": "subject_demo_001",
"purpose": "contract-approval",
"route": "AUTO"
}202 Accepted
{
"transaction_id": "sig_txn_demo_001",
"state": "WAITING_USER_ACTION",
"model_status": "SIMULATED_ONLY"
}Nếu mất phản hồi sau khi tạo, giữ hồ sơ nguồn và chuyển sang đối soát. Không tự tạo lại ý định ký.
Thực hành mô phỏngThực hành đối soát an toàn tại máy
| Giai đoạn | Cách xử lý |
|---|---|
| Trước khi gửi | Lưu mã hồ sơ phía ứng dụng và phiên bản tài liệu. Không dùng mã tự đặt thay mã dịch vụ. |
| Tiếp nhận hoặc mất phản hồi | Giữ nguyên yêu cầu đã gửi. 202 không chứng minh đã ký; mất phản hồi không chứng minh yêu cầu chưa xử lý. |
| Nhận callback/tra cứu | Liên kết mã dịch vụ, kiểm tra nguồn theo đặc tả và lưu bền vững. Đối soát callback trùng hoặc sai thứ tự. |
| Hoàn thiện và kiểm chứng | Nhận chữ ký chưa phải tài liệu cuối. Finalize/assembling và validation có kết quả riêng. |
Ví dụ Python dưới đây chạy bằng thư viện chuẩn, dùng mô hình sổ theo dõi tổng hợp. Không gửi request mạng, không ký mật mã và không mô phỏng response của một API dịch vụ.
Tải ví dụ Python chạy offlinepython3 reconciliation_demo.py