Tài liệu này mô tả tất cả các phương thức API cho các hành động sau:

• nhận danh sách các đối tượng (phương pháp danh sách)
• lọc danh sách (phương pháp danh sách với dữ liệu bộ lọc)
• nhận thông tin chi tiết về một đối tượng (phương thức hiển thị)
• nhận dữ liệu cho biểu mẫu đối tượng thêm (thêm phương thức)
• lưu dữ liệu dưới dạng một đối tượng mới (phương thức lưu trữ)
• nhận dữ liệu cho biểu mẫu cập nhật đối tượng (chỉnh sửa phương pháp)
• lưu dữ liệu của đối tượng được cập nhật (phương pháp cập nhật)

API chỉ chấp nhận các yêu cầu từ một danh sách giới hạn các địa chỉ IP (ví dụ: từ trang tài khoản của khách hàng hoặc trang văn phòng hỗ trợ).

Mọi yêu cầu tới API từ địa chỉ IP không có trong danh sách được phép sẽ bị từ chối.

Điều này được thực hiện để ngăn chặn các cuộc tấn công DDoS vào API, cố gắng làm sai lệch các yêu cầu và thử nghiệm của hacker.

Người dùng luôn truy cập trang web công cộng của nền tảng (văn phòng của khách hàng hoặc văn phòng hỗ trợ) và bản thân trang web này yêu cầu dữ liệu cần thiết từ API của nền tảng. Vì địa chỉ IP của trang là cố định nên nó sẽ nằm trong danh sách được phép.

Tất cả các yêu cầu API được thực hiện bằng các phương thức HTTP sau:

• GET cho danh sách, hiển thị, thêm và chỉnh sửa
• POST cho cửa hàng
• PUT để cập nhật
• DELETE để xóa

Mỗi phần của API chứa một URL mà yêu cầu được thực hiện để lấy dữ liệu có liên quan.

Phương thức yêu cầu HTTP được chỉ định trước mỗi URL.

Mỗi yêu cầu API phải luôn chứa 4 biến:

1. data (chuỗi json với mảng dữ liệu cho API)
2. user (chuỗi json với một mảng dữ liệu về người dùng hiện tại)
3. time (giờ hiện tại theo múi giờ UTC)
4. hash (chữ ký điện tử ở dạng băm để xác minh rằng yêu cầu tới API chắc chắn là từ một nguồn được ủy quyền)

Nếu yêu cầu thành công, API luôn trả về hai biến:

1. status = true (trạng thái thành công)
2. data (chuỗi json với mảng dữ liệu từ API)

Nếu yêu cầu không thành công, API sẽ hiển thị các biến:

1. status = false (tình trạng lỗi)
2. error (chuỗi văn bản mô tả lỗi)

Mỗi yêu cầu API phải chứa một biến băm là chữ ký số của yêu cầu.

hash = md5($json . $time . $salt)

• md5, sha256, bcrypt — các thuật toán mã hóa có sẵn
• $json — chuỗi json với dữ liệu yêu cầu
• $time — thời gian ở định dạng "DD.MM.YYYY HH: MM: SS"
• $salt — cố định giá trị duy nhất ("muối") cho API nền tảng