Trung tâm trợ giúp Khách hàng Sapo

Tạo và sửa ứng dụng riêng để sử dụng API Sapo trên phần mềm Sapo OmniAI

Màn hình Ứng dụng riêng giúp bạn kết nối hệ thống Sapo OmniAI với các phần mềm bên ngoài thông qua API. Tính năng này hỗ trợ tự động hóa và đồng bộ dữ liệu (Sản phẩm, Đơn hàng, Khách hàng...) để tối ưu công việc quản lý.

Điều kiện tiên quyết:
  • Tài khoản Sapo OmniAI của bạn là tài khoản chủ cửa hàng.
  • Bạn đã có thông tin hệ thống/phần mềm bên ngoài cần kết nối (ví dụ: Phần mềm kế toán, CRM, Postman...).

1. Tạo mới ứng dụng riêng

  • Bước 1: Truy cập danh sách Ứng dụng: Trên thanh menu bên trái trang quản trị Sapo OmniAI, tại mục ỨNG DỤNG, bạn nhấp chọn biểu tượng + (ngay bên cạnh chữ Ứng dụng).
  • Bước 2: Mở giao diện Ứng dụng riêng: Tại màn hình Ứng dụng, bạn nhấp chọn nút Ứng dụng riêng ở góc trên bên phải màn hình.
  • Bước 3: Mở màn hình Tạo mới ứng dụng riêng: Tại giao diện danh sách Ứng dụng riêng, bạn nhấp chọn nút Tạo ứng dụng riêng ở góc trên bên phải.

Bước 4: Thiết lập thông tin và Phân quyền Admin API

Tại màn hình Tạo mới ứng dụng riêng, bạn nhập và chọn các thông tin sau:

  • Tên ứng dụng (Bắt buộc): Nhập tên gợi nhớ cho ứng dụng.
  • Email liên hệ: Nhập email nhận thông báo.
  • Phân quyền Admin API: 
    • Các tính năng có thể được phân quyền:
      • 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  
      • Kho  
      • Đơn nhập hàng  
      • Đơn trả hàng nhập  
      • Phiếu chuyển kho  
      • Nhà cung cấp  
      • Giao diện và các tài nguyên css, js  
      • Script tag  
      • Khuyến mãi  
      • Đơn hàng nháp  
      • Sổ quỹ  
      • Chi nhánh
    • Tùy chỉnh quyền truy xuất dữ liệu cho từng tính năng:
      • Không cho phép: Ứng dụng không thể truy cập dữ liệu.
      • Chỉ đọc: Ứng dụng chỉ được lấy dữ liệu, không thể thêm mới hoặc cập nhật.
      • Đọc và ghi: Ứng dụng có thể lấy, thêm mới và cập nhật dữ liệu.
  • Phân quyền Storefront API (Nếu sử dụng): Tích chọn Cho phép app sử dụng Storefront API, sau đó tích chọn các quyền tương ứng:
    • Đọc dữ liệu sản phẩm
    • Đọc và ghi dữ liệu khách hàng
    • Đọc và ghi dữ liệu checkout
    • Đọc nội dung web.

Bước 5: Lưu thông tin ứng dụng

Sau khi hoàn tất cài đặt, bạn nhấp chọn nút Lưu ở góc trên hoặc góc dưới bên phải. Hệ thống sẽ tự động khởi tạo thông tin xác thực bao gồm:

  • 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.
  • Storefront access token: Mã token công khai phía client side (nếu kích hoạt Storefront API).
Cảnh báo:
  • Thông tin API Secret chứa thông tin bảo mật quan trọng. Bạn tuyệt đối không chia sẻ mã này cho các bên không tin tưởng để đảm bảo an toàn dữ liệu cửa hàng.

2. Quản lý và chỉnh sửa ứng dụng riêng

  1. Bước 1: Truy cập màn hình chi tiết Ứng dụng riêng: Trên thanh menu bên trái, chọn ỨNG DỤNG > bấm dấu + > chọn Ứng dụng riêng. Tại danh sách hiển thị, nhấp chuột vào Tên ứng dụng riêng cần chỉnh sửa.
  2. Bước 2: Cập nhật thông tin và Lưu: Tại màn hình chi tiết, bạn có thể thay đổi Tên ứng dụng, Email liên hệ, hoặc thay đổi danh sách Phân quyền Admin API / Storefront API. Sau đó nhấp chọn Lưu.
Lưu ý:
  • Sau khi chỉnh sửa và lưu thành công, hai mã API KeyAPI Secret ban đầu vẫn được giữ nguyên không thay đổi.
  • Để ngưng kết nối hoàn toàn, bạn có thể nhấp vào nút Xóa ứng dụng ở góc dưới bên phải.

3. Hướng dẫn sử dụng API kết nối

Để thao tác dữ liệu qua API Sapo (ví dụ: chạy trên Postman hoặc tích hợp phần mềm), bạn sử dụng phương thức xác thực Basic Authentication. Tham khảo chi tiết bảng mô tả các Endpoint API của Sapo tại tài liệu Sapo API Reference Document: https://docs.sapo.vn/docs/api/admin-rest/overview/

iconTrợ lý Sapo
icon
icon