Đăng ký ứng dụng và quản lý khoá 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

Đăng ký ứng dụng và quản lý khoá API theo mô tả trong các phần sau.

Giới thiệu

Quy trình đăng ký ứng dụng cung cấp cơ chế chính để kiểm soát những ai có thể truy cập vào API của bạn.

Là nhà cung cấp API, bạn tạo một hoặc nhiều sản phẩm API để gói các API của mình, như được giải thích trong phần Quản lý các sản phẩm API. Khi đăng ký một ứng dụng, nhà phát triển ứng dụng sẽ chọn sản phẩm API cần sử dụng và Edge cung cấp một khoá API duy nhất mà nhà phát triển có thể dùng để truy cập vào các sản phẩm API đó. Nhà phát triển ứng dụng chuyển khoá API trong mỗi lệnh gọi đến các proxy API có trong các sản phẩm API. Bất cứ lúc nào, bạn cũng có thể thu hồi khoá API của ứng dụng để ngăn nhà phát triển ứng dụng truy cập vào tất cả hoặc một nhóm nhỏ các sản phẩm API mà ứng dụng đó tham chiếu đến.

Thông thường, nhà phát triển ứng dụng đăng ký sử dụng các sản phẩm API của bạn qua cổng thông tin dành cho nhà phát triển. Các bước tạo cổng thông tin và phát hành sản phẩm API được mô tả trong bài viết Xây dựng cổng thông tin.

Ngoài ra, với tư cách là nhà cung cấp API, bạn có thể muốn có nhiều quyền kiểm soát hơn đối với quá trình đăng ký ứng dụng và chọn đăng ký ứng dụng trong Edge, như mô tả trong các phần sau. Ví dụ: có thể bạn muốn đăng ký ứng dụng cho các nhóm phát triển nội bộ hoặc thay mặt cho một nhà phát triển mà không cần truy cập vào cổng thông tin của bạn.

Các phần sau đây mô tả cách đăng ký ứng dụng và quản lý khoá API bằng giao diện người dùng và API.

Khám phá trang Ứng dụng

Truy cập và khám phá trang Ứng dụng theo mô tả dưới đây.

Edge

Cách truy cập vào trang Ứng dụng bằng giao diện người dùng Edge:

  1. Đăng nhập vào apigee.com/edge.
  2. Chọn Xuất bản > Ứng dụng trong thanh điều hướng bên trái.

Trang Ứng dụng sẽ xuất hiện.

Như được đánh dấu trong hình, trang Ứng dụng cho phép bạn:

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

Cách truy cập vào trang Ứng dụng bằng giao diện người dùng Classic Edge:

  1. Đă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ý.
  2. Chọn Xuất bản > Ứng dụng dành cho nhà phát triển ở thanh điều hướng trên cùng.

Trang Ứng dụng của nhà phát triển sẽ xuất hiện.

Đăng ký ứng dụng

Bạn có thể đăng ký ứng dụng bằng một trong những phương thức sau:

Ứng dụng đã đăng ký được thêm vào:

Cách đăng ký ứng dụng trong Edge:

  1. Truy cập vào trang Ứng dụng.
  2. Nhấp vào + Ứng dụng.
  3. Chỉ định Thông tin chi tiết về ứng dụng:
    Trường Nội dung mô tả Bắt buộc?
    Tên Tên ứng dụng. Bạn không thể thay đổi tên sau khi tạo ứng dụng. Tên này được dùng trong các lệnh gọi API quản lý. Có
    Tên hiển thị Tên hiển thị của ứng dụng xuất hiện trong giao diện người dùng Quản lý Edge và cổng thông tin cho nhà phát triển. Không
    Công ty/Nhà phát triển

    Lưu ý: Apigee kết hợp không hỗ trợ các ứng dụng của công ty. Trường hợp này không áp dụng.

    Chọn Công ty hoặc Nhà phát triển, rồi chọn tên công ty hoặc tên nhà phát triển trong trình đơn thả xuống.
    Lưu ý: Vì lý do hiệu suất, không phải công ty hoặc nhà phát triển nào cũng xuất hiện trong trình đơn thả xuống. Hãy nhập tên công ty, tên nhà phát triển hoặc email vào hộp tìm kiếm. Xem thêm Đăng ký dành cho nhà phát triển ứng dụng.

    		 Có
    URL callback Thường chỉ định URL của một ứng dụng được chỉ định để nhận mã uỷ quyền thay mặt cho ứng dụng khách. Giá trị này không bắt buộc đối với tất cả các sản phẩm API. Không
    Ghi chú Ghi chú mô tả cho ứng dụng. Không
  4. Chỉ định Thông tin xác thực, bao gồm cả thời hạn và trạng thái của khoá API, cũng như các sản phẩm API được liên kết.
    Trong phần Thông tin xác thực, hãy nhấp vào rồi nhập thông tin sau:
    Trường Nội dung mô tả
    Hết hạn Định cấu hình ngày hoặc khoảng thời gian hết hạn hoặc đặt khoá API thành không bao giờ hết hạn rồi nhấp vào OK.
    Sản phẩm Liên kết một hoặc nhiều sản phẩm API với khoá API:
    1. Nhấp vào Thêm sản phẩm.
    2. Chọn một hoặc nhiều sản phẩm API trong danh sách.
    3. Nhấp vào Thêm.
    4. Đặt Trạng thái thành Đã phê duyệt hoặc Đã thu hồi đối với từng sản phẩm API.
    5. Lặp lại các bước để thêm các sản phẩm API khác.
  5. Chỉ định Thuộc tính tuỳ chỉnh:
    1. Trong phần Thuộc tính tuỳ chỉnh, hãy nhấp vào .
    2. Nhập tên và giá trị.
    3. Nhấp vào Thêm hoặc Thêm và bắt đầu một giá trị khác.
      Bạn chỉ có thể thêm tối đa 18 thuộc tính tuỳ chỉnh.
  6. Nhấp vào Tạo.

