Tạo và quản lý khóa API

Khóa API cho máy chủ, công cụ tự động hoặc CI đọc và ghi dữ liệu cửa hàng mà không cần ai đăng nhập. Bạn chọn từng phạm vi khóa được dùng, ngày hết hạn, và thu hồi khóa bất cứ lúc nào.

Trang Khóa API còn có khóa công khai cho storefront. Khóa này dùng trong code giao diện chạy trên trình duyệt, và chỉ làm được những gì một khách mua hàng làm được.

Tạo khóa bí mật

1. Vào Cài đặt › Khóa API.
2. Bấm Tạo khóa API.
3. Nhập Tên khóa, ví dụ tên hệ thống sẽ dùng khóa.
4. Ở Loại khóa, giữ Tiêu chuẩn, hoặc chọn Chỉ đọc nếu hệ thống chỉ cần đọc dữ liệu.
5. Trong Phạm vi, đánh dấu từng phạm vi khóa cần, ví dụ read:products. Đánh dấu tên nhóm như read hoặc write sẽ chọn cả nhóm.
6. Kiểm tra Ngày hết hạn. Khóa mới hết hạn sau 90 ngày. Bạn có thể chọn ngày khác trong lịch.
7. Bấm Tạo.
8. Trong hộp Đã tạo khóa API, bấm biểu tượng hai tờ giấy chồng lên nhau Sao chép cạnh khóa.
9. Dán khóa vào nơi lưu bí mật của hệ thống, ví dụ biến môi trường của máy chủ hoặc CI.
10. Bấm Tôi đã lưu khóa này.

Trên điện thoại, bấm biểu tượng menu ở góc trên bên trái, chọn Cài đặt, rồi bấm biểu tượng bảng bên cạnh Cài đặt cửa hàng để chọn Khóa API. Nút Tạo khóa API nằm trong biểu tượng ba chấm dọc ở đầu trang.

Muốn khóa chỉ nhận yêu cầu từ máy chủ của bạn, nhập địa chỉ IP của máy chủ vào Danh sách IP cho phép rồi nhấn Enter. Nhập từng địa chỉ IP, mỗi địa chỉ một lần nhấn Enter. Không nhập dải IP như 10.0.0.0/24, chỉ nhập từng địa chỉ. Để trống thì khóa nhận yêu cầu từ mọi địa chỉ.

Dùng khóa bí mật

Gửi khóa trong header x-api-key của mỗi yêu cầu tới API của EcomWeb. Khóa chỉ dùng được cho cửa hàng đã tạo ra nó, và chỉ cho những phạm vi bạn đã chọn.

Với EcomWeb CLI, đặt khóa vào biến ECOMWEB_API_KEY. Khóa được ưu tiên hơn phiên đăng nhập, và CLI không ghi khóa ra đĩa.

# Đọc danh sách sản phẩm bằng khóa API, ví dụ trong CI
$ ECOMWEB_API_KEY=<khóa bí mật> ecomweb products list --store-ref <mã cửa hàng>

Sửa hoặc tạm dừng khóa

1. Vào Cài đặt › Khóa API.
2. Ở dòng của khóa, bấm biểu tượng ba chấm Tác vụ khác.
3. Chọn Sửa.
4. Đổi tên, phạm vi, danh sách IP hoặc ngày hết hạn.
5. Muốn tạm dừng khóa, tắt Đang hoạt động.
6. Bấm Lưu thay đổi.

Loại khóa không đổi được sau khi tạo. Cần loại khác thì tạo khóa mới. Cột Lần sử dụng cuối và Số yêu cầu giúp bạn biết khóa nào còn được dùng. Chế độ xem Đã thu hồi và hết hạn liệt kê các khóa không còn dùng được.

Thu hồi khóa

1. Vào Cài đặt › Khóa API.
2. Ở dòng của khóa, bấm biểu tượng ba chấm Tác vụ khác.
3. Chọn Thu hồi.
4. Bấm Thu hồi để xác nhận.

Lấy khóa công khai cho storefront

Thẻ Khóa công khai cho storefront có sẵn một khóa cho mỗi cửa hàng. Khóa này chỉ đọc danh mục và thao tác như khách mua hàng, và chỉ nhận yêu cầu từ các trang trong Trang được phép (tự động quản lý). EcomWeb tự thêm vào danh sách này địa chỉ của cửa hàng, tên miền riêng, localhost và website tự host bạn đã kết nối.

1. Vào Cài đặt › Khóa API.
2. Ở thẻ Khóa công khai cho storefront, bấm Sao chép.
3. Dán khóa vào cấu hình storefront của bạn.

Storefront gửi khóa này trong header x-storefront-api-key. Cách dùng với website chạy trên máy chủ của bạn, xem Kết nối website tự host.

Đổi khóa công khai

Đổi khóa khi bạn muốn bỏ khóa cũ, ví dụ khi đổi người làm storefront.

1. Ở thẻ Khóa công khai cho storefront, bấm Đổi khóa.
2. Bấm Đổi khóa để xác nhận.
3. Bấm Sao chép để lấy khóa mới.
4. Cập nhật khóa mới vào storefront của bạn.

Khóa cũ vẫn dùng được thêm 7 ngày rồi ngừng hoạt động. Dưới khóa mới có dòng báo ngày khóa cũ ngừng.

Câu hỏi thường gặp