Giới thiệu API Baokim
Trang này cung cấp thông tin cơ bản về các quy định và tiêu chuẩn khi làm việc với API của Baokim.
1. Bảng Phiên bản
| Phiên bản | Mô tả | Ngày phát hành |
|---|---|---|
| 1.0 | Phiên bản ban đầu | 2017-05-21 |
| 2.0 | Cập nhật phiên bản mới | 2024-11-06 |
| 4.0 | Cập nhật phiên bản mới | 2026-06-01 |
2. Bảng Thuật ngữ
| Thuật ngữ | Giải nghĩa |
|---|---|
| API | Application Programming Interface — giao diện cho phép các hệ thống tương tác với nhau. |
| Signature | Chữ ký số để xác thực và đảm bảo tính toàn vẹn của dữ liệu. |
| Content-Type | Kiểu dữ liệu được gửi trong request hoặc response. |
| RSA256 | Thuật toán RSA với khóa 256-bit. |
| ED25519 | Thuật toán chữ ký số Edwards-curve với khóa 256-bit. |
3. URL API
| Phiên bản | Sandbox | Production |
|---|---|---|
| 1.0 | ||
| 2.0 | https://devtest.baokim.vn | https://bws.baokim.vn |
4. Hướng dẫn chung về Request
Mỗi request gửi tới API của Baokim phải tuân theo các hướng dẫn sau:
Header
| Tên | Giá trị | Mô tả |
|---|---|---|
| Content-Type | application/json | Định dạng dữ liệu là JSON |
| Signature | Chữ ký số | Chữ ký số để xác thực request |
Body
| Định dạng | Mô tả |
|---|---|
| JSON | Nội dung của request |
5. Hướng dẫn chung về Response
Mỗi response từ API của Baokim sẽ tuân theo các hướng dẫn sau:
Header
| Tên | Giá trị | Mô tả |
|---|---|---|
| Content-Type | application/json | Định dạng dữ liệu là JSON |
| Signature | Chữ ký số | Chữ ký số của Baokim |
Body
| Định dạng | Mô tả |
|---|---|
| JSON | Nội dung của response |
6. Chi tiết định dạng Signature
Trường Signature trong request phải bao gồm các trường sau:
-
keyVersion (Float): Phiên bản của khóa được sử dụng cho chữ ký.
Ví dụ:1.0 -
algorithm (String): Thuật toán chữ ký được sử dụng để ký request.
Giá trị cho phép:RSA256,ED25519 -
signature (String): Chữ ký số được mã hóa Base64 đại diện cho nội dung của request, được tạo bằng private key tương ứng với public key được cung cấp cho Baokim.
-
Ví dụ Signature:
keyVersion=1.0,algorithm=RSA256,signature=base64-encoded-signature
7. Hướng dẫn bảo mật chung
Tất cả các API được phát triển và cung cấp bởi Baokim phải tuân thủ các tiêu chuẩn ký số sau:
- Tất cả các API request phải được ký số sử dụng thuật toán RSA256 hoặc ED25519. Hiện tại chỉ hỗ trợ RSA256.
- Cặp khóa RSA public/private phải được tạo bởi đối tác và lưu trữ an toàn.
- Private key chỉ được lưu trữ trên máy chủ được ủy quyền (phía đối tác) và không được truyền qua mạng.
- Public key được cung cấp cho Baokim để xác thực chữ ký số của API request.