Quản lý sản phẩm API

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. thông tin

Quản lý các sản phẩm API bằng giao diện người dùng quản lý Apigee Edge, như mô tả trong phần này. Để quản lý sản phẩm API bằng API, hãy xem phần Sử dụng API quản lý Edge để xuất bản API.

Để biết thông tin tổng quan về các sản phẩm API, hãy xem bài viết Sản phẩm API là gì?.

Khám phá trang sản phẩm API

Truy cập vào trang sản phẩm API, như mô tả bên dưới.

Thêm một sản phẩm API

Thêm một sản phẩm API bằng giao diện người dùng như mô tả bên dưới. Để sử dụng Edge API, hãy xem phần Định cấu hình các sản phẩm API bằng API.

Cách thêm một sản phẩm API bằng giao diện người dùng Edge:

1. Truy cập vào trang sản phẩm API, như mô tả trước đó trong phần này.
2. Nhấp vào +API Product (Sản phẩm API).
3. Nhập Thông tin chi tiết về sản phẩm cho sản phẩm API của bạn.
   

   Trường	Nội dung mô tả
   Tên	Tên nội bộ của sản phẩm API. Bạn không thể chỉnh sửa tên sau khi tạo sản phẩm API. Không chỉ định ký tự đặc biệt trong tên.
   Tên hiển thị	Tên hiển thị của sản phẩm API. Tên hiển thị được dùng trong giao diện người dùng và bạn có thể chỉnh sửa tên này bất cứ lúc nào. Nếu bạn không chỉ định, giá trị Tên sẽ được sử dụng. Trường này được điền sẵn bằng giá trị Tên; bạn có thể chỉnh sửa hoặc xoá nội dung của trường này. Tên hiển thị có thể chứa ký tự đặc biệt.
   Mô tả	Nội dung mô tả về sản phẩm API.
   Môi trường	Các môi trường mà sản phẩm API sẽ cho phép truy cập. Ví dụ: test hoặc prod.
   Quyền truy cập	Cấp truy cập. Để biết thông tin chi tiết, hãy xem phần Cấp truy cập.
   Tự động phê duyệt yêu cầu cấp quyền truy cập	Cho phép tự động phê duyệt các yêu cầu về khoá cho sản phẩm API này từ mọi ứng dụng. Để yêu cầu phê duyệt khoá theo cách thủ công, hãy tắt lựa chọn này. Xem phần Đăng ký ứng dụng và quản lý khoá API (giao diện người dùng) và Khoá ứng dụng dành cho nhà phát triển (API).
   Hạn mức	Hạn mức mà bạn muốn tham chiếu từ các chính sách hạn mức. Việc nhập giá trị hạn mức không tự động thực thi các hạn chế về số lượng lệnh gọi có thể được thực hiện thông qua sản phẩm. Các proxy API mà sản phẩm tham chiếu phải có Chính sách về hạn mức để thực thi hạn mức. Để biết thêm thông tin, hãy xem phần Hạn mức.
   Phạm vi OAuth được phép	Nếu bạn đang sử dụng OAuth với sản phẩm API, hãy cho biết các phạm vi OAuth được phép mà bạn muốn sản phẩm API cho phép (chẳng hạn như Đọc hoặc các phạm vi khác mà ứng dụng sẽ gửi cùng với các lệnh gọi API). Chỉ định nhiều phạm vi dưới dạng danh sách được phân tách bằng dấu phẩy. Xem Phạm vi OAuth.

