Kiểm định
Kiểm tra phiên bản OpenAPI, ref, điều kiện schema và ví dụ bằng công cụ phù hợp.
MOBILE-ID · TRUSTED LTANS
Tài liệu hợp đồng OpenAPI
Tải hợp đồng REST mục tiêu có lược đồ, ví dụ, quyền, lỗi và liên kết theo dõi tác vụ.
Hợp đồng REST có thể tải và kiểm định
OpenAPI 3.1 mô tả API 3.0.0-draft với 26 thao tác. Đây là hợp đồng mục tiêu; tải hợp đồng để sinh client hoặc kiểm định trước khi nhận môi trường. Explorer trình bày ví dụ từng endpoint ở trang riêng.
Mục lục thao tác và quyền
| API | Nhóm | Scope | Chi tiết |
|---|---|---|---|
| POST /v1/archives | Lưu trữ | archives:write | Request, response và lỗi |
| GET /v1/archives | Lưu trữ | archives:read | Request, response và lỗi |
GET /v1/archives/{archiveId} | Lưu trữ | archives:read | Request, response và lỗi |
GET /v1/archives/{archiveId}/status | Lưu trữ | archives:read | Request, response và lỗi |
GET /v1/archives/{archiveId}/evidence | Bằng chứng | evidence:read | Request, response và lỗi |
GET /v1/archives/{archiveId}/evidence/{evidenceVersion} | Bằng chứng | evidence:read | Request, response và lỗi |
POST /v1/archives/{archiveId}/verification | Kiểm chứng | verification:write | Request, response và lỗi |
GET /v1/verifications/{verificationId} | Kiểm chứng | verification:read | Request, response và lỗi |
| POST /v1/renewals | Renewal | renewals:write | Request, response và lỗi |
GET /v1/renewals/{renewalId} | Renewal | renewals:read | Request, response và lỗi |
| GET /v1/profiles | Policy | policies:read | Request, response và lỗi |
GET /v1/profiles/{profileId} | Policy | policies:read | Request, response và lỗi |
GET /v1/policies/{policyId} | Policy | policies:read | Request, response và lỗi |
POST /v1/archives/{archiveId}/exports | Xuất | exports:write | Request, response và lỗi |
GET /v1/exports/{exportId} | Xuất | exports:read | Request, response và lỗi |
POST /v1/archives/{archiveId}/transfers | Chuyển giao | transfers:write | Request, response và lỗi |
GET /v1/transfers/{transferId} | Chuyển giao | transfers:read | Request, response và lỗi |
POST /v1/transfers/{transferId}/acknowledgements | Chuyển giao | transfers:acknowledge | Request, response và lỗi |
GET /v1/jobs/{jobId} | Job | jobs:read | Request, response và lỗi |
| POST /v1/webhooks | Webhook | webhooks:write | Request, response và lỗi |
GET /v1/webhooks/{webhookId} | Webhook | webhooks:read | Request, response và lỗi |
DELETE /v1/webhooks/{webhookId} | Webhook | webhooks:write | Request, response và lỗi |
POST /v1/archives/{archiveId}/holds | Policy | holds:write | Request, response và lỗi |
POST /v1/archives/{archiveId}/dispositions | Lưu trữ | disposition:write | Request, response và lỗi |
| GET /v1/audit-records | Kiểm toán | audit:read | Request, response và lỗi |
| GET /v1/usage-reports | Kiểm toán | billing:read | Request, response và lỗi |
Cách sử dụng hợp đồng
Cấu hình client
Nhận BASE_URL, quyền và thông tin xác thực qua kênh được cấp; không dùng URL mô phỏng làm endpoint.
Đối soát ngữ nghĩa
Schema hợp lệ chưa chứng minh backend; chạy ca quyền, chống lặp, trạng thái và lỗi một phần.
API Reference đọc được offline
Swagger UI được đóng gói cục bộ và nhận spec nhúng từ contract hiện hành. Public documentation không gửi request; operation security vẫn mô tả OAuth scope và profile mTLS nếu áp dụng.