Kết nối API
(Ngành Bán buôn, Bán lẻ)
I. Giới thiệu chung
Tính năng Kết nối API (Application Programming Interface) là một công cụ mạnh mẽ, cho phép gian hàng của bạn chủ động tích hợp dữ liệu với các hệ thống bên ngoài như website, sàn thương mại điện tử, CRM một cách linh hoạt và bảo mật.
Lợi ích nổi bật của tính năng Kết nối API trên KiotViet:
- Tích hợp hệ thống mở rộng: KiotViet hỗ trợ mở cổng kết nối API để gian hàng có thể chủ động liên kết với các đối tác thứ 3 như các nền tảng website, thương mại điện tử, CRM.
- Quản lý dữ liệu toàn diện: API cung cấp cơ chế đọc và ghi các đối tượng cốt lõi như Nhóm hàng, Hàng hóa, Đặt hàng, Hóa đơn, Khách hàng, Phiếu nhập hàng, giúp đồng bộ hóa dữ liệu giữa KiotViet và các nền tảng khác.
- Bảo mật thông tin tối đa: Mã API chỉ hiển thị trên tài khoản có vai trò admin của chủ gian hàng, đồng thời cho phép admin kiểm soát chặt chẽ quyền truy xuất các thông tin nhạy cảm.
II. Thao tác cơ bản
1. Thiết lập kết nối và lấy thông tin API
- Tình huống: Bạn là quản trị viên của gian hàng và cần lấy thông tin API (Client ID, Mã bảo mật) để cung cấp cho đối tác kỹ thuật tích hợp hệ thống.
- Thao tác thực hiện như sau:
- Từ màn hình Quản lý, vào menu Thiết lập → Cửa hàng.
- Trên menu bên trái màn hình, bạn chọn Kết nối API → nhấn Chỉnh sửa
- Nhập số điện thoại trên hợp đồng để nhận mã xác thực → nhấn Nhận mã xác thực.
- Nhập mã xác thực hệ thống gửi về số điện thoại trên → chọn Tiếp tục.
- Tại thông tin Mã bảo mật → nhấn Tạo mã
- Đọc kỹ điều khoản sử dụng và tích chọn đồng ý → nhấn Đồng ý
- Tích chọn: Cho phép truy xuất thông tin khách hàng, hoá đơn, đặt hàng từ gian hàng của bạn và Lưu thông tin
- Bạn cung cấp thông tin về Client ID và Mã bảo mật cho bên thứ 3 truy xuất dữ liệu trên gian hàng
2. Ngừng hoạt động kết nối API
- Tình huống: Bạn muốn tạm thời ngắt kết nối với một hệ thống bên thứ ba và cần vô hiệu hóa API để đảm bảo an toàn dữ liệu.
- Thao tác thực hiện như sau:
- Truy cập vào màn hình Thông tin kết nối API như hướng dẫn ở trên.
- Nhấn Chỉnh sửa → chọn trạng thái Ngừng hoạt động.
- Nhấn Lưu để xác nhận thay đổi.
3. Tổng quan về Public API
- Giới thiệu: KiotViet Public API được phát triển để hỗ trợ việc tích hợp và trao đổi dữ liệu giữa KiotViet và các nền tảng website, thương mại điện tử, CRM…
- Các đối tượng hỗ trợ: KiotViet Public API cung cấp cơ chế đọc và ghi các đối tượng sau:
- Nhóm hàng: Lấy danh sách nhóm hàng hóa với các thông tin về tên nhóm hàng và quan hệ giữa các nhóm hàng.
- Hàng hóa: Lấy thông tin sản phẩm, tạo mới, sửa, xóa sản phẩm, thuộc tính của sản phẩm.
- Đặt hàng: Lấy thông tin đơn hàng, tạo đơn hàng, cập nhật và hủy đơn hàng.
- Hóa đơn: Lấy thông tin hóa đơn, tạo hóa đơn, cập nhật và hủy hóa đơn.
- Khách hàng: Lấy danh sách khách hàng và thao tác trên thông tin khách hàng.
- Phiếu nhập hàng: Lấy thông tin phiếu nhập.
- Lưu ý: Toàn bộ thông tin kỹ thuật chi tiết nằm trong bài viết Hướng dẫn sử dụng Public API.
Thông tin Hỗ Trợ
- Tổng đài tư vấn bán hàng: 1800 6162
- Tổng đài hỗ trợ phần mềm: 1900 6522
- Email hỗ trợ: hotro@kiotviet.com
