Trang này được dịch bởi Cloud Translation API.

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

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về 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 để phát hành API.

Xem video sau để tìm hiểu cách tạo sản phẩm API.

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

Cảnh báo: Để đảm bảo sản phẩm API của bạn hoạt động chính xác, hãy thực hiện các thao tác sau:

Đưa chính sách bảo mật phù hợp vào các proxy API của bạn, chẳng hạn như Xác minh khoá API hoặc OAuth phiên bản 2.0. Sản phẩm API sử dụng khoá API và/hoặc mã truy cập OAuth để thực thi quyền truy cập vào API. Để biết thêm thông tin, hãy xem phần Khoá API và Trang chủ OAuth.
Thêm các proxy API và/hoặc đường dẫn tài nguyên vào sản phẩm API của bạn để hạn chế quyền truy cập. Nếu không, mọi ứng dụng liên kết với sản phẩm API này đều có thể thực hiện lệnh gọi đến bất kỳ API nào trong tổ chức Edge của bạn.

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

Truy cập trang sản phẩm API theo mô tả dưới đây.

Edge

Cách truy cập vào trang sản phẩm API bằng giao diện người dùng Edge:

Đăng nhập vào https://apigee.com/edge.
Chọn Publish > API Products (Xuất bản > Sản phẩm API).

Trang Sản phẩm API sẽ xuất hiện.

Trang Sản phẩm API hiển thị danh sách các sản phẩm API. Chú thích được cung cấp bên dưới hình để cho biết những việc bạn có thể thực hiện.

Như minh hoạ trong hình trước, trang sản phẩm API cho phép bạn thực hiện các thao tác sau (như mô tả ở phần sau của phần này):

Thêm sản phẩm API
Chỉnh sửa và xoá sản phẩm API
Tìm kiếm danh sách sản phẩm API

Phiên bản cũ (Đám mây riêng tư)

Cách truy cập vào trang sản phẩm API bằng giao diện người dùng Classic Edge:

Đăng nhập vào http://ms-ip:9000, trong đó ms-ip là địa chỉ IP hoặc tên DNS của nút Máy chủ quản lý.
Chọn Xuất bản > Sản phẩm.

Trang sản phẩm API cho phép bạn thực hiện các tác vụ sau, được mô tả ở phần sau của phần này:

Thêm sản phẩm API
Chỉnh sửa và xoá sản phẩm API
Tìm kiếm danh sách sản phẩm API

Thêm 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ả dưới đây. Để sử dụng Edge API, hãy xem phần Định cấu hình 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:

Truy cập trang sản phẩm API, như mô tả trước đó trong phần này.
Nhấp vào + Sản phẩm API.

Nhập Chi tiết 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. Đừng chỉ định ký tự đặc biệt trong tên. Lưu ý: Tên sản phẩm API phải sử dụng một chuỗi ký tự duy nhất, bất kể trường hợp nào. Ví dụ: bạn sẽ gặp lỗi nếu tạo một sản phẩm API có tên `productA` rồi sau đó cố gắng tạo một sản phẩm API khác có tên `ProductA`. Tên công ty mà bạn sử dụng để kiếm tiền không được chứa dấu cách. Tên của các sản phẩm API mà bạn sử dụng với tính năng kiếm tiền không được chứa dấu cách ở cuối.
Tên hiển thị	Tên hiển thị cho 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 đó bất cứ lúc nào. Nếu không được chỉ định, giá trị Tên sẽ được sử dụng. Trường này được tự động điền bằng cách sử dụng giá trị Tên; bạn có thể chỉnh sửa hoặc xóa nội dung của trường. Tên hiển thị có thể chứa các ký tự đặc biệt.
Nội dung 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 bài viết Cấp truy cập.
Tự động phê duyệt các yêu cầu cấp quyền truy cập	Bật tính năng tự động phê duyệt các yêu cầu chính 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 (UI) 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 trong các chính sách về 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 cuộc gọi có thể 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 bao gồm chính sách Hạn mức để thực thi hạn mức. Để biết thêm thông tin, hãy xem bài viết 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 phép các phạm vi OAuth 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 kèm lệnh gọi API). Chỉ định nhiều phạm vi dưới dạng một danh sách được phân tách bằng dấu phẩy. Xem Phạm vi OAuth.

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

Cảnh báo: Nếu bạn không thêm bất kỳ proxy API nào vào sản phẩm API của mình, thì nhà phát triển ứng dụng sẽ có thể truy cập vào tất cả proxy API và đường dẫn tài nguyên của bạn.

Ví dụ: nếu bạn thêm proxy API "music" vào sản phẩm có đường dẫn cơ sở là /music, sản phẩm API sẽ cho phép 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 lệnh gọi đến /music/venues?name=paramount được phép nhưng các lệnh gọi đến /music/artists?name=Jack%Johnson sẽ bị chặn.

