OpenAPI JSON
Ảnh chụp hợp đồng kỹ thuật ở dạng máy đọc được.
NHÀ PHÁT TRIỂN · CHECKID
Trình khám phá API — giao diện OpenAPI/Swagger chạy ngoại tuyến
Bảng điều khiển nhà phát triển cho OAuth2, Chủ thể, Quy trình, Nhóm nhận dạng và truy vết giao dịch; chạy dữ liệu mô phỏng xác định trước ở chế độ ngoại tuyến, không gửi yêu cầu môi trường thật.
BẢNG ĐIỀU KHIỂN NHÀ PHÁT TRIỂN
Khám phá → Xác thực → Xây dựng → Kiểm thử → Kiểm tra → Truy vết
Mỗi thao tác được gắn với phiên bản API, cơ chế xác thực, mẫu yêu cầu/phản hồi, trạng thái nguồn và ngữ cảnh bằng chứng/truy vết.
GET
/
Điểm kết nối
PHẢN HỒIĐÃ LÀM SẠCH DỮ LIỆU
HỢP ĐỒNG DẠNG MÃ
OpenAPI là vật thể kỹ thuật, không phải ảnh minh họa
OpenAPI cục bộ có phiên bản và tách sandbox/mô phỏng khỏi môi trường chính thức.
OpenAPI YAML
Đặc tả có thể dùng với các công cụ tích hợp.
Phân loại API công bố
Công khai · Đối tác · Quản trị · Yêu cầu phê duyệt
CÔNG CỤ NHÀ PHÁT TRIỂN
Trình khám phá API phải trả lời được “gọi gì, gửi gì, nhận gì, truy vết gì”
Chuẩn hóa cấu trúc đặc tả endpoint công bố thành: Mục đích → Xác thực → Lược đồ → Yêu cầu → Phản hồi → Kết quả → Bằng chứng → Nguồn.
Mô hình vận hành
| Lớp | Yêu cầu |
|---|---|
| Auth | OAuth2 client credentials / Bearer theo đặc tả |
| Tiêu đề | M/O/RC/A + định dạng + ví dụ |
| Yêu cầu | Lược đồ + enum + ví dụ đã làm sạch dữ liệu |
| Phản hồi | HTTP + body lược đồ + doanh nghiệp kết quả |
| Bằng chứng | Quy trình/giao dịch/billcode tham chiếu nếu đặc tả có |
| Nguồn | API phiên bản + nguồn mục + công bố trạng thái |
Trạng thái môi trường thử nghiệm
MÔI TRƯỜNG = OFFLINE_MOCK
NETWORK_REQUEST = false
DỮ LIỆU = SYNTHETIC
SANDBOX = remote kiểm thử dịch vụ (bắt buộc thông tin xác thực)
MÔI TRƯỜNG CHÍNH THỨC = separate khởi tạo / phê duyệt
Không một thao tác ngoại tuyến nào được tự động gọi môi trường thật.
TRẢI NGHIỆM CHUẨN OPENAPI
Danh mục kiểm tra tính đầy đủ của điểm kết nối
Mỗi thao tác phải đủ thông tin trước khi được xem là “Hoàn thiện tài liệu”.
api
Đặc tả
Phương thức, đường dẫn, auth, tiêu đề và phiên bản nguồn.
đầu vàoAPI nguồn
đầu raĐịnh danh thao tác
nguồn
Lược đồ
Mô hình trường yêu cầu / phản hồi với loại, enum và bắt buộc / tùy chọn M/O/RC/A.
đầu vàoĐặc tả trường
đầu raLược đồ đã kiểm tra
xác minh
Ví dụ chạy được
Yêu cầu/phản hồi đã làm sạch dữ liệu + mô phỏng ngoại tuyến có kết quả xác định.
đầu vàoYêu cầu mô phỏng
đầu raMock kết quả
bằng chứng
Khả năng truy vết
mã kết quả, tham chiếu bằng chứng, related quy trình/SDK/thiết bị.
đầu vàoPhản hồi
đầu raChẩn đoán tích hợp
Cơ sở kỹ thuậtCÓ NGUỒN
NguồnCheckID API nguồn + generated OpenAPI
Tiêu chuẩnOAuth2 / OpenAPI
Phiên bảnNguồn tham chiếu gốc V1.2.260123
Phạm vi áp dụngCông khai/đối tác công bố phân loại
Bằng chứngNguồn khả năng truy vết + kiểm toán lược bỏ dữ liệu nhạy cảm