API của admin-be¶
🟢 51 hoàn thành · 🟡 2 đang làm · ⚪ 22 chưa làm — 49 endpoint · 26 dòng cấp story. Nguồn: openapi.yaml @ origin/main bf6e00e (cổng hợp đồng ở repo bảo đảm mỗi đường khai là route thật có test).
Nền cơ sở dữ liệu — E-001/nhom-1¶
🟢 2 hoàn thành · 🟡 0 đang làm · ⚪ 0 chưa làm · tài liệu kỹ thuật của nhóm
| Đèn | Method | Đường | operationId | Story | Ghi chú |
|---|---|---|---|---|---|
| 🟢 hoàn thành | GET |
/api/v1/schema/migrations |
lietKeMigration |
E-001/1.1 Dòng di trú và schema chung |
Vận hành dòng di trú |
| 🟢 hoàn thành | POST |
/api/v1/schema/migrations/run |
chayMigration |
E-001/1.1 Dòng di trú và schema chung |
Vận hành dòng di trú |
Danh tính và phân quyền — E-001/nhom-2¶
🟢 25 hoàn thành · 🟡 0 đang làm · ⚪ 0 chưa làm · tài liệu kỹ thuật của nhóm
| Đèn | Method | Đường | operationId | Story | Ghi chú |
|---|---|---|---|---|---|
| 🟢 hoàn thành | POST |
/api/v1/sessions |
moPhien |
E-001/2.3 Phiên có trạng thái |
Đăng nhập — cookie HttpOnly |
| 🟢 hoàn thành | GET |
/api/v1/sessions/current |
docPhienHienTai |
E-001/2.3 Phiên có trạng thái |
Chủ thể của phiên hiện tại |
| 🟢 hoàn thành | DELETE |
/api/v1/sessions/current |
dongPhienHienTai |
E-001/2.3 Phiên có trạng thái |
Đăng xuất |
| 🟢 hoàn thành | PUT |
/api/v1/sessions/current/password |
doiMatKhauHienTai |
E-001/2.6 API quản trị người dùng nội bộ |
Chủ phiên tự đổi mật khẩu |
| 🟢 hoàn thành | GET |
/api/v1/password-policies/current |
docChinhSachMatKhau |
E-001/2.6 API quản trị người dùng nội bộ |
Chính sách độ dài mật khẩu đang có hiệu lực |
| 🟢 hoàn thành | GET |
/api/v1/internal-users |
lietKeNguoiDungNoiBo |
E-001/2.6 API quản trị người dùng nội bộ |
Liệt kê người dùng nội bộ (phân trang, tìm, lọc trạng thái) |
| 🟢 hoàn thành | POST |
/api/v1/internal-users |
taoNguoiDungNoiBo |
E-001/2.7 Tài khoản nội bộ theo mô hình super admin — bỏ đường đề xuất của 2.6 |
Super admin tạo, hiệu lực ngay (PO đảo 12/09) |
| 🟢 hoàn thành | PUT |
/api/v1/internal-users/{id}/status |
doiTrangThaiNguoiDungNoiBo |
E-001/2.7 Tài khoản nội bộ theo mô hình super admin — bỏ đường đề xuất của 2.6 |
Vô hiệu / mở lại |
| 🟢 hoàn thành | GET |
/api/v1/internal-users/{id} |
chiTietNguoiDungNoiBo |
E-001/2.7 Tài khoản nội bộ theo mô hình super admin — bỏ đường đề xuất của 2.6 |
Chi tiết kèm vai ba trạng thái + quyền hiệu lực — lượt 2 (internal-user-profile-roles-api), chỉ super admin |
| 🟢 hoàn thành | PUT |
/api/v1/internal-users/{id} |
suaNguoiDungNoiBo |
E-001/2.7 Tài khoản nội bộ theo mô hình super admin — bỏ đường đề xuất của 2.6 |
Sửa họ tên · đơn vị · tập vai hiệu lực — lượt 2, ⛔ không đổi email |
| 🟢 hoàn thành | GET |
/api/v1/permission-objects |
lietKeDoiTuongQuyen |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Danh mục đối tượng (hàng của ma trận vai) |
| 🟢 hoàn thành | GET |
/api/v1/permission-actions |
lietKeHanhDongQuyen |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Danh mục hành động kèm lớp |
| 🟢 hoàn thành | GET |
/api/v1/permissions |
lietKeQuyen |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Liệt kê quyền (phân trang, tìm, lọc) kèm số đếm theo đối tượng |
| 🟢 hoàn thành | POST |
/api/v1/permissions |
taoQuyen |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Tạo quyền — mã sinh từ cặp đối tượng và hành động |
| 🟢 hoàn thành | GET |
/api/v1/permissions/{id} |
chiTietQuyen |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Chi tiết một quyền |
| 🟢 hoàn thành | PUT |
/api/v1/permissions/{id} |
suaQuyen |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Sửa tên, mô tả, hai trường hệ quả — ⛔ mã bất biến |
| 🟢 hoàn thành | PUT |
/api/v1/permissions/{id}/status |
doiTrangThaiQuyen |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Ngưng hoạt động hoặc mở lại — là mốc, không xoá |
| 🟢 hoàn thành | GET |
/api/v1/roles |
lietKeVai |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Liệt kê vai kèm số quyền và số người dùng |
| 🟢 hoàn thành | POST |
/api/v1/roles |
taoVai |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Tạo vai với tập quyền |
| 🟢 hoàn thành | GET |
/api/v1/roles/{id} |
chiTietVai |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Chi tiết vai kèm mã các quyền đang hiệu lực |
| 🟢 hoàn thành | PUT |
/api/v1/roles/{id} |
suaVai |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Lưu vai — tên, mô tả và TẬP quyền mong muốn; ⛔ mã bất biến |
| 🟢 hoàn thành | PUT |
/api/v1/roles/{id}/status |
doiTrangThaiVai |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Ngưng hoạt động hoặc mở lại vai — là mốc, không xoá |
| 🟢 hoàn thành | GET |
/api/v1/internal-users/{id}/roles |
vaiCuaNguoiDung |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Mọi vai với trạng thái cấp của một tài khoản |
| 🟢 hoàn thành | PUT |
/api/v1/internal-users/{id}/roles |
luuVaiNguoiDung |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Lưu TẬP vai hiệu lực mong muốn của một tài khoản |
| 🟢 hoàn thành | GET |
/api/v1/internal-users/{id}/role-events |
lichSuVaiNguoiDung |
E-001/2.4 Vai và quyền cấu hình được lúc chạy |
Lịch sử cấp / thu hồi vai của một tài khoản |
Phê duyệt hai người — E-001/nhom-3¶
🟢 0 hoàn thành · 🟡 0 đang làm · ⚪ 2 chưa làm · tài liệu kỹ thuật của nhóm
| Đèn | Method | Đường | operationId | Story | Ghi chú |
|---|---|---|---|---|---|
| ⚪ chưa làm | — |
— |
E-001/3.2 Cấu hình luồng phê duyệt |
hoạch định chưa gọi tên endpoint | |
| ⚪ chưa làm | — |
— |
E-001/3.3 Hàng đợi chờ duyệt |
hoạch định chưa gọi tên endpoint |
Nhật ký — E-001/nhom-4¶
🟢 0 hoàn thành · 🟡 0 đang làm · ⚪ 1 chưa làm · tài liệu kỹ thuật của nhóm
| Đèn | Method | Đường | operationId | Story | Ghi chú |
|---|---|---|---|---|---|
| ⚪ chưa làm | — |
— |
E-001/4.2 Tra cứu nhật ký |
hoạch định chưa gọi tên endpoint |
Danh mục API — E-002/nhom-1¶
🟢 0 hoàn thành · 🟡 0 đang làm · ⚪ 5 chưa làm · tài liệu kỹ thuật của nhóm
| Đèn | Method | Đường | operationId | Story | Ghi chú |
|---|---|---|---|---|---|
| ⚪ chưa làm | — |
— |
E-002/1.1 Schema và API Domain, Subdomain |
||
| ⚪ chưa làm | — |
— |
E-002/1.3 Schema và API danh mục API |
||
| ⚪ chưa làm | — |
— |
E-002/1.5 Nhập danh mục API hàng loạt |
||
| ⚪ chưa làm | — |
— |
E-002/1.6 Luồng phân loại nhóm TT64 |
||
| ⚪ chưa làm | — |
— |
E-002/1.8 Đặc tả API |
Đóng gói và định giá — E-003/nhom-1¶
🟢 0 hoàn thành · 🟡 0 đang làm · ⚪ 3 chưa làm · tài liệu kỹ thuật của nhóm
| Đèn | Method | Đường | operationId | Story | Ghi chú |
|---|---|---|---|---|---|
| ⚪ chưa làm | — |
— |
E-003/1.1 Schema và API Sản phẩm |
||
| ⚪ chưa làm | — |
— |
E-003/1.3 Schema và API Gói đăng ký |
||
| ⚪ chưa làm | — |
— |
E-003/1.5 Chặn thêm API nhóm hạn chế vào sản phẩm đã xuất bản |
ràng buộc trên API sản phẩm, có thể không thêm đường |
Phía ngân hàng — E-004/nhom-1¶
🟢 2 hoàn thành · 🟡 1 đang làm · ⚪ 1 chưa làm · tài liệu kỹ thuật của nhóm
| Đèn | Method | Đường | operationId | Story | Ghi chú |
|---|---|---|---|---|---|
| 🟢 hoàn thành | — |
— |
E-004/1.2 Thẩm định mã số thuế |
change đã đóng: 2026-09-13-tham-dinh-ma-so-thue |
|
| 🟡 đang làm | — |
— |
E-004/1.3 Vòng đời hồ sơ |
change bo-sung-hop-dong-to-chuc (nhánh bo-sung-hop-dong-to-chuc) |
|
| ⚪ chưa làm | — |
— |
E-004/1.5 Nhập dữ liệu tổ chức đang đấu nối |
||
| 🟢 hoàn thành | — |
— |
E-004/1.10 API xem người dùng bên thứ ba theo tổ chức |
change đã đóng: 2026-09-14-tpp-user-read-api |
Cổng bên thứ ba — E-004/nhom-2¶
🟢 0 hoàn thành · 🟡 1 đang làm · ⚪ 0 chưa làm · tài liệu kỹ thuật của nhóm
| Đèn | Method | Đường | operationId | Story | Ghi chú |
|---|---|---|---|---|---|
| 🟡 đang làm | — |
— |
E-004/2.5 Tiếp nhận đơn nộp |
change tiep-nhan-don-nop (nhánh tiep-nhan-don-nop) |
Yêu cầu đăng ký sản phẩm — E-005/nhom-2¶
🟢 0 hoàn thành · 🟡 0 đang làm · ⚪ 2 chưa làm · tài liệu kỹ thuật của nhóm
| Đèn | Method | Đường | operationId | Story | Ghi chú |
|---|---|---|---|---|---|
| ⚪ chưa làm | — |
— |
E-005/2.2 Chặn theo loại pháp nhân |
ràng buộc, có thể không thêm đường | |
| ⚪ chưa làm | — |
— |
E-005/2.3 Duyệt và kích hoạt |
Credential — E-005/nhom-3¶
🟢 0 hoàn thành · 🟡 0 đang làm · ⚪ 1 chưa làm · tài liệu kỹ thuật của nhóm
| Đèn | Method | Đường | operationId | Story | Ghi chú |
|---|---|---|---|---|---|
| ⚪ chưa làm | — |
— |
E-005/3.1 Cấp và lưu credential |
Thu hồi và đình chỉ — E-006/nhom-1¶
🟢 0 hoàn thành · 🟡 0 đang làm · ⚪ 4 chưa làm · tài liệu kỹ thuật của nhóm
| Đèn | Method | Đường | operationId | Story | Ghi chú |
|---|---|---|---|---|---|
| ⚪ chưa làm | — |
— |
E-006/1.2 Thu hồi và thu hẹp phạm vi |
||
| ⚪ chưa làm | — |
— |
E-006/1.3 Đình chỉ khẩn cấp |
||
| ⚪ chưa làm | — |
— |
E-006/1.4 Gỡ đình chỉ |
||
| ⚪ chưa làm | — |
— |
E-006/1.5 Chấm dứt hợp đồng |
Công bố và báo cáo — E-007/nhom-1¶
🟢 0 hoàn thành · 🟡 0 đang làm · ⚪ 3 chưa làm · tài liệu kỹ thuật của nhóm
| Đèn | Method | Đường | operationId | Story | Ghi chú |
|---|---|---|---|---|---|
| ⚪ chưa làm | — |
— |
E-007/1.1 Nội dung công bố có phiên bản |
||
| ⚪ chưa làm | — |
— |
E-007/1.2 Cổng chặn go-live |
||
| ⚪ chưa làm | — |
— |
E-007/1.5 Xuất báo cáo cho NHNN |
Chưa xếp vào sổ¶
Endpoint có thật nhưng sổ chưa kê
Có trong openapi.yaml của repo mà so-api.tsv chưa có dòng ⇒ chưa biết thuộc nhóm và story nào. Làn docs kê bổ sung vào sổ; endpoint không mất, chỉ đứng ngoài cây nhóm.
| Đèn | Method | Đường | operationId | Story | Ghi chú |
|---|---|---|---|---|---|
| 🟢 hoàn thành | POST |
/api/v1/organizations |
taoToChuc |
? | Tạo tổ chức bên thứ ba (E-004/1.3) — mã số thuế là khoá tự nhiên duy nhất |
| 🟢 hoàn thành | GET |
/api/v1/organizations |
lietKeToChuc |
? | Danh sách tổ chức — tìm theo tên/mã số thuế, lọc theo trạng thái hồ sơ và loại pháp nhân (FR-017) |
| 🟢 hoàn thành | GET |
/api/v1/organizations/{id} |
chiTietToChuc |
? | Chi tiết tổ chức — định danh, trạng thái hồ sơ suy ra, phiên bản hiệu lực, đề xuất đang chờ |
| 🟢 hoàn thành | POST |
/api/v1/organizations/{id}/profile-versions |
ghiPhienBanHoSo |
? | Ghi một phiên bản hồ sơ mới (nháp) — không ghi đè, không cổng Điều 8 |
| 🟢 hoàn thành | GET |
/api/v1/organizations/{id}/profile-versions |
phienBanHoSoCua |
? | Phiên bản hồ sơ của tổ chức, mới trước, kèm đính kèm — phân trang |
| 🟢 hoàn thành | GET |
/api/v1/organizations/{id}/profile-versions/{phienBan} |
phienBanHoSo |
? | Một phiên bản hồ sơ theo số |
| 🟢 hoàn thành | POST |
/api/v1/organizations/{id}/profile-versions/{phienBan}/attachments |
dinhKemHoSo |
? | Đính kèm một tài liệu vào phiên bản hồ sơ đang soạn — byte vào kho AD-30 |
| 🟢 hoàn thành | GET |
/api/v1/organizations/{id}/profile-versions/{phienBan}/attachments/{dinhKemId} |
taiDinhKemHoSo |
? | Tải một tài liệu đính kèm — so lại dấu vân, không render inline, mỗi lượt để vết |
| 🟢 hoàn thành | POST |
/api/v1/organizations/{id}/profile-review-requests |
guiDuyetHoSo |
? | Gửi một phiên bản hồ sơ đi duyệt (maker) — mở và gửi đề xuất trong một giao dịch; cổng tám khối Điều 8 |
| 🟢 hoàn thành | GET |
/api/v1/organizations/{id}/profile-review-requests |
deXuatHoSoCua |
? | Mọi đề xuất hồ sơ của tổ chức, mới trước — kể cả đã trả về/từ chối, kèm kết luận |
| 🟢 hoàn thành | GET |
/api/v1/organizations/{id}/profile-review-requests/{deXuatId} |
chiTietDeXuatHoSo |
? | Chi tiết một đề xuất hồ sơ — phiên bản ghim, dấu vân, quyết định của vòng đọc, kết luận |
| 🟢 hoàn thành | POST |
/api/v1/organizations/{id}/profile-review-requests/{deXuatId}/decisions |
quyetDinhHoSo |
? | Quyết định một đề xuất hồ sơ (checker) — duyệt · trả về chờ bổ sung · từ chối |
| 🟢 hoàn thành | POST |
/api/v1/organizations/{id}/tax-code-verification-requests |
moDeXuatThamDinhMst |
? | Mở đề xuất thẩm định mã số thuế kèm bằng chứng (maker) — mở và gửi duyệt trong một giao dịch |
| 🟢 hoàn thành | GET |
/api/v1/organizations/{id}/tax-code-verification-requests |
lietKeDeXuatThamDinhMst |
? | Mọi đề xuất thẩm định mã số thuế của tổ chức — kể cả đã từ chối kèm lý do (phân trang) |
| 🟢 hoàn thành | GET |
/api/v1/organizations/{id}/tax-code-verification-requests/{deXuatId} |
chiTietDeXuatThamDinhMst |
? | Chi tiết một đề xuất thẩm định — nội dung, bằng chứng, quyết định, trạng thái suy ra |
| 🟢 hoàn thành | POST |
/api/v1/organizations/{id}/tax-code-verification-requests/{deXuatId}/decisions |
quyetDinhThamDinhMst |
? | Người xác nhận duyệt hoặc từ chối một đề xuất thẩm định (checker) — đủ cấp thì áp ngay |
| 🟢 hoàn thành | GET |
/api/v1/organizations/{id}/tax-code-verification-requests/{deXuatId}/attachments/{bangChungId} |
taiBangChungThamDinhMst |
? | Tải một tệp bằng chứng — so lại dấu vân, không render inline, mỗi lượt một vết |
| 🟢 hoàn thành | GET |
/api/v1/organizations/{id}/tax-code-verification |
trangThaiThamDinhMst |
? | Trạng thái thẩm định mã số thuế hiện hành của tổ chức — suy ra, không cột |
| 🟢 hoàn thành | GET |
/api/v1/organizations/{id}/tax-code-verifications |
lichSuThamDinhMst |
? | Lịch sử các lần thẩm định đã xác nhận của tổ chức (phân trang, mới trước) |
| 🟢 hoàn thành | GET |
/api/v1/organizations/{id}/users |
lietKeNguoiDungCuaToChuc |
? | Người dùng bên thứ ba thuộc một tổ chức (phân trang, chỉ đọc) |
| 🟢 hoàn thành | GET |
/api/v1/tpp-users |
lietKeNguoiDungBenThuBa |
? | Liệt kê người dùng bên thứ ba (phân trang, tìm theo thư điện tử, lọc tổ chức / trạng thái / xác minh) |
| 🟢 hoàn thành | GET |
/api/v1/tpp-users/{id} |
chiTietNguoiDungBenThuBa |
? | Chi tiết một người dùng bên thứ ba (cùng hình dạng hàng liệt kê) |