Ứng dụng riêng là một công cụ trên Sapo Web giúp bạn kết nối những ứng dụng của mình với Sapo thông qua API public, từ đó tự động hóa và đồng bộ dữ liệu từ Sapo nhằm thực hiện các chức năng bổ trợ cho việc Quản lý Sản phẩm, Đơn hàng, Khách hàng ...
Ví dụ: Bạn dùng phần mềm kế toán ngoài và muốn lấy dữ liệu doanh thu từ Sapo về hệ thống kế toán tự động.
Sau đây là hướng dẫn sử dụng Ứng dụng riêng:
1. Thêm mới Ứng dụng riêng
Bước 1: Trên thanh menu bên trái trang quản trị Sapo Web, truy cập Ứng dụng.
Bước 2: Lướt xuống dòng thông tin "Bạn đang làm việc với nhà phát triển?", nhấp vào đường dẫn Ứng dụng riêng.
Bước 3: Chọn Tạo ứng dụng riêng.
Bước 4: Tại màn hình Tạo mới ứng dụng riêng, bạn thực hiện các thao tác sau:
- Điền thông tin Tên ứng dụng (bắt buộc) và Email liên hệ
- Cấp quyền cho phép ứng dụng riêng của bạn truy cập các thông tin trên Sapo Web.
- Các nội dung có thể truy xuất:
- Nội dung website như bài viết, blogs, bình luận, trang tĩnh và chuyển hướng
- Khách hàng
- Đơn hàng, giao dịch và vận chuyển
- Sản phẩm, phiên bản và danh mục
- Giao diện và các tài nguyên css, js
- Script tag
- Khuyến mãi
- Đơn hàng nháp
- Mỗi tính năng có 3 quyền cho bạn chọn:
- Không cho phép: Ứng dụng không thể truy cập dữ liệu.
- Chỉ đọc: Ứng dụng có thể lấy thông tin nhưng không thể thêm mới hay cập nhật thông tin.
- Đọc và ghi: Ứng dụng có thể lấy thông tin, thêm mới, cập nhật dữ liệu.
Bước 5: Chọn Lưu. Sau khi tạo thành công ứng dụng riêng sẽ có thông tin API key và API secret.
- API Key: Mã xác thực giúp ứng dụng kết nối với Admin API.
- API Secret: Mật khẩu bảo mật đi kèm với API Key để xác thực.
Cách sử dụng:
- Dùng phương thức Basic Authentication để gửi yêu cầu API.
- Định dạng URL truy cập API:
- https://apikey:apisecret@hostname/admin/resource.json
Ví dụ nếu bạn muốn lấy danh sách đơn hàng, gọi API:
https://999f35603fef47849b6a44b67104a647:[email protected]/admin/orders.json
2. Sửa Ứng dụng riêng
Bước 1: Trên thanh menu bên trái trang quản trị Sapo Web, truy cập Ứng dụng.
Bước 2: Lướt xuống dòng thông tin "Bạn đang làm việc với nhà phát triển?", nhấp vào đường dẫn Ứng dụng riêng.
Bước 3: Tại danh sách ứng dụng riêng, chọn ứng dụng riêng cần sửa => sẽ mở ra trang chi tiết ứng dụng riêng đó, bao gồm các thông tin về Tên ứng dụng, Email liên hệ, API key, API secret và các quyền truy cập, chỉnh sửa dữ liệu đã thiết lập trước đó.
Bước 4: Có thể chỉnh sửa tên ứng dụng, email, danh sách quyền cho các tính năng. Sau đó chọn Lưu
Lưu ý: Sau khi sửa quyền API Key và API Secret vẫn giữ nguyên không bị thay đổi.
3. Sử dụng Ứng dụng riêng (sử dụng qua Postman)
Sử dụng Ứng dụng riêng bằng phương thức xác thực Basic Authentication sau khi có thông tin API key và API secret và sử dụng định dạng dữ liệu mặc định Content-Type application/json để thao tác với API Sapo. Chi tiết API Sapo tại đây.
