Cách người dùng cổng thông tin tương tác với cổng thông tin của bạn

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 lập tức, cổng thông tin dành cho nhà phát triển cho phép người dùng cổng thông tin của bạn tạo tài khoản người dùng, đăng nhập và quản lý những ứng dụng sẽ sử dụng API của bạn.

Các phần sau mô tả cách người dùng cổng thông tin tương tác với cổng của bạn.

Đăng nhập vào cổng

Các phần sau mô tả cách người dùng cổng đăng nhập vào cổng thông tin tích hợp bằng cách sử dụng thông tin đăng nhập của người dùng (nhà cung cấp danh tính tích hợp sẵn) hoặc sử dụng SAML (beta).

Nếu bạn bật cả nhà cung cấp danh tính tích hợp sẵn và nhà cung cấp danh tính SAML, thì người dùng cổng thông tin sẽ có thể chọn phương thức đăng nhập mà họ ưu tiên.

Đăng nhập vào cổng thông tin bằng thông tin đăng nhập của người dùng (nhà cung cấp danh tính tích hợp sẵn)

Khi bạn bật nhà cung cấp danh tính tích hợp, người dùng cổng thông tin có thể đăng nhập vào cổng thông tin tích hợp bằng thông tin đăng nhập người dùng của họ (tên người dùng và mật khẩu), như được mô tả trong các phần sau:

Tạo tài khoản người dùng trên cổng thông tin tích hợp

Với nhà cung cấp danh tính tích hợp sẵn, trước khi người dùng cổng thông tin có thể sử dụng API của bạn, họ phải tạo tài khoản người dùng trên cổng thông tin tích hợp.

Người dùng cổng tạo một tài khoản người dùng trên cổng thông tin tích hợp như sau:

  1. Chuyển đến cổng thông tin.

  2. Nhấp vào Đăng nhập.

    Trang Đăng nhập sẽ xuất hiện.

  3. Nhấp vào phần Tạo tài khoản.

    Trang Tạo tài khoản của bạn sẽ xuất hiện.

    Hộp thoại tạo tài khoản của bạn

  4. Hoàn thành biểu mẫu.

    Bạn phải nhập giá trị cho tất cả các trường bắt buộc. Mật khẩu phải có ít nhất 8 ký tự và phải chứa ít nhất một trong các loại sau: chữ số, chữ cái viết thường, chữ hoa và ký tự đặc biệt.

  5. Xem xét và đồng ý với các điều khoản.

  6. Nhấp vào Tạo tài khoản.

  7. Hoàn tất biểu mẫu CAPTCHA và nhấp vào Xác minh (nếu hiển thị).

    Tài khoản người dùng đã được tạo và hệ thống sẽ gửi một email xác nhận.

  8. Trong vòng 10 phút, hãy nhấp vào đường liên kết trong email xác nhận để hoàn tất quá trình đăng ký.

    Nếu không nhấp vào đường liên kết trong vòng 10 phút, bạn phải lặp lại các bước trong quy trình này để tạo tài khoản và được nhắc lại.

  9. Đăng nhập vào cổng thông tin tích hợp (như mô tả bên dưới).

Đăng nhập vào cổng thông tin tích hợp

Với nhà cung cấp danh tính tích hợp sẵn, sau khi người dùng cổng thông tin đăng ký trên cổng thông tin tích hợp và được phê duyệt, họ đăng nhập bằng thông tin đăng nhập của mình (tên người dùng và mật khẩu).

Người dùng cổng đăng nhập như sau:

  1. Chuyển đến cổng thông tin.
  2. Nhấp vào Đăng nhập. Trang Đăng nhập hiển thị: Trang đăng nhập
  3. Nhập địa chỉ email và mật khẩu.
  4. Nhấp vào Đăng nhập.

Thay đổi mật khẩu

Với nhà cung cấp danh tính tích hợp sẵn, người dùng cổng thông tin có thể thay đổi mật khẩu như sau:

  1. Chuyển đến cổng thông tin.
  2. Nhấp vào Đăng nhập.
  3. Nhấp vào Đặt lại mật khẩu.
  4. Nhập địa chỉ email của tài khoản cần đặt lại.

  5. Nhấp vào Gửi đường liên kết đặt lại mật khẩu.

    Chúng tôi sẽ gửi đường liên kết đặt lại mật khẩu đến email.

  6. Nhấp vào đường liên kết trong email xác nhận.

  7. Nhập mật khẩu mới và xác nhận mật khẩu đó.

    Mật khẩu phải có ít nhất 8 ký tự và phải chứa ít nhất một trong các loại sau: chữ số, chữ cái viết thường, chữ hoa và ký tự đặc biệt.

  8. Nhấp vào Tạo mật khẩu mới.

