Tích hợp KDATA Storage sử dụng API

Mục lục

1. Tổng quan

Định nghĩaMô tả
Domainhttps://oss-api.kdata.vn
Postmannone

2. Danh sách API

2.1. Tạobucket

2.1.1. Dữ liệu gửi lên

Url: {DOMAIN}/service/bucket 

Headers:

STTTham sốKiểu dữ liệuĐiều kiệnMô tả tham số
1api-keyStringBắt buộcApi Key

Params:

STTTham sốKiểu dữ liệuĐiều kiệnMô tả tham số
2nameStringBắt buộcTên bucket
3descriptionStringTuỳ chọnMô tả
4storageIntegerBắt buộcKích thước bucket, đơn vị GB
5request_timeStringBắt buộcThời gian upload, định dạng: yyyy-mm-dd H:i:s
6signatureStringBắt buộcChữ 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ề

STTTham sốKiểu dữ liệuMô tả tham số
1successBoolTrạng thái response trả về true/false
2errorObjectThông tin lỗi khi success = false
2.1error.codeInt (4)Mã lỗi trả về, được định nghĩa ở mục: Bảng mã lỗi
2.2error.messageString (200)Mô tả cho mã lỗi trả về, được định nghĩa ở mục: Bảng mã lỗi
2.3error.errorsArrayThông tin chi tiết lỗi
3dataObjectThông tin dữ liệu trả về khi success = true
3.1data.nameStringTên bucket
3.2data.descriptionStringMô tả
3.3data.created_atStringThời gian tạo bucket

2.2. Uploadfile

2.2.1. Dữ liệu gửi lên

Url: {DOMAIN}/service/bucket/upload Headers:
STTTham sốKiểu dữ liệuĐiều kiệnMô tả tham số
1api-keyStringBắt buộcApi Key

Params:

STTTham sốKiểu dữ liệuĐiều kiệnMô tả tham số
2bucketStringBắt buộcTên bucket
3file_uploadFile uploadBắt buộcFile upload
4file_pathFile pathTuỳ chọnĐường dẫn file trong bucket. Mặc định là thư mục gốc trong bucket
5request_timeStringBắt buộcThời gian upload, định dạng: yyyy-mm-dd H:i:s
6signatureStringBắt buộcChữ 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ề

STTTham sốKiểu dữ liệuMô tả tham số
1successBoolTrạng thái response trả về true/false
2errorObjectThông tin lỗi khi success = false
2.1error.codeInt (4)Mã lỗi trả về, được định nghĩa ở mục: Bảng mã lỗi
2.2error.messageString (200)Mô tả cho mã lỗi trả về, được định nghĩa ở mục: Bảng mã lỗi
2.3error.errorsArrayThông tin chi tiết lỗi
3dataObjectThông tin dữ liệu trả về khi success = true
3.1data.file_pathStringĐường dẫn file trong bucket.
Để lại một bình luận 0

Your email address will not be published. Required fields are marked *