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

Bắt đầu nhanh

Tích hợp CheckID/CheckID theo đặc tả V1.2.260123: OAuth2 → Chủ thể → Quy trình → Thực thi → Kết quả.

Trao đổi với chuyên gia Bắt đầu tích hợp

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

LUỒNG TÍCH HỢP

Từ OAuth2 đến bằng chứng

Luồng nguồn mới thay thế OAuth2 Client Credentials của .

01OAuth2Client Credentials

02Chủ thểCá nhân / doanh nghiệp

03Quy trìnhLoại · Mục đích · Nhà cung cấp

04Thực thiBằng chứng theo điều kiện

05Kết quảTrạng thái · Claims · Xác minh

06Truy vếtx-billcode-id · Kiểm toán

KHỞI TẠO NHÀ PHÁT TRIỂN

Từ sandbox đến yêu cầu đầu tiên

Quick Start mô tả một hành trình tích hợp hoàn chỉnh thay vì chỉ dẫn hướng sang các trang khác.

Đăng ký môi trường thử nghiệm

Đăng ký tổ chức, tình huống sử dụng và API/SDK cần kiểm thử.

Tạo API Client

Nhận client/kiểm thử khách hàng thuê bao và permission trong môi trường sandbox.

Get Access Token

OAuth2 client credentials → access token; không dùng nguồn thông tin xác thực trong website.

Khám phá năng lực

Get Thông tin Hệ thống để đọc phiên bản/phương thức/năng lực được hỗ trợ.

Create Subject

Tạo chủ thể PERSONAL hoặc ENTERPRISE theo tình huống sử dụng.

Create / Perform Process

Chọn phương thức, gửi bằng chứng/đầu vào và theo dõi trạng thái/kết quả.

Inspect & Trace

Đọc kết quả, mã kết quả, giao dịch/tham chiếu bằng chứng.

Đưa vào vận hành chính thức

Tách thông tin xác thực môi trường thật, readiness, chính sách và quy trình hỗ trợ.

THAM CHIẾU KỸ THUẬT

Bắt đầu nhanh theo CheckID API đặc tả V1.2.260123

Token → chủ thể → quy trình → thực thi → trạng thái/kết quả → tương quan giao dịch

1 · Token

Gọi `POST /realms/{realm}/protocol/openid-connect/token` bằng OAuth2 Client Credentials. nguồn ví dụ trả `access_token`, `expires_in`, `token_type=Bearer` và phạm vi. Không dùng AWS Chữ ký cho đặc tả hiện hành.

2 · Tạo chủ thể

`POST /v1/create/subject` tạo chủ thể PERSONAL hoặc ENTERPRISE trước khi chạy kiểm tra. nguồn ví dụ trả `x-subject-id`, `x-billcode-id` và HTTP 201.

3 · Tạo quy trình

`POST /v1/create/process` tạo quy trình xác minh với `process_type`, `mục đích` và bối cảnh identity-document khi áp dụng. Ví dụ trả `process_status`, `x-process-id`, `x-billcode-id`.

4 · Thực thi

`PUT /v1/perform/process` gửi nội dung/bằng chứng theo loại quy trình. Ví dụ nguồn cho PASSIVE_AUTHENTICATION trả `process_status=ACCEPTED` và `perform_result.passive_authentication_status=PARTIAL_VALID`.

5 · Đọc trạng thái

`GET /v1/get/process/detail` trả trạng thái quy trình/loại/mục đích theo bối cảnh kết quả do nguồn xác định. Ứng dụng khách không nên tự suy ra trạng thái cục bộ bằng cách suy từ HTTP success duy nhất.

6 · Tương quan / lỗi

Lưu chủ thể/quy trình/billcode định danh theo đặc tả và dùng danh mục lỗi nguyên văn. Cơ chế thử lại/tính bất biến khi lặp/webhook ngữ nghĩa chưa có có thẩm quyền nguồn và phải được xử lý theo đối tác đặc tả.

Hành trình đạt chuẩn triển khai

Nhà phát triển đường dẫn: OAuth2 token → Chủ thể → Quy trình → Kết quả → Bằng chứng

Bắt đầu nhanh chỉ dùng thao tác/trường trong CheckID đặc tả API V1.2.260123. Webhook và SDK method-level hành vi không được trình bày như môi trường chính thức đặc tả khi nguồn chưa có.

Bước	Được chứng minh bằng nguồn thao tác	Vấn đề
1. Xác thực	POST /realms/{realm}/protocol/openid-connect/token	OAuth2 Client Credentials; Bearer
2. Tạo chủ thể	POST /v1/create/subject	Chủ sở hữu/bối cảnh danh tính; trường chính xác/enums
3. Tạo quy trình	POST /v1/create/process	process_type, mục đích, bối cảnh giấy tờ
4. Thực thi	PUT /v1/perform/process	Bằng chứng/nội dung phụ thuộc loại quy trình
5. Kiểm tra	GET /v1/get/process/detail	Trạng thái/kết quả bối cảnh; không tự tạo trạng thái transition
6. Đối soát	Giao dịch quản lý khi được ủy quyền	Billcode/tương quan quy trình theo nguồn

Chuyển đổi phương thức xác thực

Nguồn hiện hành dùng OAuth2 Client Credentials + Bearer. AWS Chữ ký V4 chỉ giữ như legacy documentation, không phải hiện hành tích hợp guidance.

Xử lý lỗi

Raw API code/message giữ chính xác đặc tả language; con người explanation đứng ngoài literal. Retryability chỉ gắn khi nguồn/hành vi xác nhận.

Tích hợp bất đồng bộ

Gói không có có thẩm quyền webhook signing/cơ chế thử lại/phát lại/order/ack đặc tả; standalone Webhook/Callback đặc trưng docs được hợp nhất.

SDK

MOBILE_SDK_ARCHITECTURE.md xác nhận mẫu kiến trúc nhưng không có class/phương thức/min-OS đặc tả; child SDK trang được hợp nhất.