NHÀ PHÁT TRIỂN · CheckID · API 1.2.260123

REST API

REST API được xây lại từ tài liệu CheckID API đặc tả V1.2.260123, không sử dụng đặc tả OAuth2 Client Credentials cũ.

Nguồn hợp đồng APIĐặc tả API và Kafka CheckIDV1.2.260123
REST API THEO NGUỒN

Hợp đồng tích hợp hiện hành

V1.2.260123 · OAuth2 · Bearer · WSO2 · x-billcode-id.

POST
/realms/{realm}/protocol/openid-connect/token

Retrieve Token

Lấy token theo OAuth2 Client Credentials.

công khai
GET
/v1/get/system/info

Lấy thông tin hệ thống

Khám phá phiên bản dịch vụ, ngôn ngữ, phương thức và cấu hình khi chạy.

công khai
POST
/identification/v1/initialize/group

Initialize Identification Group

Khởi tạo chủ thể for 1:N khuôn mặt, vân tay hoặc mống mắt định danh.

Đối tác
POST
/v1/create/subject

Tạo Chủ thể

Tạo chủ thể PERSONAL hoặc ENTERPRISE trước khi bắt đầu các bước kiểm tra.

Đối tác
GET
/v1/get/subjects

Get List of Subjects

Liệt kê chủ thể với phân trang và bộ lọc định danh/liên hệ.

Đối tác
GET
/v1/get/subject/details

Get Chủ thể Chi tiết

Lấy thông tin chủ thể và tùy chọn DG/ràng buộc chi tiết phương thức.

Đối tác
PUT
/v1/update/subject

Update Chủ thể

Cập nhật thông tin chủ thể đã xác thực và bối cảnh nguồn của tuyên bố.

Đối tác
POST
/v1/create/process

Tạo Quy trình

Tạo một quy trình xác minh bên trong một chủ thể; mỗi chủ thể có thể chứa nhiều quy trình.

Đối tác
GET
/v1/get/process/detail

Lấy thông tin quy trình Chi tiết

Truy xuất trạng thái quy trình và ngữ cảnh kết quả theo đặc tả nguồn.

Đối tác
PUT
/v1/perform/process

Thực thi Quy trình

Thực thi quy trình với bằng chứng có điều kiện theo loại quy trình.

Đối tác
GET
/v1/get/management/transactions

Get List of Transactions

Truy xuất bản ghi giao dịch phục vụ mục đích quản lý đã được ủy quyền.

khách hàng/Đối tác
THAM CHIẾU KỸ THUẬT

REST API: Công bố theo hướng ưu tiên đặc tả

Nguồn → Phạm vi → Triển khai → Bằng chứng → Giới hạn

API phiên bản nguồn

Lấy các ví dụ công khai từ CheckID API & Kafka Specifications V1.2.260123/OpenAPI tương ứng. Mỗi thao tác hiển thị nguồn phân loại công khai / đối tác / khách hàng - đối tác để tránh công khai hóa lược đồ vượt phạm vi.

Mô hình tài nguyên

Đặc tả hiện có các nhóm Xác thực, Hệ thống, Nhóm Định danh, Chủ thể, Quy trình và Quản lý. Chủ thể là danh tính/bối cảnh đối tượng doanh nghiệp; Quy trình là xác minh action/mục đích; giao dịch/quản lý views dùng để truy vết theo quyền được cấp.

Định danh

Các định danh xuất hiện trong danh mục công khai gồm `x-subject-id`, `x-process-id`, `x-billcode-id` và `x-group-id` ở thao tác tương ứng. Không đổi tên chúng thành trường “đẹp” hơn.

Lược đồ có điều kiện

Yêu cầu / phản hồi phụ thuộc `process_type` và thao tác. Bắt buộc/tùy chọn/quy tắc có điều kiện phải lấy từ OpenAPI/nguồn, không suy ra từ ví dụ duy nhất.

Lỗi

HTTP trạng thái và application kết quả/lỗi code phải được giấy tờ cùng raw message, meaning và recommended action. Raw literal có typo lịch sử vẫn giữ nguồn khả năng truy vết cho tới khi API chủ sở hữu xác nhận correction.

Khả năng tương thích

API công bố phải ghi nguồn phiên bản, ngừng hỗ trợ/errata nếu có, môi trường ranh giới và không nhúng thông tin bí mật/PII thật.