Cài đặt

API Key và Webhook

Tạo API Key để phần mềm khác kết nối với Hubport và cấu hình Webhook nhận thông báo sự kiện.

API Key và Webhook dành cho việc kết nối Hubport với phần mềm khác (kế toán, website riêng, hệ thống nội bộ...). Thường do người làm kỹ thuật hoặc đơn vị tích hợp thực hiện. Tài liệu kỹ thuật đầy đủ xem tại docs-api.hubport.vn.

Vị trí

Cửa hàng > Cài đặt khác, tab API (bấm Tới trang cài đặt API) hoặc tab Webhook (bấm Tới trang cài đặt Webhook).

Cần quyền Cài đặt mở rộng (API Key, Webhook).

API Key

  1. Ở trang API Key, bấm Thêm.
  2. Nhập Tên và Mô tả / Ghi chú (ví dụ "Kết nối phần mềm kế toán").
  3. Có thể nhập Chỉ cho phép truy cập từ tên địa chỉ IP (Restrict IP) để chỉ máy chủ của đơn vị tích hợp gọi được.
  4. Bấm Lưu thông tin. Hệ thống tạo API Key kèm một mã bí mật.
  5. Gửi API Key và mã bí mật cho đơn vị tích hợp qua kênh an toàn.

Trang API Key

  • Bấm Thay đổi cạnh mã bí mật để tạo mã mới khi nghi bị lộ. Mã cũ ngừng dùng được, nhớ cập nhật cho đơn vị tích hợp.
  • Ngừng hợp tác thì đổi Trạng thái của API Key để ngừng cho phép truy cập.

Giữ bí mật

API Key và mã bí mật cho phép truy cập dữ liệu shop. Không đăng lên mạng, không gửi qua kênh công khai.

Webhook

Webhook giúp Hubport tự gửi thông báo tới hệ thống của bạn khi có sự kiện, ví dụ có đơn hàng mới.

  1. Ở trang Webhook, bấm Thêm.
  2. Chọn Nhóm sự kiện (Đơn hàng, Chương trình khuyến mãi, Tồn kho, Khách hàng, Sản phẩm, Thu chi) và sự kiện cụ thể (ví dụ Thêm đơn hàng, Cập nhật khách hàng).
  3. Nhập URL sẽ nhận Webhook từ hệ thống.
  4. Thêm HTTP Header gửi thêm trong request nếu hệ thống nhận cần.
  5. Bấm Lưu thông tin.

Mỗi webhook có Khoá ký để hệ thống của bạn kiểm tra thông báo đúng là do Hubport gửi. Cách kiểm tra xem tại docs-api.hubport.vn.

Trong shop demo, bạn không tạo được API Key và không cấu hình được webhook.

Bài liên quan

On this page