Chuyển tới nội dung chính

🔐 Xác thực

Mọi lời gọi API tới Xbook đều cần xác thực để xác định người dùng và quyền truy cập.

Các phương thức

Phương thứcDùng khi
API KeyTích hợp server-to-server, tác vụ tự động (khuyến nghị).
Session (cookie)Ứng dụng chạy trong cùng trình duyệt/phiên đăng nhập.
OAuth2Ứng dụng bên thứ ba thay mặt người dùng (khi đã bật).

Tạo API Key

  1. Đăng nhập Xbook → mở Hồ sơ người dùng.
  2. Vào tab Tài khoản bảo mật → API Keys.
  3. Chọn Tạo khóa mới, đặt tên gợi nhớ (ví dụ tich-hop-n8n).
  4. Sao chép khóa ngay — khóa chỉ hiển thị một lần.

Lấy uid từ API Key

import xmlrpc.client
common = xmlrpc.client.ServerProxy(f"{base_url}/xmlrpc/2/common")
uid = common.authenticate(db, username, api_key, {})
# uid là số nguyên định danh người dùng, dùng cho mọi lời gọi sau.

:::warning Bảo mật

  • Không commit API key vào mã nguồn; dùng biến môi trường hoặc trình quản lý bí mật.
  • Cấp khóa theo nguyên tắc tối thiểu quyền: tạo riêng tài khoản tích hợp với quyền vừa đủ.
  • Thu hồi ngay khóa bị lộ trong màn hình API Keys. :::