Quản lý Consumers

Sau khi API Provider public product lên site, client chưa thể sử dụng các API đó ngay. API Provider cần tạo thông tin Consumer và chỉ định Consumer đó subscribe một product đã được public. Khi đó client mới sử dụng được API.

Tạo Consumer mới

Bước 1: Ở menu API Manager > chọn Consumers > Create.

Bước 2: Nhập các thông tin theo yêu cầu:

• Name: Tên Consumer.
• Site: Chọn site Consumer có hiệu lực.
• API Key: Tích chọn xác thực bằng API key hay không.
• Title: Tiêu đề.
• Password: Mật khẩu nếu dùng Basic Authentication.
• Confirm password: Xác nhận lại mật khẩu.
• Max per second: Số lần client có thể gọi API trên giây.
• Max per minute: Số lần client có thể gọi API trên phút.
• Max per hour: Số lần client có thể gọi API trên giờ.

Bước 3: Chọn OK để tạo Consumer.

ghi chú

• Có thể khai báo và sử dụng song song cả API Key và Password.
• Phương thức xác thực của Consumer phải tương ứng với API cần sử dụng.

Subscribe product

Bước 1: Ở Consumer Management > chọn consumer > chọn Product subscription.

Bước 2: Chọn Subscribe product.

Bước 3: Chọn Product.

ghi chú

Product phải ở trạng thái published thì consumer mới có thể subscribe.

Bước 4: Chọn OK để lưu.

Unsubscribe product

Bước 1: Ở Consumer Management > chọn consumer > chọn Product subscription.

Bước 2: Chọn Unsubscribe product.

Bước 3: Chọn OK để lưu.

Chỉnh sửa thông tin Consumer

Bước 1: Ở Consumer Management > chọn Consumer cần thay đổi > chọn Edit.

Bước 2: Nhập các thông tin mới và chọn OK.

Lấy thông tin xác thực của Consumer

API Management hỗ trợ 2 phương thức xác thực: Basic Auth (User/Pass) và API Key.

Lấy Username và Password (Basic Auth)

• Username: Cấu trúc UsernameProvider.tênsite.usernameConsumer (ví dụ: demo123.sitedemo.demoacc).

Hoặc lấy trực tiếp:

Bước 1: Ở Consumer Management > chọn Consumer > chọn Edit.

Bước 2: Lấy Username ở trường Basic Authen User.

• Password: Mật khẩu đã khai báo ở bước tạo consumer.

Lấy thông tin API Key

Bước 1: Ở Consumer Management > chọn Consumer > chọn Edit.

Bước 2: Lấy API Key ở trường Api key.

Xóa Consumer

Trước khi xóa, bạn cần đảm bảo Consumer không subscribe bất kỳ Product nào. Thực hiện Unsubscribe trước nếu cần.

Bước 1: Ở Consumer Management > chọn Consumer cần xóa > chọn Remove.

Bước 2: Trong popup xác nhận, chọn Yes để tiến hành xóa.

ghi chú

Nếu gặp lỗi Could not remove that consumer as there are still subscriptions of that consumer!, hãy Unsubscribe toàn bộ Product trước khi thao tác.