Nếu sản phẩm API bạn liên kết với ứng dụng cần phải được phê duyệt theo cách thủ công đối với khoá API, hãy phê duyệt các khoá đó theo mô tả trong phần Phê duyệt hoặc thu hồi khoá API.

Xem các ứng dụng đã đăng ký cho nhà phát triển

Để xem các ứng dụng đã đăng ký cho một nhà phát triển cụ thể, hãy dùng một trong các phương thức sau:

Xem và chỉnh sửa ứng dụng

Cách xem và chỉnh sửa ứng dụng:

  1. Truy cập vào trang Ứng dụng.
  2. Nhấp vào hàng của ứng dụng mà bạn muốn xem và chỉnh sửa.
    Thông tin chi tiết về ứng dụng được hiển thị.
  3. Để chỉnh sửa ứng dụng, hãy nhấp vào Chỉnh sửa.
  4. Thực hiện một hoặc nhiều việc sau đây:
  5. Nhấp vào Lưu.

Quản lý thông tin xác thực

Khi chỉnh sửa ứng dụng, bạn có thể quản lý thông tin xác thực của ứng dụng đó trong phần Thông tin xác thực, như trong hình sau:

Như được đánh dấu trong hình trước, trong phần Thông tin xác thực, bạn có thể thực hiện các thao tác sau bằng giao diện người dùng:

Nếu bạn muốn sử dụng API này để quản lý thông tin xác thực, hãy xem các phần sau:

Xem khoá API và mã thông báo bí mật

Cách xem khoá API và mã thông báo bí mật:

  1. Truy cập vào trang Ứng dụng.
  2. Nhấp vào hàng của ứng dụng mà bạn muốn xem khoá và mã bí mật API.
  3. Trong phần Thông tin xác thực, hãy nhấp vào Hiển thị được liên kết với khoá bí mật hoặc khoá API mà bạn muốn xem.

Phê duyệt hoặc thu hồi khoá API

Các lệnh gọi API đến proxy API thường yêu cầu khoá API. Edge chỉ cho phép các lệnh gọi nếu khoá API được phê duyệt, hợp lệ và đáp ứng các điều kiện do sản phẩm API có chứa API đó xác định.

Bạn có thể định cấu hình một sản phẩm API để tự động phê duyệt khoá API, như mô tả trong phần Quản lý các sản phẩm API. Tuy nhiên, nếu sản phẩm API yêu cầu phê duyệt khoá API theo cách thủ công, thì bạn cần phê duyệt khoá theo cách thủ công.

Bạn có thể thu hồi khoá API cho tất cả hoặc một sản phẩm API. Trong trường hợp này, khoá và khoá bí mật API không hợp lệ và không thể dùng để truy cập vào API trong(các) sản phẩm API được liên kết. Bạn có thể phê duyệt lại khoá API bất cứ lúc nào.

Cách phê duyệt hoặc thu hồi khoá API:

  1. Truy cập vào trang Ứng dụng.
  2. Nhấp vào hàng của ứng dụng mà bạn muốn xem và chỉnh sửa.
  3. Nhấp vào Chỉnh sửa.
  4. Thực hiện một trong những thao tác sau:
    • Để phê duyệt hoặc thu hồi khoá API của tất cả sản phẩm API liên kết với khoá API, hãy chọn Đã phê duyệt hoặc Đã thu hồi được liên kết với khoá API đó.
    • Để phê duyệt hoặc thu hồi khoá API của một sản phẩm API cụ thể, hãy chọn Đã phê duyệt hoặc Đã thu hồi trong cột Trạng thái của sản phẩm API đó.
  5. Nhấp vào Lưu.

Quản lý sản phẩm API trong ứng dụng

Quản lý các sản phẩm API trong ứng dụng của bạn bằng cách thực hiện các nhiệm vụ sau:

Thêm sản phẩm API vào ứng dụng

Cách thêm sản phẩm API vào ứng dụng:

  1. Truy cập vào trang Ứng dụng.
  2. Nhấp vào hàng của ứng dụng mà bạn muốn xem và chỉnh sửa.
  3. Nhấp vào Chỉnh sửa.
  4. Thực hiện một trong những thao tác sau:
    • Để thêm một sản phẩm API vào khoá API mới, hãy nhấp vào để tạo thông tin xác thực mới, chọn một thử nghiệm và thêm sản phẩm API vào khoá API.
    • Để thêm một sản phẩm API vào khoá API hiện có, trong phần Thông tin xác thực, hãy nhấp vào Thêm sản phẩm và chọn sản phẩm API từ danh sách thả xuống.
  5. Nhấp vào Lưu.

