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ày càng có nhiều người dùng cổng thông tin dành cho nhà phát triển có tính năng xuất bản qua mạng xã hội để giao tiếp với cộng đồng nhà phát triển. Quy định này áp dụng cho việc truyền đạt nội dung tĩnh, chẳng hạn như tài liệu về API và điều khoản sử dụng, cũng như nội dung linh động do cộng đồng đóng góp như blog và diễn đàn.
Là một nhà cung cấp API, bạn cần có một cách để hiển thị API của mình, hướng dẫn nhà phát triển về API, đăng ký cho nhà phát triển và cho phép nhà phát triển đăng ký ứng dụng. Việc hiển thị API cho nhà phát triển chỉ là một phần trong việc tạo ra một cộng đồng thực sự năng động. Bạn cũng cần có một phương thức để cộng đồng nhà phát triển chia sẻ ý kiến phản hồi, đưa ra yêu cầu hỗ trợ và yêu cầu về tính năng, đồng thời gửi nội dung của riêng họ mà những nhà phát triển khác có thể truy cập.
Apigee Edge cung cấp cho bạn một cổng Dịch vụ dành cho nhà phát triển. Bạn có thể sử dụng cổng này để xây dựng và ra mắt trang web được tuỳ chỉnh của riêng mình nhằm cung cấp tất cả các dịch vụ này cho cộng đồng phát triển của bạn. Mọi khách hàng của Edge đều có thể tạo cổng thông tin cho nhà phát triển của riêng mình trên đám mây hoặc tại cơ sở hạ tầng riêng.
Video sau đây xin giới thiệu cổng thông tin Dịch vụ dành cho nhà phát triển Apigee.
Hình sau đây cho thấy trang chủ của cổng thông tin mặc định dành cho nhà phát triển:
Về cơ bản, cổng thông tin cho nhà phát triển là một hệ thống quản lý nội dung (CMS) dựa trên dự án nguồn mở Drupal (http://www.drupal.org). Drupal cung cấp một bộ tính năng cốt lõi dưới dạng các mô-đun giúp bạn dễ dàng xây dựng nội dung cũng như quản lý trang web.
Ngay từ đầu, cổng thông tin dành cho nhà phát triển cho phép bạn tạo tài liệu về API, hỗ trợ viết blog và cung cấp các diễn đàn theo chuỗi. Bạn cũng có thể tuỳ chỉnh cổng thông tin dành cho nhà phát triển để đáp ứng các yêu cầu cụ thể của mình. Tuỳ chỉnh cho phép bạn sửa đổi giao diện của cổng thông tin cũng như cách mà nhà phát triển tương tác với cổng thông tin.
Bạn có thể sử dụng trình đơn Drupal để tuỳ chỉnh hầu hết. Nếu bạn đăng nhập vào cổng thông tin với tư cách là người dùng có đặc quyền của quản trị viên, thì trình đơn Drupal sẽ xuất hiện ở đầu mỗi trang cổng thông tin:
Quản trị viên kiểm soát quy trình nhà phát triển yêu cầu quyền truy cập vào cổng thông tin, cách nhà phát triển đăng ký ứng dụng có quyền truy cập vào API của bạn, cách bạn chỉ định vai trò và quyền cụ thể liên quan đến API của nhà phát triển, cũng như thời điểm thu hồi quyền truy cập của nhà phát triển vào API.
Bạn cũng có thể sử dụng cổng thông tin dành cho nhà phát triển để định cấu hình và kiểm soát hoạt động kiếm tiền. Tính năng kiếm tiền cho phép nhà phát triển tự truy cập vào các mục Thanh toán và báo cáo, Danh mục và kế hoạch, cũng như các chế độ cài đặt dành riêng cho hoạt động kiếm tiền thông qua cổng thông tin dành cho nhà phát triển.
Kiểu người dùng cổng thông tin
Hình ảnh sau đây cho thấy hai kiểu người dùng cổng thông tin:
- Nhà phát triển tạo thành cộng đồng người dùng xây dựng ứng dụng bằng cách sử dụng API của bạn. Nhà phát triển ứng dụng dùng cổng thông tin để tìm hiểu về API của bạn thông qua SmartDocs, đăng ký tài khoản trên cổng thông tin, đăng ký ứng dụng sử dụng API của bạn, để tương tác với cộng đồng nhà phát triển và để xem thông tin thống kê về việc sử dụng ứng dụng của họ trên trang tổng quan.
-
Nhóm API là nhà cung cấp API tạo nội dung cổng thông tin, cung cấp API của họ cho nhà phát triển ứng dụng, cung cấp tài liệu về API và đưa ra cơ chế để nhà phát triển đăng ký ứng dụng và lấy khoá API. Nhóm API sẽ tiến hành định cấu hình cơ bản cho cổng thông tin dành cho nhà phát triển để:
- Định cấu hình yêu cầu tự động hoặc thủ công cho khoá API
- Duy trì tài liệu về API, diễn đàn và blog, đồng thời tuỳ ý sửa đổi tất cả thay đổi
- Xử lý bình luận của người dùng và việc kiểm duyệt diễn đàn
- Thực thi biện pháp Kiểm soát quyền truy cập dựa trên vai trò (RBAC) để kiểm soát quyền truy cập vào các tính năng trên cổng thông tin. Ví dụ: quản trị viên có thể bật các chế độ kiểm soát để cho phép người dùng đã đăng ký tạo bài đăng trên diễn đàn hoặc dùng bảng điều khiển kiểm thử
- Tuỳ chỉnh thông báo qua email cho cả quản trị viên và nhà phát triển để tạo và phê duyệt người dùng
- Tuỳ chỉnh biểu mẫu web, chẳng hạn như các trang "liên hệ với chúng tôi"
Không thể hiện trong hình này là một kiểu người dùng cổng thông tin thứ ba – người quản lý sản phẩm API. Nhà quản lý sản phẩm API chịu trách nhiệm xác định cách nhóm API xây dựng cổng thông tin, bao gồm:
- Xác định cách API được đóng gói vào sản phẩm
- Xác định quy tắc phê duyệt ứng dụng
- Nếu tính năng Kiếm tiền được bật trên cổng thông tin, hãy xác định giá và gói thanh toán cho các sản phẩm API. Để biết thêm thông tin về hoạt động Kiếm tiền, hãy xem bài viết Tổng quan về hoạt động kiếm tiền.
Tuỳ chỉnh cổng thông tin dành cho nhà phát triển
Là một nhà cung cấp API, hãy cân nhắc cách tuỳ chỉnh cổng thông tin cho nhà phát triển cho phù hợp nhất với API của bạn và cung cấp thông tin cần thiết để cộng đồng nhà phát triển có thể sử dụng API của bạn. Một số điểm cần cân nhắc đối với cổng thông tin tuỳ chỉnh của bạn bao gồm:
- Dễ dàng truy cập vào các API
- Tài liệu, chẳng hạn như tài liệu hướng dẫn và tài liệu tham khảo
- Nội dung do cộng đồng đóng góp như blog và diễn đàn thảo luận
- Mã mẫu
- Quy trình đăng ký dễ dàng, trong đó nhà phát triển, ứng dụng và API mới có thể được phê duyệt một cách nhanh chóng
- Quyền và thông tin đăng nhập được quản lý
- Kiểm soát quyền truy cập theo tầng
- Giao diện phù hợp với tổ chức của bạn
Cổng thông tin được xác định trước với cấu hình cơ bản. Ví dụ: ngay lập tức, cổng thông tin được định cấu hình để cho phép bất kỳ ai đăng ký làm nhà phát triển, nhưng quản trị viên phải phê duyệt từng đăng ký trước khi nhà phát triển có thể đăng nhập vào cổng. Sau khi được phê duyệt đăng ký, nhà phát triển có thể đăng ký một ứng dụng để yêu cầu khoá API và sử dụng cổng thông tin để truy cập vào các tài nguyên API.
Các bước trong quy trình đăng ký mặc định là:
- Nhà phát triển đăng ký thông qua cổng thông tin dành cho nhà phát triển. Sau đó, cổng thông tin sẽ gửi email cho quản trị viên phê duyệt tài khoản.
- Quản trị viên phê duyệt tài khoản và nhà phát triển sẽ nhận được một email thông báo rằng hiện họ có thể đăng nhập.
- Nhà phát triển đăng ký ứng dụng và chọn các sản phẩm API mà ứng dụng sử dụng. Phản hồi, cổng thông tin sẽ chỉ định một khoá API duy nhất cho ứng dụng.
- Nhà phát triển truyền khoá API khi gửi yêu cầu tới API của bạn.
Trải nghiệm ngay từ đầu này có khả năng tuỳ chỉnh cao. Ví dụ: bạn có thể ghi đè lược đồ đăng ký và uỷ quyền mặc định để một nhà phát triển mới tự động được phê duyệt và đăng nhập sau khi đăng ký. Hoặc bạn có thể yêu cầu nhà phát triển chấp nhận một bộ điều khoản và điều kiện rồi mới có thể đăng nhập lần đầu tiên.
Bạn cũng có toàn quyền kiểm soát nội dung có trên cổng thông tin dành cho nhà phát triển. Ngoài ra, cổng thông tin dành cho nhà phát triển sẽ trình bày nội dung mẫu, chẳng hạn như tài liệu về API, bài đăng trên blog và các cuộc thảo luận trên diễn đàn. Bạn có thể cung cấp nội dung của riêng mình và tuỳ chỉnh giao diện của từng loại nội dung.
Để biết thêm thông tin, hãy xem bài viết Tuỳ chỉnh giao diện.
Quản trị cổng thông tin dành cho nhà phát triển
Nhà phát triển dùng cổng thông tin dành cho nhà phát triển để truy cập và sử dụng API của bạn. Quản trị viên thực hiện các thao tác quản lý tài khoản, chẳng hạn như:
- Tuỳ chỉnh quy trình đăng ký của nhà phát triển, bao gồm cả các trường đăng ký, tạo sẵn Captcha và phê duyệt tự động hoặc thủ công
- Thêm hoặc phê duyệt nhà phát triển. Theo mặc định, mọi nhà phát triển đều có thể đăng ký thông qua cổng thông tin dành cho nhà phát triển nhưng cần được quản trị viên phê duyệt thông qua giao diện người dùng Cổng thông tin cho nhà phát triển. Quản trị viên cũng có thể tạo nhà phát triển ngay trên cổng. Sau đó, cổng thông tin sẽ tự động gửi email cho nhà phát triển cho biết rằng họ đã tạo tài khoản cho họ.
- Sửa đổi tài khoản của nhà phát triển. Ví dụ: quản trị viên có thể thay đổi trạng thái tài khoản của người dùng từ đang hoạt động thành bị chặn hoặc thay đổi thông tin hồ sơ của nhà phát triển, chẳng hạn như tên công ty.
- Xoá nhà phát triển. Quản trị viên có thể vô hiệu hoá hoặc xoá tài khoản của nhà phát triển.
- Chỉ định vai trò và quyền: Quản trị viên có thể chỉ định vai trò cụ thể cho tài khoản nhà phát triển. Một vai trò liên kết với nhiều quyền, chẳng hạn như quyền tạo sách hoặc nội dung khác. Bạn cũng có thể thay đổi quyền liên quan đến một vai trò hoặc tạo vai trò mới.
Để biết thêm thông tin, hãy xem bài viết Thêm và quản lý tài khoản người dùng.
Tóm tắt các tính năng của cổng thông tin dành cho nhà phát triển
Bảng sau đây chứa tóm tắt các tính năng của cổng thông tin dành cho nhà phát triển:
| Tính năng | Thông tin chi tiết |
|---|---|
| Hỗ trợ trình duyệt |
Xem phần Phần mềm và phiên bản được hỗ trợ. |
|
Đăng ký người dùng |
|
|
Quản lý người dùng |
|
|
Giao diện cổng |
|
|
Quản lý nội dung và cộng đồng |
|
|
Quyền |
|
|
Quản lý khoá API |
|
|
|
|
|
Blog |
|
|
Các Diễn đàn |
|
|
Tài liệu |
|
|
Trình đơn |
|
|
Tìm kiếm |
|
|
Trình kiểm tra đường liên kết |
|