Sử dụng API

Sau khi đăng ký và được cấp tài khoản API, khách hàng sẽ được cấp một appId và appSecret. Khi gọi API, phải sử dụng appSecret này để tạo một tham số hash. Chi tiết các tạo tham số hash trong mục Tạo Hash và có chi tiết trong từng API

Các request đến API thực hiện đến tên miền

https://openapi.antbuddy.com

Tùy vào từng API mà phương thức và đường dẫn sẽ khác nhau

Tạo Hash

Tất cả request đến AntBuddy ngoài dữ liệu, phải kèm theo một giá trị hash. Hash được tính là sha256 của tất cả các tham số (ngoài trừ hash)

Ví dụ:

appId = 65446465436742018
appSecret = 123456

API lấy lịch sử cuộc gọi

GET /oapi/v1/call/histories?appId=6544646543674&created_from=2018-02-07T02:19:33.000Z&created_to=2018-02-07T07:04:22.000Z

Thì hash được tính như sau:

hash = sha256(“65446465436742018-02-07T02:19:33.000Z2018-02-07T07:04:22.000Z123456”)

= 9b11b9ff77dbba70fe059acf84c02cfe6af90de9122e4d3bd6ec69c9d637f9ed

Lưu ý thứ tự của các tham số của từng API

var crypto = require('crypto');

function checksum (str) {
    return crypto
        .createHash('sha256')
        .update(str, 'utf8')
        .digest('hex')
}

var text = '65446465436742018-02-07T02:19:33.000Z2018-02-07T07:04:22.000Z123456';
var hash = checksum(text);
//9b11b9ff77dbba70fe059acf84c02cfe6af90de9122e4d3bd6ec69c9d637f9ed

Định dạng dữ liệu

Dữ liệu được gửi lên và trả về đều ở định dạng JSON

"Content-Type": "application/json"

HTTP Response

HTTP Code	Giải thích
200	Thành công
400	Lỗi do dữ liệu đầu vào không đúng hoặc không hơp lệ
500	Lỗi do máy chủ API
503	Lỗi do vượt quá giới hạn số request