Thông tin kết nối API
1. Quy Trình Tích Hợp Kỹ Thuật :
Bước 1: Tích hợp sử dụng API xFile trên môi trường Sandbox.
Bước 2: Sau khi hoàn tất, tiến hành kiểm thử trên môi trường Sandbox, chia sẻ kết quả kiểm thử với A4B để đánh giá.
Bước 3: Sau khi xác nhận kết quả kiểm thử A4B cung cấp thông tin tích hợp trên môi trường Production.
Bước 4: Thay đổi thông tin, cấu hình môi trường thành Production. Tiến hành kiểm thử, sau khi hoàn tất chia sẽ kết quả Kiểm thử với chúng tôi.
Bước 5: Triển khai giải pháp xFile đến người dùng trên các nên tảng của bạn
2. Môi Trường Tích Hợp:
xFile cung cấp hai môi trường riêng biệt cho việc tích hợp:
Sandbox: Sử dụng cho việc xây dựng tính năng, kiểm thử, gỡ lỗi, v.v...
Production: Sử dụng chính thức cho đối tác.
3. Thông Tin Tích Hợp :
Các API được cung cấp dưới dạng RESTful API. xFile cung cấp thông tin Api key để sử dụng API cho đối tác theo môi trường tích hợp Sandbox và Production.
3.1 Gateway URL Api :
| Environment | Value |
|---|---|
Sandbox | https://xfile-i3p-hcm-uat.a4b.vn |
Production | https://xfile-i3p-hcm.a4b.vn |
3.2 Cấu Hình HTTP Request :
| Key | Value |
|---|---|
Content-Type | application/json; charset=UTF-8 |
X-API-Key | API Key AWS |
Authorization | Basic {Token} (xFile cấp cho đối tác) |
3.3 Thông tin HTTP Response Code :
| Code | Description |
|---|---|
200 | Request thành công. Kết quả trả về dạng JSON |
400 | Định dạng dữ liệu cung cấp không hợp lệ hoặc bị thiếu. Kết quả lỗi trả về chi tiết theo dạng JSON |
401 | Lỗi gọi API không thể xác thực. Kết quả lỗi trả về chi tiết theo dạng JSON |
500 | Lỗi hệ thống |
4. File đặc tả danh sách Api của xFile :
Đối tác có thể tải file đặc tả danh sách Api của xFile (theo định dạng OpenAPI 3.0) để import vào trong các tool kiểm thử api để gọi api.
Last updated