4. Thêm Tài nguyên API có trong sản phẩm API, bao gồm cả các proxy API và đường dẫn tài nguyên.

   Ví dụ: nếu bạn thêm một proxy API "music" vào sản phẩm có đường dẫn cơ sở là /music, thì sản phẩm API sẽ cho phép các lệnh gọi đến /music. Tuy nhiên, nếu bạn muốn sản phẩm API chỉ cho phép truy cập vào đường dẫn tài nguyên venues có URI là /music/venues, hãy thêm đường dẫn tài nguyên /venues vào sản phẩm. Trong trường hợp này, các cuộc gọi đến /music/venues?name=paramount được phép, nhưng các cuộc gọi đến /music/artists?name=Jack%Johnson sẽ bị chặn.

   Đặt một đường dẫn tài nguyên cụ thể hoặc đặt đường dẫn cơ sở và tất cả các đường dẫn con có thể bằng cách chỉ định đường dẫn tài nguyên là /. Đường dẫn tài nguyên có thể chứa ký tự đại diện /** và /*. Ký tự đại diện có hai dấu hoa thị cho biết tất cả đường dẫn con của đường dẫn cơ sở đều được hỗ trợ (nhưng không phải đường dẫn cơ sở). Một dấu hoa thị cho biết chỉ những URI ở cấp độ thấp hơn một cấp so với đường dẫn cơ sở mới được hỗ trợ. Hãy xem phần Định cấu hình hành vi của đường dẫn tài nguyên "/", "/*" và "/**" như mô tả ở phần sau của phần này.

   Cách thêm tài nguyên API:

   1. Nhấp vào Thêm một proxy hoặc Thêm một đường dẫn trong phần Tài nguyên API.
   2. Chọn xem bạn muốn thêm API proxy, Đường dẫn hay cả API proxy và đường dẫn.

      

   3. Thêm một hoặc nhiều proxy API và đường dẫn tài nguyên.

      Xin lưu ý những điều sau:

      • Đường dẫn tài nguyên mà bạn xác định sẽ áp dụng cho tất cả các proxy API được thêm vào sản phẩm API.
      • Các đường dẫn tài nguyên chung hơn, ít cụ thể hơn sẽ được ưu tiên hơn các đường dẫn cụ thể hơn. Ví dụ: nếu bạn thêm / và /**, thì đường dẫn tài nguyên / sẽ được ưu tiên; đường dẫn tài nguyên /** sẽ bị bỏ qua.

      Ví dụ:

      

   4. Nhấp vào Thêm hoặc Thêm và bắt đầu một yêu cầu khác (để chỉ định các tài nguyên API bổ sung).
5. (Không bắt buộc) Sử dụng mục Apigee remote service targets (Mục tiêu dịch vụ từ xa của Apigee) để liên kết sản phẩm với một hoặc nhiều mục tiêu dịch vụ từ xa. Bạn có thể bỏ qua chế độ cài đặt này, trừ phi bạn đang sử dụng Apigee Envoy Adapter. Để biết thêm thông tin, hãy xem Hướng dẫn vận hành cho Apigee Envoy Adapter.

6. (Không bắt buộc) Sử dụng mục Thuộc tính tuỳ chỉnh để thêm tối đa 18 thuộc tính tuỳ chỉnh vào một sản phẩm API.

   Thuộc tính tuỳ chỉnh là các cặp khoá/giá trị có thể được dùng theo nhiều cách, bao gồm cả việc giúp kiểm soát quá trình thực thi proxy API. Ví dụ: bạn có thể tạo một thuộc tính tuỳ chỉnh có tên là deprecated với giá trị là true hoặc false. Trong quy trình proxy API, bạn có thể kiểm tra giá trị của thuộc tính deprecated của sản phẩm API (ví dụ: sử dụng biến verifyapikey.{policy_name}.apiproduct.deprecated tự động có sẵn sau khi bạn tạo thuộc tính tùy chỉnh). Nếu giá trị của tham số này là true (không dùng nữa), bạn có thể gửi lỗi bằng chính sách Raise Fault.

7. Nhấp vào Lưu.

Định cấu hình hành vi của đường dẫn tài nguyên "/", "/*" và "/**"

Bảng sau đây mô tả hành vi mặc định của một sản phẩm API cho các đường dẫn tài nguyên khác nhau. Trong ví dụ này, proxy API có đường dẫn cơ sở là /v1/weatherapikey. Đường dẫn tài nguyên sản phẩm API áp dụng cho hậu tố đường dẫn sau đường dẫn cơ sở.

URI yêu cầu	Được phép cho /	Được phép cho /*	Được phép cho /**	Được phép cho /*/2/**	Được phép cho /*/2/*
/v1/weatherapikey	Có	Không	Không	Không	Không
/v1/weatherapikey/	Có	Không	Không	Không	Không
/v1/weatherapikey/1	Có	Có	Có	Không	Không
/v1/weatherapikey/1/	Có	Có	Có	Không	Không
/v1/weatherapikey/1/2	Có	Không	Có	Không	Không
/v1/weatherapikey/1/2/	Có	Không	Có	Có	Không
/v1/weatherapikey/1/2/3/	Có	Không	Có	Có	Có
/v1/weatherapikey/1/a/2/3/	Có	Không	Có	Không	Không

Theo mặc định, đường dẫn tài nguyên / trong một sản phẩm API hỗ trợ đường dẫn cơ sở và tất cả các đường dẫn con. Ví dụ: nếu Đường dẫn cơ sở của proxy API là /v1/weatherapikey, thì sản phẩm API sẽ hỗ trợ các yêu cầu đến /v1/weatherapikey và mọi đường dẫn con, chẳng hạn như /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, v.v.

Bạn có thể thay đổi chế độ mặc định này để đường dẫn tài nguyên / chỉ tương ứng với Đường dẫn cơ sở của proxy API, tức là sản phẩm API sẽ không cho phép truy cập vào một URI có bất kỳ nội dung nào sau /. Nếu bạn thực hiện thay đổi này, thì trong bảng trên, chỉ hai hàng đầu tiên trong phần "Được phép cho /" sẽ chứa "Y".

Để thay đổi giá trị mặc định, quản trị viên hệ thống phải đặt giá trị của thuộc tính features.isSingleForwardSlashBlockingEnabled trên tổ chức của bạn thành true. Khách hàng Cloud có thể gửi yêu cầu đó cho Nhóm hỗ trợ Apigee Edge.

Chỉnh sửa sản phẩm API

Cách chỉnh sửa một sản phẩm API:

1. Truy cập vào trang sản phẩm API, như mô tả trước đó trong phần này.
2. Nhấp vào hàng của sản phẩm API mà bạn muốn chỉnh sửa.
3. Nhấp vào Chỉnh sửa trên trang sản phẩm API.
4. Chỉnh sửa các trường (nếu cần).

   Bạn có thể xoá những tài nguyên mà bạn đã thêm vào một sản phẩm API. Bạn nên làm việc này nếu một tài nguyên đang bị trục trặc hoặc cần được phát triển thêm. Khi bị xoá, tài nguyên đó sẽ không còn là một phần của sản phẩm API nữa. Mọi ứng dụng sử dụng sản phẩm API đều không thể truy cập vào tài nguyên đã bị xoá nữa. Các tài nguyên đã xoá sẽ bị loại bỏ khỏi sản phẩm nhưng không bị xoá khỏi hệ thống, vì vậy, các sản phẩm khác vẫn có thể sử dụng những tài nguyên này.

5. Nhấp vào Lưu.

Với Apigee Edge cho Đám mây công cộng, Edge sẽ giữ các thực thể sau trong bộ nhớ đệm trong tối thiểu 180 giây sau khi các thực thể được truy cập.

• Mã truy cập OAuth. Điều này có nghĩa là mã thông báo đã bị thu hồi vẫn có thể hoạt động trong tối đa 3 phút, cho đến khi hết hạn mức bộ nhớ đệm.
• Các thực thể Key Management Service (KMS) (Ứng dụng, Nhà phát triển, Sản phẩm API).
• Thuộc tính tuỳ chỉnh trên mã thông báo OAuth và các thực thể KMS.

Xoá một sản phẩm API

Trước khi xoá một sản phẩm API, bạn phải huỷ đăng ký/huỷ liên kết mọi ứng dụng nhà phát triển liên kết với sản phẩm đó. Bạn có thể thực hiện việc này bằng cách xoá các ứng dụng hoặc thu hồi khoá API của ứng dụng.

Cách xoá một sản phẩm API:

1. Truy cập vào trang sản phẩm API, như mô tả trước đó trong phần này.
2. Di chuyển con trỏ đến sản phẩm API trong danh sách.
3. Nhấp vào .
4. Nhấp vào Xoá để xác nhận thao tác xoá.