Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về
Apigee X. thông tin
Apigee Edge cung cấp một cổng thông tin tích hợp, dễ sử dụng để ghi lại và quản lý quyền truy cập vào các API, đồng thời phát triển cộng đồng nhà phát triển ứng dụng của bạn.
Tất cả người dùng Apigee Edge đều có quyền truy cập vào các công cụ phát triển cổng thông tin tích hợp, cho phép họ nhanh chóng xây dựng cổng thông tin của riêng mình, qua đó cung cấp một giải pháp thay thế cho việc phát triển cổng thông tin dựa trên Drupal. Để so sánh tính năng, hãy xem phần So sánh các tính năng trên cổng thông tin dành cho nhà phát triển.
Xem video ngắn này để biết cách xây dựng và xuất bản cổng thông tin tích hợp của bạn.
Các tính năng và lợi ích chính
Cổng thông tin tích hợp mang đến cho bạn các tính năng và lợi ích chính sau đây:| Tính năng | Lợi ích |
|---|---|
| Phát triển nội dung cổng thông tin | Phát triển nội dung cổng thông tin của bạn nhanh chóng và dễ dàng.
|
| Giao diện cổng thông tin | Tuỳ chỉnh toàn bộ giao diện của cổng thông tin bằng biểu định kiểu SCSS và thương hiệu được cá nhân hoá. |
| Tài liệu API | Tự động tạo tài liệu tham khảo API dựa trên Thông số kỹ thuật OpenAPI của bạn. |
| Đăng ký tự phục vụ | Cung cấp dịch vụ đăng ký tự phục vụ cho nhà phát triển để tạo ứng dụng bằng API của bạn. |
| Quản lý đối tượng | Kiểm soát những người có thể truy cập vào nội dung và API của cổng thông tin |
| Số liệu phân tích | Định cấu hình Google Analytics và tính năng theo dõi Analytics tuỳ chỉnh. |
| Chế độ tuỳ chỉnh nâng cao | Thực hiện các tuỳ chỉnh nâng cao cổng thông tin, bao gồm:
|
Bắt đầu xây dựng cổng
Cách Apigee xử lý vấn đề bảo mật trong cổng thông tin tích hợp
Bảng sau đây mô tả cách Apigee xử lý vấn đề bảo mật thông qua các tính năng tích hợp sẵn trong cổng thông tin tích hợp.
| Tính năng | Địa chỉ |
|---|---|
| Yêu cầu giao thức HTTPS và bảo mật tầng truyền tải (TLS) | Thực thi hoạt động giao tiếp được mã hoá |
Bao gồm cả gói đăng ký miền apigee.io có Danh sách hậu tố công khai
|
Không cho phép đặt "supercookie" trên các miền con của apigee.io
|
| Hỗ trợ cấu hình Chính sách bảo mật nội dung (CSP) | Bảo vệ bạn khỏi các cuộc tấn công chèn tập lệnh trên nhiều trang web (XSS) và các cuộc tấn công chèn mã khác |
Yêu cầu:
|
Bảo vệ chống lại các cuộc tấn công HTML, SQL hoặc chèn phần phụ trợ |
Bao gồm tiêu đề XSS x-content-type-options: nosniff
|
Không cho phép các trình duyệt cố gắng đoán loại MIME |
Bao gồm tiêu đề XSS x-frame-options: deny
|
Không cho phép nhúng nội dung cổng thông tin vào iFrame |
Bao gồm tiêu đề XSS x-xss-protection: 1
|
Không cho phép các trang tải khi những trang này phát hiện thấy các cuộc tấn công tập lệnh trên nhiều trang web (XSS) được phản ánh |
| Sử dụng mã thông báo CSRF | Bảo vệ chống lại hành vi giả mạo yêu cầu trên nhiều trang web |
Tận dụng:
|
Bảo vệ dữ liệu khách hàng |
Cách cổng thông tin tích hợp giao tiếp với Edge
Phần lớn thông tin mà cổng thông tin dành cho nhà phát triển sử dụng đều được lưu trữ trên Apigee Edge. Cổng hoạt động như một máy khách của Edge. Khi cần, cổng thông tin dành cho nhà phát triển sẽ gửi yêu cầu HTTP hoặc HTTPS REST để truy xuất thông tin từ hoặc gửi thông tin đến Edge. Ví dụ: khi người dùng cổng thông tin đăng ký một ứng dụng mới trên cổng thông tin, cổng thông tin sẽ gửi yêu cầu đến Edge để lưu trữ thông tin về ứng dụng.
Các mục sau đây sẽ cung cấp thêm thông tin chi tiết.
Nơi lưu trữ gói đăng ký ứng dụng và khoá API
Khi người dùng hoàn tất quy trình đăng ký ứng dụng trên cổng thông tin tích hợp, cổng thông tin sẽ gửi thông tin về ứng dụng cho Apigee Edge, bao gồm cả tên ứng dụng và các sản phẩm API liên kết với ứng dụng. Nếu Edge đăng ký ứng dụng thành công, Edge sẽ trả về một khoá API duy nhất cho cổng thông tin. Người dùng cổng thông tin sử dụng khoá API đó để truy cập các sản phẩm API được liên kết với ứng dụng.
Thông tin về các ứng dụng và khoá API chỉ được lưu trữ trên Edge chứ không được lưu trữ trên cổng thông tin. Khi người dùng cổng thông tin sử dụng cổng thông tin để xem thông tin về ứng dụng, chẳng hạn như thông qua trang Ứng dụng của tôi, cổng thông tin sẽ gửi yêu cầu tới Edge bằng khóa API để truy cập thông tin.
Tương tự, khi người dùng thêm, xoá hoặc sửa đổi ứng dụng, cổng thông tin sẽ gửi nội dung sửa đổi đến Edge để lưu trữ.
Vì tất cả thông tin về ứng dụng và khoá API đều được lưu trữ trên Edge, nên quản trị viên Edge có thể sửa đổi thông tin này bằng cách sử dụng API quản lý hoặc Giao diện người dùng Edge. Ví dụ: quản trị viên có thể:
- Thêm, xoá hoặc sửa đổi ứng dụng của nhà phát triển
- Phê duyệt hoặc thu hồi khoá API đối với ứng dụng của nhà phát triển
Để biết thêm thông tin, hãy xem phần Đăng ký ứng dụng và quản lý khoá API.
Nơi lưu trữ thông tin tài khoản nhà phát triển ứng dụng
Thông tin tài khoản nhà phát triển được lưu trữ trên Edge như sau:
- Khi người dùng sử dụng nhà cung cấp danh tính tích hợp sẵn, khi người dùng cổng thông tin tạo tài khoản, thông tin sẽ được lưu trữ trong nhà cung cấp danh tính và hiển thị trên trang Người dùng.
- Khi sử dụng nhà cung cấp danh tính SAML, khi người dùng cổng thông tin đăng nhập vào cổng, bản ghi bóng (shadow) về thông tin sẽ được lưu trữ trong nhà cung cấp danh tính và hiển thị trên trang Người dùng.
- Sau khi người dùng cổng thông tin đăng ký ứng dụng của nhà phát triển, thông tin tài khoản người dùng sẽ được đồng bộ hoá và xuất hiện trên Edge tại Trang dành cho nhà phát triển.
Thông tin tài khoản người dùng sau đây được lưu trữ trên Edge:
- Họ và tên
- Địa chỉ email
- Tên người dùng
- Trạng thái tài khoản cổng (đang hoạt động hoặc không hoạt động)
- Vai trò trên cổng (người dùng xác thực, quản trị viên, người khác)
- Quyền dựa trên vai trò
- Nhóm mà người dùng cổng thông tin là thành viên (nếu bạn đã đăng ký bản phát hành beta của tính năng nhóm)
Địa chỉ email là khoá chính mà Edge sử dụng để xác định nhà phát triển và mỗi địa chỉ phải là duy nhất. Từ khoá chính, Edge tạo một mã nhà phát triển duy nhất cho mỗi tổ chức chứa nhà phát triển.
Để biết thêm thông tin, hãy xem phần Đăng ký cho nhà phát triển ứng dụng.
Nơi lưu trữ thông tin về nhóm nhà phát triển (beta)
Khi người dùng cổng thông tin tạo nhóm nhà phát triển trên cổng, thông tin về nhóm nhà phát triển được lưu trữ trên Edge, bao gồm:
- Tên và nội dung mô tả về nhóm nhà phát triển
- Thành viên trong nhóm nhà phát triển và vai trò của họ
- Ứng dụng mà nhóm nhà phát triển đã chỉ định
- Đối tượng được chỉ định cho nhóm nhà phát triển
- Thời gian tạo nhóm nhà phát triển
Một địa chỉ email duy nhất được tạo tự động sẽ được tạo cho nhóm nhà phát triển và đóng vai trò là khoá chính mà Edge dùng để xác định nhóm nhà phát triển.
Để biết thêm thông tin, hãy xem phần 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 (bản beta) và Quản lý nhóm nhà phát triển.
Giới thiệu về cổng thông tin mẫu
Khi bạn tạo một cổng thông tin mới, hệ thống sẽ cung cấp một nhóm các trang dành cho người mới bắt đầu để bạn sử dụng làm điểm bắt đầu. Các trang khởi đầu chứa nội dung minh hoạ để giúp bạn có cảm hứng phát triển cổng thông tin của riêng mình bằng cách thay thế văn bản và hình ảnh bằng nội dung độc đáo. Giao diện mẫu cổng thông tin sử dụng giao diện Material Design và SCSS.
Sau đây là trang chủ của cổng thông tin mẫu.
Các trang bắt đầu do cổng thông tin mẫu cung cấp bao gồm:
| Trang | Nội dung mô tả |
|---|---|
| Trang chủ | Trang chủ cổng mô tả các API được hiển thị. Đóng vai trò là trang chủ mặc định cho cổng thông tin của bạn (index.html). Minh hoạ việc sử dụng các thành phần vật liệu góc, như mô tả trong bài viết Thêm thành phần vật liệu góc. |
| Bắt đầu nhanh | Tập hợp các bước bắt đầu nhanh minh hoạ cách tuỳ chỉnh cổng thông tin. Nhấp vào Bắt đầu nhanh trong cổng mẫu để thực hiện bước thêm nội dung vào trang Bắt đầu. |
| Bắt đầu | Trang nội dung mẫu. Xem trang Bắt đầu trong cổng thông tin mẫu để tìm hiểu cách chỉnh sửa trang này và thêm trang vào thanh điều hướng trên cùng. |
| API | Danh sách API hiện có. Khi bạn tạo tài liệu tham khảo API có tính tương tác, các đường liên kết đến nội dung sẽ tự động được thêm vào trang này. Lưu ý: Nội dung của trang này được tạo tự động dựa trên các API mà bạn xuất bản lên cổng thông tin của mình. Bạn không thể chỉnh sửa trực tiếp nội dung của trang này; trang không xuất hiện trong danh sách trang. Bạn có thể sửa đổi kiểu của trang bằng trình chỉnh sửa giao diện của cổng thông tin. |
| Ứng dụng của tôi | Danh sách ứng dụng đã đăng ký cho người dùng được uỷ quyền. Xem Cách người dùng cổng thông tin tương tác với cổng của bạn. Lưu ý: Nội dung của trang này được tạo tự động dựa trên ứng dụng của người dùng đã đăng ký. Bạn không thể chỉnh sửa trực tiếp nội dung của trang; trang không xuất hiện trong danh sách trang. Bạn có thể sửa đổi kiểu của trang bằng trình chỉnh sửa giao diện. |
| Đăng nhập | Trang đăng nhập dành cho người dùng đã đăng ký. Người dùng mới có thể đăng ký trên trang này bằng cách nhấp vào Đăng nhập. Xem Cách người dùng cổng tương tác với cổng của bạn. Lưu ý: Trang Đăng nhập sẽ tự động được đưa vào cổng của bạn. Bạn có thể tuỳ chỉnh biểu trưng trên trang Đăng nhập và thêm các trường đăng ký tuỳ chỉnh vào trang Tạo tài khoản. Bạn không thể chỉnh sửa trực tiếp nội dung của trang; trang không xuất hiện trong danh sách trang. |
| Điều khoản và điều kiện | Trang điều khoản và điều kiện mẫu. |
Hỗ trợ trình duyệt
Cổng thông tin tích hợp Apigee hỗ trợ các phiên bản trình duyệt giống như Apigee Edge.