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