FPT API Management

1. Khai báo REST APIs

Bước 1: Ở menu Application > API Manager > Rest Apis. Chọn Create.

Bước 2: Nhập các thông tin cần thiết:

• Name: Tên API.
• Title: Tiêu đề cho API.
• Base path: Phần đường dẫn để phía client call vào sau khi public API.
• Target endpoint: Endpoint của API đã có sẵn, cần đưa ra cho consumer dùng.
• Target Security: Thông tin xác thực của API.
• Security method: Phương thức xác thực khi client sử dụng API. Hiện tại đang có hai phương thức được sử dụng là Basic Authentication, OAuth và Api Key.

Security method sẽ không thay đổi được sau khi tạo, hãy cẩn thận khi khai báo thông tin này.

Bước 3: Chọn OK để tiến hành khởi tạo REST APIs.

Nếu nút Creat bị disable, hãy kiểm tra lại gói dịch vụ API Management của bạn. Với gói Pilot, chỉ có thể khai báo tối đa 2 API trên hệ thống.

Ngoài ra, trong trường hợp bạn có một danh sách bao gồm nhiều API cần khai báo, bạn có thể đi tới phần Utility để có thể khai báo nhiều API cùng một lúc.

Bạn thao tác như sau: 

Bước 1: Ở menu API Manager, chọn Utility > import API

Bước 2: Bạn nhập dữ liệu của các API vào ô JSON text, dữ liệu phải ở dạng JSON. 

Format cần nhập phải chính xác như sau: 

[ 

{ 

    “name“: “”, 

    “title“: “”, 

    “base_path“: “”, 

    “target_endpoint“: ““, 

    “security_method“: “” 

} 

]

Bước 3: Chọn button Parse > chọn button Import.

Các API được khai báo thành công hiển thị trong bảng Import APIs.

Nếu có lỗi xảy ra, thông báo lỗi sẽ hiển thị trong mục Import Error.

2. Sửa REST APIs

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

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

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

3. Xóa REST APIs

Nếu muốn xóa một REST APIs đã khai báo trước đó khỏi hệ thống, bạn cần đảm bảo không gắn REST APIs đấy vào bất kỳ Products nào. Để gỡ RestAPIs khỏi Product, hãy thao tác theo hướng dẫn ở phần Quản lý Products.

Để xóa Rest APIs, bạn thao tác như sau:

Bước 1: Ở Rest APIs Management, chọn Rest APIs cần xóa > Remove Api.

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

4. Transformer

Nếu muốn thêm /sửa field với một giá trị xác định trong request hoặc trong response trả về, bạn có thể sử dụng tính năng transformer của API Management. 

Để bắt đầu, bạn thao tác như sau: 

Bước 1: Ở Rest APIs Management, chọn Rest APIs  > Chọn Edit > Chọn tab Advance > chọn Transformations 

Bước 2: Bạn tích chọn Request Transformer / Response Transformer,, click Raw view và nhập thông tin bạn muốn thay đổi trong mỗi request/response.

Ví dụ: Remove một số trường trong request transformer: Trường hợp bạn muốn remove một hoặc nhiều trường trong phần body / headers / query string của một request, nhập data bạn muốn thay đổi vào phần tương ứng.

5. Security (Cross – Origin Resource Sharing)

Để sử dụng tính năng này, bạn thao tác như sau: 

Bước 1: Ở menu Application > API Manager > chọn Rest Apis > chọn 1 API > chọn Edit.

Bước 2: Chọn tab Advance > chọn tab Security > tích vào ô Use CORS. 

Bước 3: Nhập thông tin: 

• Access-Control–Allow-Origin: Nhập IP, domain,… cho phép truy cập API. Lúc này, chỉ các trình duyệt đã được liệt kê mới có thể truy cập API. Nếu không nhập thì coi như cho phép toàn bộ các domain khác được truy cập vào API.