Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào
tài liệu Apigee X. thông tin
Ngay khi xuất xưởng, cổng thông tin cho nhà phát triển cho phép nhà phát triển ứng dụng của bạn đă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 tùy chỉnh _apiportal trong Edge.
Khi nhà phát triển tự đăng ký, thuộc tính tùy 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":{}}
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 tùy 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 tùy 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 các API của bạn, nhà phát triển ứng dụng phải đăng ký bằng cách tạo một tài khoản.
Khi một nhà phát triển ứng dụng đăng ký với cổng thông tin của bạn:
- Thông tin về nhà phát triển ứng dụng được tạo và lưu trữ trên Edge. Xem phần Nơi lưu trữ thông tin tài khoản nhà phát triển.
- Nhà phát triển ứng dụng xuất hiện trong danh sách nhà phát triển ứng dụng đã đăng ký. Xem phần Khám phá trang dành cho nhà phát triển.
Ngoài ra, bạn có thể đăng ký nhà phát triển ứng dụng thay cho họ bằ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:
- Chuyển đến cổng thông tin.
- Nhấp vào Đăng nhập.
Nhấp vào Đăng ký.
Hộp thoại sau đây sẽ xuất hiện.
Nhập thông tin bắt buộc (họ, tên và địa chỉ email).
Nhấp vào Tạo.
Hộp thoại sau đây sẽ xuất hiện.
Nhấp vào đường liên kết bảo mật trong email để mở cổng thông tin và thiết lập phiên được xác thực.
Đăng nhập vào cổng thông tin
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 một khoá bí mật dùng chung như mật khẩu để xác thực nhà phát triển, một đường liên kết bảo mật sẽ được gửi để xác minh danh tính và thiết lập một 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 theo các bước sau:
- Chuyển đến cổng thông tin.
- Nhấp vào Đăng nhập.
- Nhập địa chỉ email liên kết với tài khoản.
Nhấp vào Đăng nhập.
Hộp thoại sau đây sẽ xuất hiện.
Nhấp vào đường liên kết bảo mật trong email để mở cổng thông tin và thiết lập phiên được 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 đã xuất bản, như sau:
- Chọn Ứng dụng của tôi trong trình đơn thả xuống của người dùng.
- Nhấp vào + Ứng dụng để tạo một ứng dụng mới.
- Nhập tên và nội dung mô tả cho ứng dụng trong hộp thoại Tạo ứng dụng.
- Nhấp vào Tạo.
- 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 một ứ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 sẽ được thêm vào trang thông tin 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 mà bạn đã yêu cầu cấp 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 một ứng dụng trên cổng thông tin của bạn, như sau:
- Chọn Ứng dụng của tôi trong trình đơn thả xuống của người dùng.
- Nhấp vào tên của ứng dụng.
- Nhấp vào Quản lý sản phẩm.
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 vô hiệu hoá quyền truy cập vào một sản phẩm API chỉ ở chế độ 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.
Nhấp vào Yêu cầu để yêu cầu phê duyệt cho một sản phẩm API chưa được phép.
Nhấp vào Lưu.
Xem khoá API của 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 theo cách sau:
- Chọn Ứng dụng của tôi trong trình đơn thả xuống của người dùng.
- Nhấp vào tên của ứng dụng.
- Xem khoá API trong phần Khoá.
- Nhấp vào Xem mã thông báo bí mật để hiển thị mã thông báo bí mật của khoá API.
- 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 khoá API của ứng dụng theo định kỳ hoặc để ứng phó với trường hợp rò rỉ hoặc xâm nhập 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 đối với 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 để không sử dụng khoá này nữa. Bạn phải huỷ kích hoạt mộ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ư mô tả trong phần Huỷ kích hoạt khoá API cho một ứng dụng.
Nhà phát triển ứng dụng có thể xoay khoá API chính cho một ứng dụng trên cổng thông tin của bạn, như sau:
- Chọn Ứng dụng của tôi trong trình đơn thả xuống của người dùng.
- Nhấp vào tên của ứng dụng.
- Trong mục Khoá, hãy di chuyển con trỏ lên khoá API hiện tại để trình đơn thao tác xuất hiện.
- Nhấp vào biểu tượng
để mở rộng trình đơn thao tác. - Nhấp vào Xoay.
- Nhấp vào Tạo trong hộp thoại để xác nhận thao tác.
- Bạn có thể tắt khoá API (không bắt buộc) như mô tả bên dưới.
Huỷ kích hoạt khoá API cho một ứng dụng
Khi nhà phát triển ứng dụng xoay khoá API (như mô tả trong phần trước), khoá API sẽ được đánh dấu là không được dùng nữa, nhưng vẫn hoạt động trong khi bạn chuyển đổi khoá đó ra khỏi trạng thái sử dụng. Bạn phải huỷ kích hoạt một khoá không dùng nữa để ngăn thông tin đăng nhập 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:
- Chọn Ứng dụng của tôi trong trình đơn thả xuống của người dùng.
- Nhấp vào tên của ứng dụng.
- Trong phần Khoá, hãy nhấp vào Nhật ký khoá để hiển thị danh sách các khoá không dùng nữa.
- Di chuyển con trỏ lên khoá API không dùng nữa mà bạn muốn huỷ kích hoạt để trình đơn thao tác xuất hiện.
- Nhấp vào biểu tượng để mở rộng trình đơn thao tác.
- Nhấp vào Huỷ kích hoạt.
- 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 chi tiết ứng dụng
Nhà phát triển ứng dụng có thể chỉnh sửa chi tiết ứng dụng theo cách sau:
- Chọn Ứng dụng của tôi trong trình đơn thả xuống của người dùng.
- Nhấp vào tên của ứng dụng.
- Chỉnh sửa các trường Tên hoặc Nội dung mô tả.
- Nhấp vào Lưu.
Ứng dụng sẽ bị xoá và loại bỏ 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 theo các bước sau:
- Chọn Ứng dụng của tôi trong trình đơn thả xuống của người dùng.
- Nhấp vào tên của ứng dụng.
- Nhấp vào xoá ở góc trên bên phải của trang.
Ứng dụng sẽ bị xoá và loại bỏ khỏi danh sách Ứng dụng của tôi.