FPT API Management

Site là một thực thể dùng để mapping các product với portal.

Nếu bạn dùng gói Pilot và Normal sẽ được cung cấp một Public site mặc định và không thể tạo thêm site mới. Nếu có nhu cầu sử dụng nhiều site hãy nâng cấp lên gói cao hơn.

1. Tạo Site mới

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

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

• Name: Tên site.
• Title: Tiêu đề.
• Production mode: Chọn chế độ product.
• Virtual area: Chọn khu vực trong danh sách đã được admin khai báo trước đó.
• Gateway: Chọn gateway trong danh sách đã được admin khai báo trước đó.
• Portal: Chọn Portal trong danh sách đã được admin khai báo trước đó.

Bước 3: Chọn OK để tiến hành tạo Site.

2. Thay đổi thông tin Site

Để thay đổi thông tin của một Site, bạn thao tác như sau:

Bước 1: Ở Site Management, chọn Site cần thay đổi thông tin > Chọn Edit.

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

Lưu ý: Một số trường 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 Site.

3. Staging product

Để bắt đầu đưa một product lên site, trước hết người dùng cần stage (đặt) product vào site.

Lưu ý: Khi product đó được stage lên một site, thì consumer vẫn chưa dùng được các API trong product đó. Người dùng cần phải thực hiện publish product thì consumer mới sử dụng được product.

Người dùng cần vào giao diện product và chọn site để stage product đó lên site đó.

Để gán product vào site, bạn thao tác như sau:

Bước 1: Ở Product Management, chọn Product cần pubic lên Site > Staging.

Bước 2: Chọn Staging to New site.

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

• Product: Product cần gán vào Site.
• Site to publish: Chọn site đã tạo trước đó.

Bước 4: Chọn OK.

4. Quản lý trạng thái của các product trong site

Sau khi Staging product, bạn có thể vào trực tiếp Site để quản lý các product đang nằm trong Site và trạng thái hoạt động của nó.

Để quản lý Product trong site cụ thể, bạn thao tác như sau:

Bước 1: Ở Site Management, chọn Site cần quản lý Product.

Bước 2: Chọn Product.

Ở đây bạn sẽ thấy danh sách Product và trạng thái của nó trong Site.

1 product sẽ có các trạng thái: Unstagging, Stagging, Published, Deprecated, Retired, Archived.

Quan hệ giữa các trạng thái được mô tả như hình:

• Ở trạng thái Published, consumer được gán với product đó mới có thể nhìn và sử dụng product.
• Ở trạng thái Deprecated, consumer mới sẽ không nhìn thấy product, các consumer đã sử dụng product sẽ tiếp tục dùng được product đó.
• Ở trạng thái Retired, consumer cũ sẽ không dùng được product nữa.
• Ở trạng thái Archived, product có thể được xóa. Để quản lý các product đang ở trạng thái Archived hãy vào tab Archived products.

5. Lấy thông tin Endpoint của Product

Mỗi Product khi ở trạng thái Published đều có 1 Endpoint để Consumer sử dụng.

Để lấy thông tin Endpoint của Product, bạn thao tác như sau:

Bước 1: Ở Site Management, chọn Site chứa Product cần lấy thông tin > Chọn Product.

Bước 2: Chọn Product cần lấy thông tin > Chọn Manage Api.

Bước 3: Thông tin cần lấy sẽ nằm ở cột API EndPoint.