Как создать интегрированный портал

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация

Apigee Edge предоставляет простой в использовании интегрированный портал для документирования API и управления доступом к ним, а также для поддержки сообщества разработчиков приложений.

Все пользователи Apigee Edge имеют доступ к встроенным инструментам разработки портала, которые позволяют быстро создать собственный портал для разработчиков. Это альтернатива разработке портала на основе Drupal. Сравнение функций приведено в статье Сравнение функций портала для разработчиков.

Основные функции и преимущества

Встроенный портал предлагает следующие ключевые функции и преимущества:

Функция	Преимущества
Разработка контента портала	Быстро и легко создавайте контент для портала. Создавайте страницы с помощью простого редактора Как создавать контент с помощью Markdown и HTML Как добавить меню для навигации по порталу
Внешний вид портала	Полностью настройте внешний вид портала с помощью таблиц стилей SCSS и персонализированного брендинга.
Документация по API	Автоматически создавать справочную документацию по API на основе спецификаций OpenAPI.
Самостоятельная регистрация	Предоставьте разработчикам возможность самостоятельно регистрироваться, чтобы создавать приложения с использованием ваших API.
Управление аудиториями	Как управлять доступом к контенту портала и API
Аналитика	Настройте Google Аналитику и специальное отслеживание аналитики.
Расширенные настройки	Выполнять расширенные настройки портала, в том числе: Как настроить домен Как добавить собственные поля регистрации Как расширить возможности портала с помощью скриптов Как настроить электронную почту

Как начать создавать портал

Как Apigee обеспечивает безопасность на интегрированном портале

В таблице ниже описано, как Apigee обеспечивает безопасность с помощью встроенных функций интегрированного портала.

Функция	Адреса
Требуется HTTPS и безопасность на транспортном уровне (TLS)	Принудительное использование зашифрованного соединения
Включает регистрацию домена apigee.io со списком общедоступных суффиксов.	Запрещает установку "суперфайлов cookie" в субдоменах apigee.io.
Поддержка конфигурации Content Security Policy (CSP)	Защита от межсайтового скриптинга (XSS) и других атак с внедрением кода
Требования: Очистка входных данных формы Внедрение JavaScript на всех страницах сайта доступно только администраторам	Защита от атак с внедрением кода HTML, SQL или кода на стороне сервера
Включает заголовок x-content-type-options: nosniff XSS	Запрещает браузерам пытаться определить MIME-типы
Включает заголовок x-frame-options: deny XSS	Запрещает встраивать контент портала в окно iframe.
Включает заголовок x-xss-protection: 1 XSS	Запрещает загрузку страниц при обнаружении отраженных атак межсайтового скриптинга (XSS)
Использует токены CSRF	Защита от межсайтовой подделки запросов
Использует: Шифрование данных в Google Cloud в покое Правила Google в отношении пользовательских данных и их хранения Изоляция арендаторов Хранение данных журнала и отладки (6 недель)	Защита данных клиентов

Как интегрированный портал взаимодействует с Edge

Большая часть информации, используемой на портале для разработчиков, хранится в Apigee Edge. Портал выступает в качестве клиента для Edge. При необходимости портал для разработчиков отправляет HTTP- или HTTPS-запрос REST, чтобы получить информацию от 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.