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

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

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

Giới thiệu

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

Là một nhà cung cấp API, bạn tạo một hoặc nhiều sản phẩm API để nhóm các API của mình, như được giải thích trong phần Quản lý sản phẩm API. Khi đăng ký một ứng dụng, nhà phát triển ứng dụng sẽ chọn những 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 những sản phẩm API đó. Nhà phát triển ứng dụng sẽ truyền khoá API trong mỗi lệnh gọi đến các proxy API có trong 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 một ứ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 số sản phẩm API mà ứng dụng đó tham chiếu.

Thông thường, các nhà phát triển ứng dụng đăng ký sử dụng các sản phẩm API của bạn thông 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à xuất bản sản phẩm API được mô tả trong phần Tạo 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 kiểm soát nhiều hơn quy 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ụ: bạn có thể 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 không có quyề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, như 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ư minh hoạ trong hình, trang Ứng dụng cho phép bạn:

Classic Edge (Private Cloud)

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

  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 của nhà phát triển trong 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 các phương thức sau:

Các ứng dụng đã đăng ký sẽ đượ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 Mô tả Bắt buộc?
    Tên Tên của ứ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 đến 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 dành cho nhà phát triển. Không
    Công ty/Nhà phát triển

    Lưu ý: Apigee hybrid không hỗ trợ các ứng dụng của công ty; trường 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 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. Bắt đầu 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 bài viết Đăng ký 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 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ả trạng thái và thời gian hết hạn 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 Mô tả
    Hết hạn Định cấu hình thời hạn hoặc ngày hết hạn, hoặc đặt khoá API 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 cho từng sản phẩm API.
    5. Lặp lại các bước để thêm nhiều sản phẩm API khác.
  5. Chỉ định Thuộc tính tuỳ chỉnh:
    1. Trong mục Thuộc tính tuỳ chỉnh, hãy nhấp vào biểu tượng .
    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 yêu cầu khác.
      Bạn có thể thêm tối đa 18 thuộc tính tuỳ chỉnh.
  6. Nhấp vào Tạo.

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

Xem các ứng dụng đã đăng ký cho một 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 sử 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 sẽ xuất hiện.
  3. Để chỉnh sửa một ứng dụng, hãy nhấp vào Chỉnh sửa.
  4. Thực hiện một hoặc nhiều thao tác sau:
  5. Nhấp vào Lưu.

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

Khi chỉnh sửa một ứng dụng, bạn có thể quản lý thông tin đăng nhập của ứng dụng đó trong mục Thông tin đăng nhập, như minh hoạ trong hình sau:

Như được làm nổi bật trong hình trước, trong phần Thông tin đăng nhập, bạn có thể thực hiện các thao tác sau bằng giao diện người dùng:

Để sử dụng API này nhằm quản lý thông tin xác thực, hãy xem các phần sau:

Xem khoá và khoá bí mật của API

Cách xem khoá và mã bí mật của 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 khoá API và mã bí mật.
  3. Trong phần Thông tin xác thực, hãy nhấp vào Hiện liên kết với khoá API hoặc khoá bí mật mà bạn muốn xem.

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

Các lệnh gọi API đến các proxy API thường yêu cầu có 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 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ý 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à bí mật API không hợp lệ và không thể dùng để truy cập vào các 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 các thao tác sau:
    • Để phê duyệt hoặc thu hồi khoá API cho tất cả các sản phẩm API được liên kết với một 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 cho 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ý các sản phẩm API trong một ứ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 tác vụ sau:

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

Cách thêm một 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 các thao tác sau:
    • Để thêm một sản phẩm API vào một khoá API mới, hãy nhấp vào để tạo một thông tin đăng nhập mới, chọn thời gian hết hạn 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 đăng nhập, hãy nhấp vào Thêm sản phẩm rồi chọn sản phẩm API trong danh sách thả xuống.
  5. Nhấp vào Lưu.

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

Nếu muốn giữ cho một khoá API hoạt động nhưng không cho phép một sản phẩm API sử dụng khoá đó, bạn có thể xoá khoá đó khỏi thông tin xác thực đượ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 biểu tượng 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 đã bị xoá.

Tạo thông tin xác thực mới

Bạn có thể tạo thông tin đăng nhập mới cho một ứ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 các khoá mới có thời gian hết hạn trùng với các khoá sẽ không được xoay vòng khi hết hạn. Bạn cũng có thể tạo một khoá/bí mật mới nếu tính bảo mật của khoá/bí mật ban đầu bị xâm phạm. Nếu bạn tạo một khoá mới, mọi khoá API hiện có sẽ tiếp tục hoạt động cho đến khi hết hạn hoặc bạn huỷ bỏ 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. Nêu rõ ngày hết hạn, thêm sản phẩm API và đặt trạng thái của sản phẩm.
  6. Bạn có thể thu hồi bất kỳ khoá API nào 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 quyền truy cập của một ứng dụng, như mô tả dưới đây. Khi bạn thu hồi một ứng dụng, mọi khoá API đã được phê duyệt sẽ không thể dùng trong các lệnh gọi API đến Edge nữa. Khi bạn 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ý trong các tổ chức khác, bạn phải thu hồi ứng dụng đó trong từng tổ chức. Có thể mất vài phút để tất cả các trình xử lý thông báo nhận ra các thay đổi.

Cách phê duyệt hoặc thu hồi quyền truy cập củ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.
  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.
  5. Nhấp vào Lưu.

Xoá ứng dụng

Khi bạn xoá một ứng dụng, tất cả khoá ứng dụng liên kết với ứng dụng đó sẽ không 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 cho rằng sau này bạn có thể muốn khôi phục một ứng dụng của nhà phát triển, thì bạn có thể thu hồi ứng dụng thay vì xoá.

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 biểu tượng trong cột thao tác.

Lưu ý: Với Apigee Edge cho Đám mây công cộng, việc xoá ứng dụng dành cho nhà phát triển và các cấu phần phần mềm liên quan sẽ diễn ra 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 kết với ứ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 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, hãy xem phần Đăng ký ứng dụng của nhà phát triển. Bạn cũng có thể xem các phần sau trong tài liệu tham khảo API:

Xem thêm phần Nhập khoá và bí mật hiện có của người dùng.