Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info
Apigee Edge предоставляет простой в использовании интегрированный портал для документирования и управления доступом к вашим API, а также для развития сообщества разработчиков приложений.
Все пользователи Apigee Edge имеют доступ к интегрированным инструментам разработки порталов, позволяющим быстро создавать собственные порталы для разработчиков, что является альтернативой разработке порталов на основе Drupal . Для сравнения функций см. «Сравнение функций порталов для разработчиков» .
Посмотрите это короткое видео, чтобы ознакомиться с процессом создания и публикации интегрированного портала.
Основные характеристики и преимущества
Интегрированный портал предоставляет вам следующие ключевые функции и преимущества:| Особенность | Преимущества |
|---|---|
| Разработка контента для портала | Разрабатывайте контент для своего портала быстро и легко.
|
| Внешний вид и интерфейс портала | Полностью настройте внешний вид своего портала, используя таблицы стилей SCSS и персонализированный фирменный стиль. |
| документация API | Автоматическая генерация справочной документации по API на основе ваших спецификаций OpenAPI. |
| Самостоятельная регистрация | Предоставьте разработчикам возможность самостоятельной регистрации для создания приложений с использованием ваших API. |
| Управление аудиторией | Контролируйте доступ к содержимому портала и API. |
| Аналитика | Настройте Google Analytics и пользовательское отслеживание аналитики. |
| Расширенные настройки | Выполняйте расширенные настройки портала, включая:
|
Начните создавать свой портал
Как Apigee решает вопросы безопасности в интегрированном портале
В таблице ниже описано, как Apigee обеспечивает безопасность с помощью встроенных функций интегрированного портала.
| Особенность | Адреса |
|---|---|
| Требуется протокол HTTPS и протокол безопасности транспортного уровня (TLS). | Обеспечивает шифрование связи |
Включает регистрацию домена apigee.io в публичном списке суффиксов. | Запрещает установку «суперкуки» на поддоменах apigee.io |
| Поддерживает настройку политики безопасности контента (CSP). | Защита от межсайтовых скриптовых атак (XSS) и других атак с внедрением кода. |
Требует:
| Защита от HTML, SQL-запросов и атак с внедрением кода в бэкэнд. |
Включает заголовок XSS x-content-type-options: nosniff | Запрещает браузерам пытаться угадывать MIME-типы. |
Включает заголовок x-frame-options: deny XSS. | Запрещает встраивание содержимого портала в iFrame. |
Включает x-xss-protection: 1 заголовок XSS | Запрещает загрузку страниц при обнаружении отраженных атак межсайтового скриптинга (XSS). |
| Использует токены CSRF | Защита от подделки межсайтовых запросов |
Рычаги воздействия:
| Защита данных клиентов |
Как интегрированный портал взаимодействует с Edge
Большая часть информации, используемой порталом разработчиков, хранится в Apigee Edge. Портал выступает в качестве клиента для Edge. При необходимости портал разработчиков отправляет REST-запросы по протоколу HTTP или HTTPS для получения информации из Edge или отправки информации в Edge. Например, когда пользователь портала регистрирует новое приложение на портале, портал отправляет запрос в Edge для сохранения информации о приложении.
Более подробная информация представлена в следующих разделах.
Где хранятся данные для регистрации приложения и ключи API.
Когда пользователь портала завершает процесс регистрации приложения на интегрированном портале, портал отправляет информацию о приложении в Apigee Edge, включая название приложения и связанные с ним API-продукты. Если Edge успешно регистрирует приложение, он возвращает порталу единый API-ключ. Пользователь портала использует этот API-ключ для доступа к API-продуктам, связанным с приложением.
Информация о приложениях и ключах API хранится только в Edge; она не хранится на портале. Когда пользователь портала использует его для просмотра информации о приложении, например, через страницу «Мои приложения», портал отправляет запрос в Edge с ключом API для доступа к информации.
Аналогичным образом, когда пользователь портала добавляет, удаляет или изменяет приложение, портал отправляет эти изменения в Edge для сохранения.
Поскольку вся информация о приложениях и ключах API хранится в Edge, администратор Edge может изменять эту информацию с помощью пользовательского интерфейса Edge или API управления. Например, администратор может:
- Добавить, удалить или изменить приложение разработчика
- Подтвердить или отозвать ключ API для приложения разработчика.
Для получения дополнительной информации см. раздел «Регистрация приложений и управление ключами API» .
Где хранится информация об учетной записи разработчика приложения?
Информация об учетной записи разработчика хранится в Edge следующим образом:
- При использовании встроенного поставщика идентификационных данных , когда пользователь портала создает учетную запись , информация сохраняется в поставщике идентификационных данных и отображается на странице «Пользователи» .
- При использовании поставщика идентификации SAML , когда пользователь портала входит в систему , теневая запись информации сохраняется в поставщике идентификации и отображается на странице пользователей .
- После регистрации пользователем портала приложения для разработчиков информация об учетной записи пользователя синхронизируется и становится доступной в Edge на странице «Разработчики» .
В браузере Edge хранится следующая информация об учетных записях пользователей:
- Имя и фамилия
- Адрес электронной почты
- Имя пользователя
- Статус учетной записи на портале (активная или неактивная)
- Роль на портале (аутентифицированный пользователь, администратор, другое)
- Права доступа на основе ролей
- Команды, в которых состоит пользователь портала (если вы участвуете в бета-тестировании функции команд ).
Адрес электронной почты является первичным ключом, используемым Edge для идентификации разработчика, и каждый такой адрес должен быть уникальным. На основе первичного ключа Edge генерирует уникальный идентификатор разработчика для каждой организации, к которой принадлежит разработчик.
Для получения дополнительной информации см. раздел «Регистрация разработчиков приложений» .
Где хранится информация о команде разработчиков (бета-версия)
Когда пользователь портала создает команду разработчиков, информация о команде разработчиков сохраняется в Edge, включая:
- Название и описание команды разработчиков
- Члены команды разработчиков и их роли
- Приложения, за которые отвечает команда разработчиков.
- Целевая аудитория, назначенная команде разработчиков.
- Время создания команды разработчиков
Для команды разработчиков генерируется уникальный, автоматически создаваемый адрес электронной почты, который служит основным ключом, используемым Edge для идентификации команды разработчиков.
Для получения дополнительной информации см. разделы «Распределение ответственности за приложение с помощью команд разработчиков (бета-версия)» и «Управление командами разработчиков» .
О примере портала
При создании нового портала вам предоставляется набор стартовых страниц, которые можно использовать в качестве отправной точки. Стартовые страницы содержат демонстрационный контент, который поможет вам вдохновиться при разработке собственного портала, заменив текст и изображения на свой уникальный контент. В примере темы портала используется дизайн Material Design и SCSS .
Ниже представлена главная страница демонстрационного портала.
В состав стартовых страниц, предоставляемых вместе с образцом портала, входят:
| Страница | Описание |
|---|---|
| Дом | Главная страница портала, описывающая демонстрируемые API. Служит в качестве главной страницы по умолчанию для вашего портала (index.html). Демонстрирует использование компонентов Angular Material , как описано в разделе «Добавление компонентов Angular Material» . |
| Быстрый старт | Пошаговый набор инструкций по настройке портала. В примере портала нажмите «Быстрый старт» , чтобы пошагово добавить контент на страницу «Начало работы» . |
| Начать | Пример страницы с контентом. Чтобы узнать, как редактировать эту страницу и добавить её в верхнюю панель навигации, см. страницу «Начало работы» в примере портала. |
| API | Список доступных API. При создании интерактивной справочной документации по API ссылки на контент автоматически добавляются на эту страницу. Примечание: Содержимое этой страницы генерируется автоматически на основе API, которые вы публикуете на своем портале. Вы не можете редактировать содержимое этой страницы напрямую; она не отображается в списке страниц. Вы можете изменить стиль страницы с помощью редактора тем портала . |
| Мои приложения | Список зарегистрированных приложений для авторизованного пользователя. См. раздел «Как пользователи портала взаимодействуют с вашим порталом» . Примечание: Содержимое этой страницы генерируется автоматически на основе приложений зарегистрированных пользователей. Вы не можете редактировать содержимое страницы напрямую; она не отображается в списке страниц. Вы можете изменить стиль страницы с помощью редактора тем . |
| Войти | Страница входа для зарегистрированных пользователей. Новые пользователи могут зарегистрироваться на этой странице, нажав кнопку «Войти» . См. раздел «Как пользователи портала взаимодействуют с вашим порталом» . Примечание: Страница входа автоматически включается в ваш портал. Вы можете настроить логотип на странице входа и добавить пользовательские поля регистрации на страницу создания учетной записи. Вы не можете редактировать содержимое страницы напрямую; она не отображается в списке страниц. |
| Условия и положения | Пример страницы с условиями использования. |
Поддержка браузеров
Интегрированные порталы Apigee поддерживают те же версии браузеров, что и Apigee Edge .