Thiết lập một đường dẫn tài nguyên cụ thể hoặc thiết lập đường dẫn cơ sở và tất cả các đường dẫn con có thể có bằng cách chỉ định đường dẫn tài nguyên là /. Đường dẫn tài nguyên có thể bao gồm các ký tự đại diện /** và /*. Ký tự đại diện kép dấu hoa thị cho biết tất cả đường dẫn phụ 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ỉ các URI tính từ đường dẫn cơ sở xuống một cấp mới được hỗ trợ. Xem phần Định cấu hình hành vi của đường dẫn tài nguyên của "/", "/*" 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 proxy hoặc Thêm đường dẫn trong mục tài nguyên API.
2. Chọn xem bạn muốn thêm Proxy API, Đường dẫn hay cả đường dẫn và proxy API.
3. Thêm một hoặc nhiều proxy API và đường dẫn tài nguyên.
  
  Cảnh báo: Nếu bạn không thêm bất kỳ proxy API nào vào sản phẩm API của mình, thì nhà phát triển ứng dụng sẽ có thể truy cập vào tất cả proxy API và đường dẫn tài nguyên của bạn.
  
  Xin lưu ý những điều sau:
  - Các đườ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 ít cụ thể hơn và toàn diện 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à /**, đườ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 tài nguyên khác (để chỉ định tài nguyên API bổ sung).
Lưu ý: Bạn không thể chỉnh sửa tài nguyên API. Thay vào đó, bạn cần xoá tài nguyên API hiện có và thêm phiên bản mới có các giá trị đã sửa.
(Không bắt buộc) Sử dụng phần Mục tiêu dịch vụ từ xa API để 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 đang dùng Trình chuyển đổi Apigee Envoy. Để biết thêm thông tin, vui lòng xem Hướng dẫn về quy trình vận hành cho Bộ chuyển đổi Apigee Envoy.
(Không bắt buộc) Sử dụng phần 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 việc 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ị 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 tuỳ chỉnh). Nếu giá trị của thuộc tính này là true (không dùng nữa), bạn có thể báo lỗi bằng chính sách Raise Fault.

Cảnh báo: Tên thuộc tính sau đây là dành riêng cho Apigee sử dụng và sẽ gây ra lỗi nếu sử dụng: access
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 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	Cho phép cho /	Được phép đối với /*	Được phép cho /**	Cho phép đối với //2/*	Được phép đối với //2/
/v1/weatherapikey	Y	Không	Không	Không	N
/v1/weatherapikey/	Y	Không	Không	Không	N
/v1/weatherapikey/1	Y	Y	Có	Không	N
/v1/weatherapikey/1/	Y	Y	Có	Không	N
/v1/weatherapikey/1/2	Y	Không	Có	Không	N
/v1/weatherapikey/1/2/	Y	Không	Y	Có	N
/v1/weatherapikey/1/2/3/	Y	Không	Y	Y	Y
/v1/weatherapikey/1/a/2/3/	Y	Không	Có	Không	N

Theo mặc định, đường dẫn tài nguyên / trong một sản phẩm API sẽ hỗ trợ đường dẫn cơ sở và mọi đường dẫn phụ. 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à đến mọi đường dẫn phụ, chẳng hạn như /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, v.v.

Bạn có thể thay đổi giá trị 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, nghĩa là sản phẩm API sẽ không cho phép truy cập vào URI có bất kỳ giá trị nào sau /. Nếu bạn thực hiện thay đổi này thì trong bảng trên, chỉ có hai hàng đầu tiên trong phần "Cho phép /" 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 trong tổ chức của bạn thành true. Khách hàng của Cloud có thể gửi yêu cầu đó đến Apigee Edge Support.

Đám mây riêng tư: Khách hàng của Apigee Edge dành cho đám mây riêng tư có thể gửi yêu cầu bằng biểu mẫu bên dưới để thiết lập tài sản này cho một tổ chức:

curl -u username:password -X POST -H "Content-type:application/xml" http://host:8080/v1/o/myorg -d \
"<Organization name='myorg' type='trial'> \
<Properties> \
<Property name='features.isSingleForwardSlashBlockingEnabled'>true</Property> \
<!-- other existing org properties here --> \
</Properties> \
</Organization>"

Nhớ đưa các thuộc tính khác của tổ chức hiện có vào lệnh gọi API này. Nếu bạn không thực hiện việc này, các thuộc tính chưa được chỉ định sẽ bị xoá và thay thế bằng thuộc tính đã đặt trong lệnh gọi này.

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

Để chỉnh sửa sản phẩm API:

Truy cập trang sản phẩm API, như mô tả trước đó trong phần này.
Nhấp vào hàng của sản phẩm API mà bạn muốn chỉnh sửa.
Nhấp vào Chỉnh sửa trên trang sản phẩm API.
Chỉnh sửa các trường theo yêu cầu.
Bạn có thể xoá các tài nguyên mình đã 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 gặp trục trặc hoặc cần 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. Bất kỳ ứng dụng nào sử dụng sản phẩm API sẽ không thể truy cập vào tài nguyên đã 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, do đó, các sản phẩm khác vẫn có thể sử dụng các tài nguyên đó.
Nhấp vào Lưu.

Với Apigee Edge cho Cloud công cộng, Edge sẽ lưu 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ể thành công trong tối đa 3 phút cho đến khi giới hạn bộ nhớ đệm của mã hết hạn.
Thực thể Dịch vụ quản lý khoá (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à thực thể KMS.

Xoá sản phẩm API

Trước khi có thể xoá sản phẩm API, bạn phải huỷ đăng ký/huỷ liên kết mọi ứng dụng của nhà phát triển được 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á ứng dụng hoặc thu hồi khoá API của ứng dụng.

Để xoá sản phẩm API:

Truy cập trang sản phẩm API, như mô tả trước đó trong phần này.
Đặt con trỏ lên sản phẩm API trong danh sách.
Nhấp vào .
Nhấp vào Xoá để xác nhận thao tác xoá.