Xoá sản phẩm API khỏi ứng dụng

Nếu muốn duy trì một khoá API ở trạng thái hoạt động nhưng không cho phép một sản phẩm API sử dụng khoá đó, thì bạn có thể xoá khoá đó khỏi thông tin đăng nhập được liên kết.

  1. Truy cập vào trang Ứng dụng.
  2. Nhấp vào hàng của ứng dụng mà bạn muốn xem và chỉnh sửa.
  3. Nhấp vào Chỉnh sửa.
  4. Nhấp vào bên cạnh sản phẩm API.
  5. Nhấp vào Lưu.

Bạn có thể thêm lại một sản phẩm đã xoá.

Đang tạo thông tin xác thực mới

Bạn có thể tạo thông tin xác thực mới cho ứng dụng. Ví dụ: nếu đang sử dụng tính năng xoay vòng khoá API, bạn có thể tạo khoá mới có thời hạn trùng lặp các khoá sẽ nằm ngoài phạm vi xoay vòng khi hết hạn. Bạn cũng có thể tạo khoá/khoá bí mật mới nếu tính bảo mật của khoá/khoá bí mật ban đầu bị xâm phạm. Nếu bạn tạo khoá mới, mọi khoá API hiện có sẽ tiếp tục hoạt động cho đến khi chúng hết hạn hoặc bạn thu hồi chúng một cách rõ ràng.

Cách tạo khoá API mới:

  1. Truy cập vào trang Ứng dụng.
  2. Nhấp vào hàng của ứng dụng mà bạn muốn xem và chỉnh sửa.
  3. Nhấp vào Chỉnh sửa.
  4. Trong phần Thông tin xác thực, hãy nhấp vào .
  5. Chỉ định thời hạn, thêm sản phẩm API và đặt trạng thái của các sản phẩm đó.
  6. Nếu cần, hãy revoke mọi khoá API khác (nếu cần).
  7. Nhấp vào Lưu.

Phê duyệt hoặc thu hồi ứng dụng

Phê duyệt hoặc thu hồi ứng dụng, như mô tả dưới đây. Khi thu hồi một ứng dụng, bạn sẽ không thể dùng mọi khoá API đã phê duyệt trong các lệnh gọi API đến Edge nữa. Khi phê duyệt lại một ứng dụng, bạn có thể dùng tất cả các khoá API hợp lệ và đã được phê duyệt để thực hiện lệnh gọi API.

Nếu ứng dụng được đăng ký ở các tổ chức khác, thì bạn phải thu hồi ứng dụng ở từng tổ chức đó. Có thể mất vài phút để tất cả trình xử lý thư nhận dạng được những thay đổi này.

Cách phê duyệt hoặc thu hồi ứng dụng:

  1. Truy cập vào trang Ứng dụng.
  2. Nhấp vào hàng của ứng dụng mà bạn muốn xem và chỉnh sửa.
  3. Nhấp vào Chỉnh sửa.
  4. Chọn Phê duyệt hoặc Thu hồi trong trường Trạng thái ứng dụng để phê duyệt hoặc thu hồi ứng dụng tương ứng.
  5. Nhấp vào Lưu.

Xoá ứng dụng

Khi bạn xoá một ứng dụng, tất cả các khoá ứng dụng khách liên kết với ứng dụng đó sẽ không còn hợp lệ. Việc sử dụng khoá không hợp lệ trong một yêu cầu sẽ khiến yêu cầu đó không thành công.

Nếu bạn cho rằng mình muốn khôi phục một ứng dụng của nhà phát triển trong tương lai, thì giải pháp thay thế cho việc xoá là thu hồi ứng dụng.

Cách xoá ứng dụng:

  1. Truy cập vào trang Ứng dụng.
  2. Đặt con trỏ vào hàng của ứng dụng mà bạn muốn xoá.
  3. Nhấp vào trong cột hành động.

Lưu ý: Khi dùng Apigee Edge for Public Cloud, ứng dụng của nhà phát triển và các cấu phần phần mềm liên quan sẽ bị xoá không đồng bộ. Ứng dụng của nhà phát triển sẽ bị xoá ngay lập tức, nhưng các tài nguyên liên quan đến ứng dụng của nhà phát triển đó, chẳng hạn như khoá ứng dụng hoặc mã truy cập, có thể mất từ vài giây đến vài phút để tự động bị xoá.

Đăng ký ứng dụng và quản lý khoá API bằng API

Để đăng ký và quản lý ứng dụng bằng API này, hãy xem phần Đăng ký ứng dụng dành cho nhà phát triển. Ngoài ra, hãy xem các phần sau trong tài liệu tham khảo API:

Hãy xem thêm phần Nhập các khoá bí mật và khoá người dùng hiện có.