Cách nhà phát triển ứng dụng tương tác với cổng thông tin của bạn (phiên bản gốc)

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X.
thông tin

Ngay từ đầu, cổng thông tin dành cho nhà phát triển cho phép các nhà phát triển ứng dụng đăng ký, đăng nhập và quản lý các ứng dụng sẽ sử dụng API của bạn.

Các phần sau đây mô tả cách nhà phát triển ứng dụng tương tác với cổng thông tin của bạn:

Cách theo dõi hoạt động đăng ký và đăng nhập của nhà phát triển ứng dụng trong Edge

Hoạt động đăng ký nhà phát triển và đăng nhập vào cổng thông tin được theo dõi bằng thuộc tính tuỳ chỉnh _apiportal trong Edge.

Khi nhà phát triển tự đăng ký, thuộc tính tuỳ chỉnh _apiportal sẽ được thêm vào cấu hình nhà phát triển và trạng thái nhà phát triển được đặt thành unverified để cho biết rằng nhà phát triển chưa đăng nhập vào cổng thông tin. Ví dụ: {"status":"unverified","portals":{}}

Trong lần đầu tiên nhà phát triển đăng nhập vào một cổng thông tin, thuộc tính tuỳ chỉnh _apiportal sẽ được cập nhật để theo dõi tên cổng thông tin và thời gian truy cập, đồng thời đặt trạng thái nhà phát triển thành active. Mỗi khi nhà phát triển đăng nhập vào cổng thông tin, thuộc tính tuỳ chỉnh sẽ được cập nhật để đặt lại giá trị lastVisit (ở định dạng epoch) cho cổng thông tin đó. Ví dụ: {"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}

Đăng ký tài khoản nhà phát triển ứng dụng

Trước khi có thể sử dụng API của bạn, nhà phát triển ứng dụng phải đăng ký bằng cách tạo tài khoản.

Khi nhà phát triển ứng dụng đăng ký với cổng thông tin của bạn:

Ngoài ra, bạn có thể thay mặt nhà phát triển ứng dụng đăng ký bằng cách sử dụng giao diện người dùng Edge, như mô tả trong phần Đăng ký nhà phát triển ứng dụng.

Nhà phát triển ứng dụng mới có thể tự đăng ký với cổng thông tin của bạn như sau:

  1. Chuyển đến cổng thông tin.
  2. Nhấp vào Đăng nhập.
  3. Nhấp vào Đăng ký.
    Hộp thoại sau đây sẽ xuất hiện.

    Tạo tài khoản

  4. Nhập thông tin bắt buộc (tên, họ và địa chỉ email).

  5. Nhấp vào Tạo.
    Hộp thoại sau đây sẽ xuất hiện.

    Đăng nhập vào cổng thông tin

  6. Nhấp vào đường liên kết an toàn trong email để mở cổng thông tin và thiết lập phiên đã xác thực.

Đăng nhập vào cổng thông tin của bạn

Sau khi đăng ký với cổng thông tin của bạn, nhà phát triển ứng dụng sẽ đăng nhập bằng Trang đăng nhập.

Mỗi khi nhà phát triển ứng dụng đăng nhập vào một cổng thông tin, thay vì sử dụng khoá dùng chung như mật khẩu để xác thực nhà phát triển, một đường liên kết an toàn sẽ được gửi để xác minh danh tính và thiết lập phiên với cổng thông tin.

Nhà phát triển ứng dụng có thể đăng nhập vào cổng thông tin của bạn như sau:

  1. Chuyển đến cổng thông tin.
  2. Nhấp vào Đăng nhập.
  3. Nhập địa chỉ email liên kết với tài khoản đó.
  4. Nhấp vào Đăng nhập.
    Hộp thoại sau đây sẽ xuất hiện.

    Đăng nhập vào cổng thông tin

  5. Nhấp vào đường liên kết an toàn trong email để mở cổng thông tin và thiết lập phiên đã xác thực.

Đăng ký ứng dụng

Sau khi đăng nhập vào cổng thông tin, nhà phát triển ứng dụng có thể đăng ký ứng dụng để sử dụng các sản phẩm API mà bạn đã phát hành như sau:

  1. Chọn Ứng dụng của tôi trong trình đơn thả xuống dành cho người dùng.
  2. Nhấp vào + Ứng dụng để tạo ứng dụng mới.
  3. Nhập tên và nội dung mô tả cho ứng dụng trong hộp thoại Tạo ứng dụng.
  4. Nhấp vào Tạo.
  5. Quản lý các sản phẩm API trong ứng dụng như mô tả bên dưới.

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

Nhà phát triển ứng dụng có thể quản lý các sản phẩm API trong ứng dụng của họ. Các sản phẩm API được thêm vào trang chi tiết ứng dụng. Đối với một số sản phẩm API, việc phê duyệt không diễn ra tự động. Trạng thái Đang chờ xử lý cho biết một sản phẩm API đã được yêu cầu quyền truy cập nhưng chưa được cấp.

Nhà phát triển ứng dụng có thể quản lý các sản phẩm API trong ứng dụng từ cổng thông tin của bạn như sau:

  1. Chọn Ứng dụng của tôi trong trình đơn thả xuống dành cho người dùng.
  2. Nhấp vào tên ứng dụng.
  3. Nhấp vào Quản lý sản phẩm.
  4. Nhấp vào nút bật/tắt Quyền truy cập để bật hoặc tắt quyền truy cập vào một sản phẩm API từ ứng dụng.

    Lưu ý: Nếu nhà phát triển ứng dụng tắt quyền truy cập vào một sản phẩm API chỉ dành cho riêng tư hoặc nội bộ, thì sản phẩm API đó sẽ bị xoá khỏi ứng dụng và quản trị viên cổng thông tin phải thêm lại theo cách thủ công, như mô tả trong phần Đăng ký ứng dụng và quản lý khoá API.

  5. Nhấp vào Yêu cầu để yêu cầu phê duyệt một sản phẩm API chưa được cho phép.

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

Xem khoá API cho một ứng dụng

Nhà phát triển ứng dụng có thể quản lý khoá API cho một ứng dụng trên cổng thông tin của bạn như sau:

  1. Chọn Ứng dụng của tôi trong trình đơn thả xuống dành cho người dùng.
  2. Nhấp vào tên ứng dụng.
  3. Xem khoá API trong mục Khoá.
  4. Nhấp vào Xem khoá bí mật để hiện khoá bí mật của khoá API.
  5. Xác nhận rằng trạng thái của khoá API là Đã phê duyệt.

Xoay khoá API cho một ứng dụng

Nhà phát triển ứng dụng có thể xoay vòng khoá API của ứng dụng theo định kỳ hoặc để phản hồi một sự cố rò rỉ hoặc xâm phạm tiềm ẩn. Khi nhà phát triển ứng dụng xoay vòng khoá API, một khoá API mới sẽ được tạo với các quyền sản phẩm API giống như khoá ban đầu. Khoá API ban đầu được đánh dấu là không dùng nữa, nhưng vẫn hoạt động trong khi bạn chuyển đổi khoá đó để không sử dụng nữa. Bạn phải huỷ kích hoạt khoá không dùng nữa để không chấp nhận thông tin xác thực của khoá đó, như mô tả trong phần Huỷ kích hoạt khoá API cho ứng dụng.

Nhà phát triển ứng dụng có thể xoay vòng khoá API chính cho một ứng dụng trên cổng thông tin của bạn như sau:

  1. Chọn Ứng dụng của tôi trong trình đơn thả xuống dành cho người dùng.
  2. Nhấp vào tên ứng dụng.
  3. Trong mục Khoá, hãy đặt con trỏ lên khoá API hiện tại để hiển thị trình đơn thao tác.
  4. Nhấp vào Biểu tượng mở rộng để mở rộng trình đơn thao tác.
  5. Nhấp vào Rotate (Xoay).
  6. Nhấp vào Tạo trong hộp thoại để xác nhận thao tác.
  7. Bạn có thể tắt khoá API theo mô tả bên dưới (không bắt buộc).

Huỷ kích hoạt khoá API cho một ứng dụng

Khi nhà phát triển ứng dụng xoay vòng khoá API, như mô tả trong phần trước, khoá API sẽ được đánh dấu là không dùng nữa nhưng vẫn hoạt động trong khi bạn chuyển đổi khoá API đó sang trạng thái không dùng nữa. Bạn phải huỷ kích hoạt khoá không dùng nữa để ngăn thông tin xác thực của khoá đó được chấp nhận.

Nhà phát triển ứng dụng có thể huỷ kích hoạt khoá API cho một ứng dụng trên cổng thông tin của bạn như sau:

  1. Chọn Ứng dụng của tôi trong trình đơn thả xuống dành cho người dùng.
  2. Nhấp vào tên ứng dụng.
  3. Trong mục Khoá, hãy nhấp vào Nhật ký khoá để xem danh sách các khoá không dùng nữa.
  4. Đặt con trỏ lên khoá API không dùng nữa mà bạn muốn huỷ kích hoạt để hiển thị trình đơn thao tác.
  5. Nhấp vào Biểu tượng mở rộng để mở rộng trình đơn thao tác.
  6. Nhấp vào Hủy kích hoạt.
  7. Nhấp vào Huỷ kích hoạt để xác nhận thao tác.
    Trạng thái của khoá được cập nhật thành Đã thu hồi.

Chỉnh sửa thông tin chi tiết về ứng dụng

Nhà phát triển ứng dụng có thể chỉnh sửa thông tin chi tiết về ứng dụng như sau:

  1. Chọn Ứng dụng của tôi trong trình đơn thả xuống dành cho người dùng.
  2. Nhấp vào tên ứng dụng.
  3. Chỉnh sửa trường Tên hoặc Nội dung mô tả.
  4. Nhấp vào Lưu.

Ứng dụng sẽ bị xoá và bị xoá khỏi danh sách Ứng dụng của tôi.

Xóa ứng dụng

Nhà phát triển ứng dụng có thể xoá một ứng dụng khỏi cổng thông tin của bạn như sau:

  1. Chọn Ứng dụng của tôi trong trình đơn thả xuống dành cho người dùng.
  2. Nhấp vào tên ứng dụng.
  3. Nhấp vào xoá ở góc trên bên phải của trang.

Ứng dụng sẽ bị xoá và bị xoá khỏi danh sách Ứng dụng của tôi.