Chuyển đến nội dung chính

Documentation Index

Fetch the complete documentation index at: https://docs.sellfern.com/llms.txt

Use this file to discover all available pages before exploring further.

Sellfern sử dụng hai cơ chế xác thực: xác thực phiên dựa trên JWT cho giao diện trình duyệt, và bearer token có tiền tố sk_live_ cho REST API và tích hợp. Nếu bạn đang xây dựng một tự động hóa, script hoặc tích hợp bên thứ ba, bạn sẽ dùng bearer token. Giao diện UI xử lý xác thực phiên tự động khi bạn đăng nhập.
Token API cấp quyền truy cập theo chương trình vào dữ liệu của tổ chức bạn. Lưu chúng trong biến môi trường hoặc trình quản lý bí mật — không bao giờ commit vào mã nguồn hoặc chia sẻ trong các kênh công khai. Token không thể được lấy lại sau thời điểm tạo.

Đăng nhập UI

Khi bạn mở Sellfern trong trình duyệt, bạn đăng nhập bằng một trong hai phương thức: Email và mật khẩu — Nhập email và mật khẩu đã đăng ký trên trang đăng nhập. Sellfern phát hành một token phiên JWT và tải không gian làm việc. Google OAuth — Nhấp vào Sign in with Google và hoàn tất quy trình ủy quyền Google. Nếu tài khoản Google của bạn mới với Sellfern, bạn sẽ hoàn tất đăng ký bằng cách đặt tên tổ chức và mật khẩu trước khi không gian làm việc mở ra. Tài khoản đa tổ chức — Nếu tài khoản của bạn thuộc nhiều tổ chức, Sellfern hiển thị bộ chọn tổ chức sau khi bạn xác thực. Chọn tổ chức bạn muốn truy cập; bạn có thể chuyển đổi tổ chức sau bằng bộ chọn trong thanh bên. Việc chuyển đổi sẽ làm mới không gian làm việc để tất cả dữ liệu — đơn hàng, cửa hàng, báo cáo, cài đặt — phản ánh tổ chức đã chọn.

Token API

Token API cho phép các script, agent và tích hợp bên ngoài gọi REST API của Sellfern thay mặt cho tổ chức của bạn. Mỗi token mang một bộ phạm vi giới hạn những gì nó có thể làm.

Tạo token

  1. Đăng nhập Sellfern và vào Settings → API Tokens.
  2. Nhấp vào Create Token.
  3. Đặt tên mô tả cho token (ví dụ, n8n weekly report hoặc order sync script).
  4. Chọn các phạm vi mà token cần. Chỉ cấp các phạm vi cần thiết cho tích hợp — xem bảng bên dưới.
  5. Tùy chọn đặt ngày hết hạn và hạn ngạch hàng ngày.
  6. Nhấp vào Create. Sao chép giá trị token hiển thị trên màn hình.
Giá trị token đầy đủ chỉ được hiển thị một lần. Sao chép ngay lập tức và lưu trữ an toàn. Nếu mất, bạn phải thu hồi token và tạo cái mới.

Các phạm vi có sẵn

Phạm viCho phép làm gì
orders:readĐọc bản ghi đơn hàng và siêu dữ liệu
orders:writeTạo và cập nhật đơn hàng
orders:status:writeCập nhật các trường trạng thái đơn hàng
analytics:readĐọc báo cáo doanh thu, chi phí và lợi nhuận
fulfillment:readĐọc bản ghi hoàn tất đơn và theo dõi
fulfillment:writeCập nhật trạng thái hoàn tất đơn và theo dõi
webhooks:manageTạo, cập nhật và xóa các điểm cuối webhook

Sử dụng token trong yêu cầu

Truyền token của bạn trong tiêu đề Authorization của mọi yêu cầu API:
curl -X GET "https://api.sellfern.com/api/v2/orders" \
  -H "Authorization: Bearer sk_live_YOUR_TOKEN_HERE"
Đây là ví dụ thứ hai đọc dữ liệu phân tích trong 7 ngày gần nhất:
curl -X GET "https://api.sellfern.com/api/v2/analytics/summary?period=last_7_days" \
  -H "Authorization: Bearer sk_live_YOUR_TOKEN_HERE"
Mọi yêu cầu API phải bao gồm tiêu đề này. Yêu cầu không có token hợp lệ sẽ bị từ chối với phản hồi 401.

Thực hành tốt về bảo mật token

Tuân thủ các thực hành này giữ cho dữ liệu của tổ chức bạn an toàn ngay cả khi một token bị xâm phạm.
Cấp phạm vi tối thiểu — Chỉ cấp các phạm vi mà tích hợp thực sự cần. Một script báo cáo chỉ cần analytics:read; nó không nên đồng thời có orders:write. Xoay vòng thường xuyên — Tạo token mới theo lịch trình (ví dụ, mỗi 90 ngày), cập nhật tích hợp để dùng nó, sau đó thu hồi cái cũ. Xoay vòng thường xuyên giới hạn cửa sổ rủi ro nếu token bị rò rỉ. Lưu trong biến môi trường — Tải token từ biến môi trường hoặc trình quản lý bí mật khi chạy. Không bao giờ mã hóa cứng token trong mã nguồn hoặc đưa vào kho lưu trữ. Mỗi tích hợp một token — Cấp cho mỗi script hoặc dịch vụ token riêng. Nếu một cái bị xâm phạm, bạn có thể thu hồi mà không ảnh hưởng đến các tích hợp khác. Thu hồi token không sử dụng — Vào Settings → API Tokens, tìm các token không còn sử dụng và thu hồi chúng. Nhật ký hoạt động trên mỗi token cho thấy việc sử dụng gần đây.

Phản hồi lỗi

Sellfern trả về các mã trạng thái HTTP chuẩn cho các lỗi xác thực và phân quyền.
Trạng tháiÝ nghĩa
401 UnauthorizedToken bị thiếu, không hợp lệ hoặc đã bị thu hồi. Kiểm tra xem token đã được định dạng đúng và chưa hết hạn.
403 Forbidden (missing_scope)Token không có phạm vi mà điểm cuối yêu cầu. Thêm phạm vi cần thiết vào token, hoặc tạo token mới với các phạm vi đúng.