Quản lý REST APIs
Quản lý REST APIs

1. Khai báo REST APIs

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

Userguide FPT API Management 6

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, OAuthApi 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.

Userguide FPT API Management 7

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

Userguide FPT API Management 8

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.

 

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.

Userguide FPT API Management 38

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

Userguide FPT API Management 39

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.

Userguide FPT API Management 40

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

Userguide FPT API Management 41