Tích hợp KDATA Storage sử dụng API
Mục lục
1. Tổng quan
Định nghĩa | Mô tả |
Domain | https://oss-api.kdata.vn |
Postman | none |
2. Danh sách API
2.1. Tạobucket
2.1.1. Dữ liệu gửi lên
Url: {DOMAIN}/service/bucket
Headers:
STT | Tham số | Kiểu dữ liệu | Điều kiện | Mô tả tham số |
1 | api-key | String | Bắt buộc | Api Key |
Params:
STT | Tham số | Kiểu dữ liệu | Điều kiện | Mô tả tham số |
2 | name | String | Bắt buộc | Tên bucket |
3 | description | String | Tuỳ chọn | Mô tả |
4 | storage | Integer | Bắt buộc | Kích thước bucket, đơn vị GB |
5 | request_time | String | Bắt buộc | Thời gian upload, định dạng: yyyy-mm-dd H:i:s |
6 | signature | String | Bắt buộc | Chữ ký gửi lên server bằng cách: SHA256(bucket + ‘|’ + storage + ‘|’ + request_time + ‘|’ + api_secret ) Trong đó api_secret là API Secret Kdata cung cấp đi kèm với API Key |
2.1.2. Thông tin trả về
STT | Tham số | Kiểu dữ liệu | Mô tả tham số |
1 | success | Bool | Trạng thái response trả về true/false |
2 | error | Object | Thông tin lỗi khi success = false |
2.1 | error.code | Int (4) | Mã lỗi trả về, được định nghĩa ở mục: Bảng mã lỗi |
2.2 | error.message | String (200) | Mô tả cho mã lỗi trả về, được định nghĩa ở mục: Bảng mã lỗi |
2.3 | error.errors | Array | Thông tin chi tiết lỗi |
3 | data | Object | Thông tin dữ liệu trả về khi success = true |
3.1 | data.name | String | Tên bucket |
3.2 | data.description | String | Mô tả |
3.3 | data.created_at | String | Thời gian tạo bucket |
2.2. Uploadfile
2.2.1. Dữ liệu gửi lên
Url: {DOMAIN}/service/bucket/upload Headers:
STT | Tham số | Kiểu dữ liệu | Điều kiện | Mô tả tham số |
1 | api-key | String | Bắt buộc | Api Key |
Params:
STT | Tham số | Kiểu dữ liệu | Điều kiện | Mô tả tham số |
2 | bucket | String | Bắt buộc | Tên bucket |
3 | file_upload | File upload | Bắt buộc | File upload |
4 | file_path | File path | Tuỳ chọn | Đường dẫn file trong bucket. Mặc định là thư mục gốc trong bucket |
5 | request_time | String | Bắt buộc | Thời gian upload, định dạng: yyyy-mm-dd H:i:s |
6 | signature | String | Bắt buộc | Chữ ký gửi lên server bằng cách: SHA256(bucket + ‘|’ + file_path + ‘|’ + request_time + ‘|’ + api_secret ) Trong đó api_secret là API Secret Kdata cung cấp đi kèm với API Key |
2.2.2. Thông tin trả về
STT | Tham số | Kiểu dữ liệu | Mô tả tham số |
1 | success | Bool | Trạng thái response trả về true/false |
2 | error | Object | Thông tin lỗi khi success = false |
2.1 | error.code | Int (4) | Mã lỗi trả về, được định nghĩa ở mục: Bảng mã lỗi |
2.2 | error.message | String (200) | Mô tả cho mã lỗi trả về, được định nghĩa ở mục: Bảng mã lỗi |
2.3 | error.errors | Array | Thông tin chi tiết lỗi |
3 | data | Object | Thông tin dữ liệu trả về khi success = true |
3.1 | data.file_path | String | Đường dẫn file trong bucket. |