Tổng quan về API của S-Cart

(Cập nhật: 2021-08-25)

Lưu ý: Tài liệu này chi hỗ trợ các phiên bản S-Cart từ 6.5

Demo: https://s-cart.org/demo-api/

1. Giới thiệu
2. Phân loại
3. Sử dụng

---

1. Giới thiệu
API đã xuất hiện trong các phiên bản cũ của S-Cart. Tuy nhiên, nó chỉ chính thức được hỗ trợ và phát triển từ phiên bản 6.5
S-Cart sử dụng Laravel passport là cơ sở để xây dựng các API.
Mục đích hướng tới của các API là hỗ trợ các ứng dụng bên thứ 3 (giống như mobile app) có thể làm việc trực tiếp hệ thống của S-Cart.
Ngoài ra, một số tính năng nâng cao sẽ được phát triển trong thời gian sắp tới.

2. Phân loại
Về cơ bản, API trong S-Cart được chia làm 3 nhóm chính:
(Xem chi tiết danh sách các API hỗ trợ: https://s-cart.org/demo-api)
a. Khách hàng
Những API hỗ trợ người dùng cuối: đăng nhập, đăng xuất, tạo tài khoản, tạo đơn hàng, quản lý đơn hàng...
Chi tiết: https://s-cart.org/vi/developer/master/api-customer.html
b. Admin
Những API hỗ trợ chức năng xác thực và quản lý thông qua tài khoản quản trị
Chi tiết: https://s-cart.org/vi/developer/master/api-admin.html
c. Front-end
Những API  thực hiện lấy dữ liệu website để trình diễn ra bên ngoài
Chi tiết: https://s-cart.org/vi/developer/master/api-front.html

3. Sử dụng
a. Thay đổi oauth key
Để sử dụng API chứng thực, các file oauth-private.key, oauth-public.key phải tồn tại trong thư mục "s-cart-folder/storage"

Để tạo key mới (do bị xóa hoặc thay thế), bạn sử dụng lệnh "php artisan passport:keys --force"


b. Tắt mở API
Nếu không muốn sử dụng API, hãy tắt nó trong trang quản lý
 

c.  Nhận kết quả json
Để chắc chắn kết quả trả về sau mỗi request là một json, hãy thêm giá trị "Accept:application/json" vào header của mỗi request tới API.

d. Bảo mật nâng cao
"apikey" và "apiconnection" là tính năng bảo mật tăng cường chỉ có ở S-Cart. Nếu không có nhu cầu sử dụng, bạn có thể tắt chúng trong admin.
Xem thêm: https://s-cart.org/vi/developer/master/api-connection.html

e. Bảo mật Bear

- Nhóm API "Customer" sử dụng access_token được trả về từ "api/member/login"
- Nhóm API "Admin" và "Front" sử dụng access_token trả về từ "api/admin/login"

Video: