Sau khi nhà cung cấp public product lên site, phía client chưa thể sử dụng được các API đó, muốn sử dụng được, nhà cung cấp phải vào menu Consumer để tạo thông tin của client và chỉ định client đó subscribe một product đã được public trước đó. Khi đó thì client mới sử dụng được API.
Bước 1: Ở menu API Manger, chọn Consumers > Creat.
Bước 2: Nhập các thông tin theo yêu cầu:
Bước 3: Chọn OK để tiến hành tạo.
Sau khi tạo consumer xong, để sử dụng được các API có trong product thì nhà cung cấp phải chỉ định consumer subcribe một product.
Bước 1: Ở Consumer Management, chọn consumer và click chọn Product subscription.
Bước 2: Chọn Subscribe product.
Bước 3: Chọn Product.
Bước 4: Chọn OK để lưu.
Sau khi hoàn tất các bước bên trên, client đã có thể sử dụng các API mà nhà cung cấp đưa ra.
Lưu ý: Product cần phải ở trạng thái publish thì consumer mới có thể subcribe.
Bước 1: Ở Consumer Management, chọn consumer và click chọn Product subscription.
Bước 2: Chọn Unsubscribe product.
Bước 3: Chọn OK để lưu.
Để thay đổi thông tin của một Consumer, bạn thao tác như sau:
Bước 1: Ở Consumer Management, chọn Consumer cần thay đổi thông tin > Chọn Edit.
Bước 2: Nhập các thông tin mới và chọn OK.
Lưu ý: Một số trường sẽ không thể thay đổi và sẽ bị disable trên giao diện sửa. Các trường còn lại cần nhập dữ liệu tuân thủ validation tương tự khi tạo Consumer.
Để sử dụng API được tạo từ API Management, admin API cần lấy thông tin xác thực của từng Consumer và bàn giao lại cho end user. Hiện tại API Management hỗ trợ 2 phương thức xác thực là Basic Auth (User/Pass) và API Key.
5.1 Lấy thông tin Username và Password của Basic Auth:
Username = UsernameProvider + tên site + usernameConsumer.
Ví dụ: demo123.sitedemo.demoacc
Hoặc lấy theo hướng dẫn sau:
Bước 1: Ở Consumer Management, chọn Consumer cần lấy Username > Chọn Edit.
Bước 2: Lấy thông tin Username ở trường Basic Authen User.
5.2 Lấy thông tin API Key:
Bước 1: Ở Consumer Management, chọn Consumer cần lấy API Key > Chọn Edit.
Bước 2: Lấy thông tin API Key ở trường Api key.
Để xóa một Consumer đã khai báo trước đó khỏi hệ thống, bạn cần đảm bảo Consumer đấy đang không subcribe bất cứ Product nào. Để Unsubscribe Product, hãy thao tác theo hướng dẫn ở phần Unsubscribe Product.
Để xóa Consumer, bạn thao tác như sau:
Bước 1: Ở Consumer Management, chọn Consumer cần xóa > Chọn Remove.
Bước 2: Trong popup xác nhận thông tin, chọn Yes để tiến hành xóa.
Lưu ý: Nếu gặp lỗi : Could not remove that consumer as there are still subscriptions of that consumer!. Bạn cần Unsubscribe toàn bộ Product trước khi thao tác.