Đăng nhập vào cổng thông tin bằng cách sử dụng xác thực SAML (beta)

Khi nhà cung cấp danh tính SAML được bật, người dùng cổng thông tin sẽ đăng nhập vào cổng thông tin tích hợp bằng cách sử dụng phương thức xác thực SAML 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 nhập bằng SAML.

    Bạn sẽ được chuyển hướng đến nhà cung cấp SAML.

  4. Nếu được nhắc, hãy nhập thông tin xác thực cho nhà cung cấp danh tính SAML.

Xem tài liệu tham khảo API

Người dùng cổng thông tin có thể xem tài liệu tham khảo API mà bạn đã xuất bản lên cổng thông tin của mình như sau:

  1. Chuyển đến cổng thông tin.

  2. Nhấp vào API trong thanh điều hướng trên cùng. Trang API sẽ xuất hiện. Ví dụ:

    Trang API

  3. Lọc danh sách API theo danh mục, tiêu đề hoặc mô tả (nếu muốn) bằng các công cụ trong ngăn bên trái.

  4. Nhấp vào thẻ API để xem tài liệu tham khảo API. Tài liệu tham khảo API sẽ xuất hiện.

Người dùng cổng có thể tìm hiểu và dùng thử các API hoặc tải tài liệu được sử dụng để hiển thị tài liệu tham khảo API. Hãy xem phần Xuất bản API để biết thêm thông tin về cách hiển thị tài liệu tham khảo API.

Chia sẻ trách nhiệm đối với ứng dụng bằng cách sử dụng nhóm nhà phát triển (beta)

Nhóm nhà phát triển cho phép người dùng cổng thông tin chia sẻ trách nhiệm về ứng dụng với những người dùng cổng thông tin khác. Phần sau đây mô tả cách tạo và quản lý nhóm nhà phát triển.

Giới thiệu về các vai trò của nhóm nhà phát triển

Bảng sau đây tóm tắt các vai trò có thể được chỉ định cho thành viên trong nhóm nhà phát triển:

Role Nội dung mô tả
Quản trị viên ứng dụng
  • Đặc quyền chỉ đọc đối với thành viên nhóm nhà phát triển và thông tin chi tiết của nhóm nhà phát triển.
  • Đặc quyền đọc và ghi đối với ứng dụng.
Chủ sở hữu Toàn bộ đặc quyền đọc và ghi của các thành viên nhóm nhà phát triển, thông tin chi tiết về nhóm nhà phát triển và ứng dụng.
Người xem Đặc quyền chỉ đọc đối với thành viên nhóm nhà phát triển, thông tin chi tiết về nhóm nhà phát triển và ứng dụng.

Xem trang Nhóm

Trang Teams hiển thị các nhóm nhà phát triển mà bạn là thành viên.

Để truy cập trang Nhóm:

  1. Đăng nhập vào cổng thông tin.
  2. Chọn Nhóm từ trình đơn thả xuống tài khoản người dùng trong cổng.

Trang Nhóm hiển thị để bạn có thể:

Thêm nhóm nhà phát triển

Cách thêm nhóm nhà phát triển:

  1. Đăng nhập vào cổng thông tin.
  2. Chọn Nhóm từ trình đơn thả xuống tài khoản người dùng trong cổng.
  3. Nhấp vào + Nhóm mới.
  4. Nhập tên và nội dung mô tả.

  5. Để thêm thành viên vào nhóm nhà phát triển, hãy nhấp vào + Thêm thành viên khác, nhập địa chỉ email của người dùng cổng rồi chọn vai trò của nhóm nhà phát triển.

    Lặp lại bước trên để thêm thành viên khác.

  6. Để xoá một thành viên khỏi nhóm nhà phát triển, hãy nhấp vào dấu biểu tượng xoá bên cạnh thành viên trong nhóm nhà phát triển mà bạn muốn xoá.

  7. Nhấp vào Tạo.

Chỉnh sửa vai trò và thành viên của nhóm nhà phát triển

Cách chỉnh sửa vai trò và thành viên của nhóm nhà phát triển:

  1. Đăng nhập vào cổng thông tin.
  2. Chọn Nhóm từ trình đơn thả xuống tài khoản người dùng trong cổng.
  3. Nhấp vào hàng của nhóm nhà phát triển mà bạn muốn chỉnh sửa và là chủ sở hữu.

  4. Thực hiện một hoặc nhiều bước sau đây:

    • Chỉnh sửa tên, nội dung mô tả và người liên hệ chính.
    • Thêm hoặc xoá thành viên nhóm nhà phát triển.
    • Cập nhật vai trò của thành viên trong nhóm nhà phát triển.

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

