Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация
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 или бэкэнд-инъекций. |
Включает x-content-type-options: nosniff . | Запрещает браузерам пытаться угадать типы MIME |
Включает x-frame-options: deny заголовок XSS. | Запрещает встраивание содержимого портала в iFrame. |
Включает x-xss-protection: 1 заголовок XSS. | Запрещает загрузку страниц при обнаружении атак с использованием отраженного межсайтового скриптинга (XSS). |
| Использует токены CSRF | Защита от подделки межсайтовых запросов |
Кредитное плечо:
| Защита данных клиентов |
Как интегрированный портал взаимодействует с Edge
Большая часть информации, используемой порталом разработчиков, хранится в Apigee Edge. Портал выступает в качестве клиента Edge. При необходимости портал разработчика отправляет запрос HTTP или HTTPS REST для получения информации или отправки информации в Edge. Например, когда пользователь портала регистрирует на портале новое приложение, портал отправляет в Edge запрос на сохранение информации о приложении.
В следующих разделах представлена более подробная информация.
Где хранятся регистрация приложения и ключи API
Когда пользователь портала завершает процесс регистрации приложения на интегрированном портале, портал отправляет информацию о приложении в Apigee Edge, включая имя приложения и продукты API, связанные с приложением. Если Edge успешно регистрирует приложение, 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). Демонстрирует использование компонентов углового материала , как описано в разделе Добавление компонентов углового материала . |
| Быстрый старт | Набор шагов быстрого запуска, демонстрирующих настройку портала. Нажмите «Быстрый старт» на образце портала, чтобы пошагово добавить контент на страницу «Начало работы» . |
| Начать | Пример страницы с контентом. См. страницу «Начало работы» в образце портала, чтобы узнать, как отредактировать эту страницу и добавить ее в верхнюю часть навигации. |
| API | Список доступных API. Когда вы создаете интерактивную справочную документацию по API , ссылки на контент добавляются на эту страницу автоматически. Примечание. Содержимое этой страницы создается автоматически на основе API, которые вы публикуете на своем портале. Вы не можете редактировать содержимое этой страницы напрямую; он не отображается в списке страниц. Изменить стиль страницы можно с помощью редактора тем портала . |
| Мои приложения | Список зарегистрированных приложений для авторизованного пользователя. Посмотрите , как пользователи портала взаимодействуют с вашим порталом . Примечание. Содержимое этой страницы создается автоматически на основе приложений зарегистрированных пользователей. Вы не можете редактировать содержимое страницы напрямую; он не отображается в списке страниц. Вы можете изменить стиль страницы с помощью редактора тем . |
| Войти | Страница входа для зарегистрированных пользователей. Новые пользователи могут зарегистрироваться на этой странице, нажав «Войти» . Посмотрите , как пользователи портала взаимодействуют с вашим порталом . Примечание. Страница входа в систему автоматически добавляется на ваш портал. Вы можете настроить логотип на странице входа в систему и добавить настраиваемые поля регистрации на страницу создания учетной записи. Вы не можете редактировать содержимое страницы напрямую; он не отображается в списке страниц. |
| Условия и положения | Пример страницы условий использования. |
Поддержка браузера
Интегрированные порталы Apigee поддерживают те же версии браузера, что и Apigee Edge .