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