Xoá chính bạn khỏi nhóm nhà phát triển

Cách xoá chính bạn khỏi nhóm nhà phát triển:

  1. Đăng nhập vào cổng thông tin.
  2. Chọn Nhóm từ trình đơn thả xuống tài khoản người dùng trong cổng.
  3. Nhấp vào hàng của nhóm nhà phát triển mà bạn muốn tự xoá.
  4. Nhấp vào mục Rời khỏi nhóm.

Xoá nhóm nhà phát triển

Cách xoá nhóm nhà phát triển:

  1. Đăng nhập vào cổng thông tin.
  2. Chọn Nhóm từ trình đơn thả xuống tài khoản người dùng trong cổng.
  3. Nhấp vào hàng của nhóm nhà phát triển mà bạn muốn xoá.
  4. Nhấp vào biểu tượng xoá.
  5. Nhấp vào Xác nhận để xác nhận xoá.

Đăng ký ứng dụng

Đăng ký ứng dụng dành cho nhà phát triển và ứng dụng của nhóm nhà phát triển theo mô tả trong những phần sau.

Đăng ký ứng dụng của nhà phát triển

Người dùng cổng thông tin có thể đăng ký ứng dụng để sử dụng các API mà bạn đã phát hành, như sau:

  1. Chọn Ứng dụng từ trình đơn thả xuống tài khoản người dùng.
  2. Nhấp vào + Ứng dụng mới để tạo ứng dụng mới.
  3. Nhập tên và thông tin mô tả cho ứng dụng trong hộp thoại Ứng dụng mới.

  4. Chọn chủ sở hữu Ứng dụng trong danh sách thả xuống Chủ sở hữu.

    Theo mặc định, bạn là chủ sở hữu ứng dụng. Nếu muốn, hãy chọn một nhóm nhà phát triển trong trình đơn thả xuống để chia sẻ trách nhiệm về ứng dụng với các thành viên khác trong nhóm nhà phát triển. Xem Chia sẻ trách nhiệm đối với ứng dụng bằng cách sử dụng nhóm nhà phát triển (beta).

  5. Trong phần Danh mục API, hãy chọn một hoặc nhiều API.

    Các API trong danh mục được phân loại là API đã xác thực, yêu cầu phải có URL gọi lại hoặc API công khai. Bạn phải chọn ít nhất một API để tạo ứng dụng.

  6. Nếu bạn chọn một API trong phần API đã xác thực, hãy nhập URL gọi lại.

    Để biết thêm thông tin, hãy xem bài viết Giới thiệu về URL gọi lại.

  7. Nhấp vào Tạo.

Đăng ký ứng dụng của nhóm nhà phát triển

Thành viên trong nhóm nhà phát triển có thể đăng ký ứng dụng cho nhóm nhà phát triển để sử dụng các API mà bạn đã phát hành, theo mô tả dưới đây.

Để tìm hiểu thêm về cách:

Cách đăng ký ứng dụng của nhóm nhà phát triển:

  1. Chọn Nhóm từ trình đơn thả xuống tài khoản người dùng.
  2. Nhấp vào hàng của nhóm nhà phát triển mà bạn muốn đăng ký ứng dụng.
  3. Nhấp vào + Ứng dụng mới để tạo ứng dụng mới.
  4. Nhập tên và thông tin mô tả cho ứng dụng trong hộp thoại Ứng dụng mới.

  5. Chọn chủ sở hữu Ứng dụng trong danh sách thả xuống Chủ sở hữu.

    Theo mặc định, nhóm nhà phát triển là chủ sở hữu của ứng dụng. Nếu muốn, hãy chọn một nhóm nhà phát triển khác hoặc bạn chính là chủ sở hữu trong trình đơn thả xuống.

  6. Trong phần Danh mục API, hãy chọn một hoặc nhiều API.

    Các API trong danh mục được phân loại là API đã xác thực, yêu cầu phải có URL gọi lại hoặc API công khai. Bạn phải chọn ít nhất một API để tạo ứng dụng.

  7. Nếu bạn chọn một API trong phần API đã xác thực, hãy nhập URL gọi lại.

    Để biết thêm thông tin, hãy xem bài viết Giới thiệu về URL gọi lại.

  8. Nhấp vào Tạo.

Quản lý các API trong ứng dụng

Là nhà sản xuất API, bạn phát hành API để cho phép người dùng cổng thông tin sử dụng các sản phẩm API của bạn.

Người dùng cổng thông tin quản lý việc ứng dụng của họ sử dụng API nào. Các API này sẽ được thêm vào trang chi tiết về ứng dụng. Đối với một số API, quá trình phê duyệt không tự động. Trạng thái Đang chờ phê duyệt cho biết một API mà bạn đã yêu cầu quyền truy cập nhưng chưa được cấp.

