Nền tảng định danh GIW — tài liệu API
Sinh tự động từ repository lúc build image. Toàn bộ chạy được offline.
POC · CHỈ CHẠY LOCAL. Không có gì trong tài liệu này là hợp đồng production. Direct Grant / password grant chỉ dùng cho POC; đường browser / Authorization Code + PKCE được giữ lại làm ứng viên production. Xem Chiến lược xác thực.
Tham chiếu API
| Nội dung | Ở đâu |
|---|---|
| Tham chiếu OpenAPI tương tác — mọi endpoint, schema và ví dụ | reference.html |
| Đặc tả thô, dùng để sinh client | openapi.yaml |
Tài liệu đi kèm
Bắt đầu
| Tài liệu | File nguồn |
|---|---|
| Tổng quan API | api/API-OVERVIEW.vi.md |
| Bảng tổng hợp API | api/API-MATRIX.vi.md |
| Sơ đồ tuần tự | api/API-SEQUENCES.vi.md |
Hợp đồng
| Tài liệu | File nguồn |
|---|---|
| Tích hợp Keycloak | api/KEYCLOAK-INTEGRATION-SPEC.vi.md |
| Bảng quyết định DMN | api/DMN-DECISION-SPEC.vi.md |
| Tích hợp Loyalty | api/LOYALTY-INTEGRATION-SPEC.vi.md |
| Module giw-admin | api/GIW-ADMIN-MODULE-SPEC.vi.md |
| Hợp đồng claim | api/TOKEN-CLAIMS.vi.md |
| Danh mục lỗi | api/ERROR-CATALOG.vi.md |
Bảo mật & riêng tư
| Tài liệu | File nguồn |
|---|---|
| Phân loại dữ liệu | api/DATA-CLASSIFICATION.vi.md |
| Bảo mật API | api/API-SECURITY.vi.md |
| Chiến lược xác thực | docs/AUTH-STRATEGY.vi.md |
Review
| Tài liệu | File nguồn |
|---|---|
| Checklist review | api/API-REVIEW-CHECKLIST.vi.md |
Vận hành
| Tài liệu | File nguồn |
|---|---|
| Hướng dẫn test | docs/TEST-GUIDE.vi.md |
| Hướng dẫn giw-admin + Camunda | docs/GUIDE-GIW-ADMIN.vi.md |
| Vận hành | docs/RUNBOOK.vi.md |
| Môi trường | docs/ENVIRONMENTS.vi.md |
Bốn thẩm quyền
| Hệ thống | Thẩm quyền | Không bao giờ |
|---|---|---|
| Keycloak (Galaxy ID) | Xác thực | Mở mạng · quyết định quyền lợi |
| HR Verification API | Tình trạng lao động — là cổng chặn | Trả hồ sơ · là nguồn sự thật về danh tính |
| Loyalty API | Hạng hội viên — chỉ làm giàu | Chặn truy cập. Sập thì mất ưu đãi, không mất kết nối |
| DMN Decision Service | Đánh giá luật | Cấp quyền lợi · lưu trữ bất cứ gì |
| Entitlement Service | Cấp quyền — được dùng những gì | Thực thi · tạo phiên |
| Session Service | Thực thi — trạng thái truy cập | Ra quyết định. grant không có entitlementId là 422 |
| Wi-Fi Portal / BFF | Điều phối và giao diện | Quyết định bất cứ điều gì |
Service đang chạy
| Service | Địa chỉ local | Vai trò |
|---|---|---|
| Wi-Fi Portal | http://localhost:3000 | Bản demo chính |
| API documentation | http://localhost:3004 | Chính trang này |
| Keycloak admin | http://localhost:8080 | Galaxy ID — định danh |
| Mock HR API | http://localhost:3001 | Tình trạng lao động — cổng chặn |
| Mock Loyalty API | http://localhost:3006 | Hạng hội viên — chỉ làm giàu |
| Entitlement Service | http://localhost:3002 | Cấp quyền — được dùng gì |
| DMN Decision Service | http://localhost:3005 | Đánh giá luật |
| Session Service | http://localhost:3003 | Thực thi — trạng thái truy cập |
Mọi cổng bind 127.0.0.1. Không truy cập được từ LAN hay Internet.