Người dùng cổng thông tin có thể quản lý API trong ứng dụng từ cổng của bạn như sau:

  1. Chọn Ứng dụng từ trình đơn thả xuống tài khoản người dùng.
  2. Nhấp vào ứng dụng trong danh sách.
  3. Trong phần API, hãy nhấp vào biểu tượng bật hoặc biểu tượng tắt để bật hoặc tắt quyền truy cập tương ứng vào một API trong ứng dụng.
  4. Đối với API đã xác thực, hãy thêm hoặc chỉnh sửa URL gọi lại (nếu cần).

Xem khoá API và mã thông báo bí mật cho một ứng dụng

Người dùng cổng thông tin có thể quản lý khoá API cho một ứng dụng từ cổng thông tin của bạn như sau:

  1. Chọn Ứng dụng từ trình đơn thả xuống tài khoản người dùng.
  2. Nhấp vào ứng dụng trong danh sách.
  3. Xem khoá API trong phần Khoá API.
  4. Xác nhận rằng trạng thái của khoá API là Đang hoạt động. Nếu khoá API của bạn yêu cầu phê duyệt và chưa được phê duyệt, thì trạng thái sẽ hiển thị là Đang chờ phê duyệt.
  5. Nhấp vào Hiện khoá bí mật để xem khoá bí mật.
  6. Đặt con trỏ lên khoá API hoặc khoá bí mật rồi nhấp vào biểu tượng xoá để sao chép vào bảng nhớ tạm.

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

Người dùng cổng thông tin có thể xoay vòng khoá API của ứng dụng theo định kỳ hoặc để ứng phó với nguy cơ rò rỉ hoặc bị xâm phạm. Khi người dùng cổng thông tin xoay vòng khoá API, một khoá API mới sẽ được tạo có quyền API giống với khoá ban đầu. Khoá API ban đầu vẫn hoạt động trong khi bạn chuyển đổi không sử dụng được. Bạn phải thu hồi khoá API cũ để ngăn thông tin xác thực của khoá đó được chấp nhận, như mô tả trong phần Thu hồi khoá API của ứng dụng.

Người dùng cổng thông tin có thể xoay vòng khoá API cho một ứng dụng từ cổng thông tin của bạn như sau:

  1. Chọn Ứng dụng từ trình đơn thả xuống tài khoản người dùng.
  2. Nhấp vào ứng dụng trong danh sách.
  3. Trong phần Khoá API, hãy nhấp vào Add Key (Thêm khoá).
  4. Nhấp vào Xác nhận trong hộp thoại để xác nhận hoạt động.
  5. Thu hồi khoá API cũ (không bắt buộc) như mô tả bên dưới.

Thu hồi khoá API của ứng dụng

Khi người dùng cổng thông tin xoay vòng khoá API, như đã mô tả trong phần trước, khoá API đó vẫn hoạt động trong khi bạn chuyển sang không sử dụng khoá đó nữa. Bạn phải thu hồi một khoá API để ngăn thông tin xác thực của khoá đó được chấp nhận.

Người dùng cổng thông tin có thể thu hồi khoá API của một ứng dụng từ cổng thông tin của bạn như sau:

  1. Chọn Ứng dụng từ trình đơn thả xuống tài khoản người dùng.
  2. Nhấp vào tên ứng dụng.
  3. Trong phần Khoá API, hãy nhấp vào biểu tượng thu hồi trong cột Hành động liên kết với khoá API mà bạn muốn thu hồi.

  4. Nhấp vào Xác nhận để xác nhận hoạt động.

    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

Người dùng cổng thông tin có thể chỉnh sửa chi tiết ứng dụng như sau:

  1. Chọn Ứng dụng từ trình đơn thả xuống tài khoản người dùng.
  2. Nhấp vào ứng dụng trong danh sách.
  3. Chỉnh sửa trường Tên hoặc Mô tả trên thẻ Chi tiết ứng dụng.
  4. Quản lý API trong ứng dụng theo yêu cầu.
  5. Nhấp vào Lưu.

Xóa ứng dụng

Người dùng cổng có thể xoá ứng dụng khỏi cổng thông tin của bạn như sau:

  1. Chọn Ứng dụng từ trình đơn thả xuống tài khoản người dùng.
  2. Nhấp vào ứng dụng trong danh sách.
  3. Nhấp vào XOÁ.
  4. Nhấp vào Xác nhận để xác nhận hoạt động.

Ứng dụng sẽ bị xoá và loại bỏ khỏi danh sách Ứng dụng.