Поделиться через

Переход на новый портал разработчика

  • Статья

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

Важно!

Используемая версия портала разработчика устарела, поэтому для нее теперь доступны только обновления безопасности. Вы по-прежнему можете использовать его в обычном режиме до прекращения его поддержки в октябре 2023 года, когда он будет удален изо всех служб Управления API.

Портал разработчика API Management

Доступность

Важно!

Эта функция доступна в ценовых категориях Премиум, Стандартный, Базовый и Разработка службы "Управление API".

Сведения о доступности компонентов на уровнях версии 2 (предварительная версия) см. в обзоре уровней версии 2.

Улучшения нового портала разработчика

На новом портале разработчика устранены многие ограничения, присутствующие на устаревшем портале. Он содержит визуальный редактор с поддержкой перетаскивания для редактирования содержимого и специальную панель для веб-дизайнеров. Страницы, настройки и конфигурация сохраняются как ресурсы Azure Resource Manager в службе управления API, что позволяет автоматизировать развертывание портала. Наконец, база кода портала представлена открытым исходным кодом, поэтому можно расширить ее с использованием настраиваемых функций.

Переход на новый портал разработчика

Новый портал разработчика несовместим с устаревшим порталом, и автоматическая миграция невозможна. Потребуется вручную восстановить содержимое (страницы, текст, мультимедийные файлы) и настроить внешний вид нового портала. Конкретные действия будут зависеть от настроек и сложности портала. Инструкции см. в руководстве по порталу разработчика. Оставшиеся элементы конфигурации, например список API-интерфейсов, продуктов, пользователей, поставщиков удостоверений, автоматически распределяются между обоими порталами.

Важно!

Если новый портал разработчика уже запускался, но изменения не были внесены, выполните сброс и восстановите содержимое по умолчанию, чтобы обновить портал до последней версии.

При переходе с устаревшего портала необходимо помнить о следующих изменениях.

  • Если портал разработчика открывается через личный домен, назначьте домен для нового портала разработчика. Выберите параметр Портал разработчика в раскрывающемся списке на портале Azure.

  • Примените политику CORS к используемым интерфейсам API, чтобы включить интерактивную консоль тестирования.

  • При добавлении пользовательской CSS для оформления стиля портала необходимо воспроизвести стиль с помощью встроенной панели дизайна. Использование CSS запрещено на новом портале.

  • Можно использовать собственный JavaScript только в локально установленной версии нового портала.

  • Если служба управления API находится в виртуальной сети и доступ к ней можно получить в сети Интернет, используя шлюз приложений, см. эту статью документации для получения точных инструкций по выполнению конфигурации. Для этого необходимо:

    • Разрешить возможность подключения к конечной точке управления службы управления API.
    • Разрешить возможность подключения к конечной точке нового портала.
    • Отключить выбранные правила брандмауэра для веб-приложений.

  • Если шаблоны уведомлений по электронной почте по умолчанию были изменены, чтобы включить явно определенный URL-адрес устаревшего портала, измените их так, чтобы они использовали параметр URL-адреса портала или указывали на URL-адрес нового портала. Если в шаблонах используется встроенный параметр URL-адреса портала, внесение изменений не требуется.

  • Разделы Проблемы и Приложения не поддерживаются на новом портале разработчика.

  • На новом портале разработчика не поддерживается прямая интеграция с Facebook, Майкрософт, Twitter и Google в качестве поставщиков удостоверений. Интеграцию с этими поставщиками можно реализовать с помощью Azure AD B2C.

  • При использовании делегирования измените URL-адрес возврата в своих приложениях и используйте конечную точку API Получить токен общего доступа вместо конечной точки Создать URL-адрес SSO.

  • Если вы используете идентификатор Microsoft Entra в качестве поставщика удостоверений:

    • Измените URL-адрес возврата в приложении, чтобы он указывал на домен нового портала разработчика.
    • Измените суффикс URL-адреса возврата в приложении с /signin-aad на /signin.

  • При использовании Azure AD B2C в качестве поставщика удостоверений выполните следующее.

    • Измените URL-адрес возврата в приложении, чтобы он указывал на домен нового портала разработчика.
    • Измените суффикс URL-адреса возврата в приложении с /signin-aad на /signin.
    • Включите утверждения Указанное имя, Фамилияи Идентификатор объекта пользователя в приложении.

  • Если используете OAuth 2.0 в интерактивной консоли для тестирования, измените URL-адрес возврата в приложении, чтобы он указывал на домен нового портала разработчика, и измените суффикс.

    • С /docs/services/[serverName]/console/oauth2/authorizationcode/callback на /signin-oauth/code/callback/[serverName] для потока предоставления кода авторизации.
    • С /docs/services/[serverName]/console/oauth2/implicit/callback на /signin-oauth/implicit/callback для потока неявного предоставления разрешения.

  • Если используется OpenID Connect в интерактивной консоли для тестирования, измените URL-адрес возврата в приложении, чтобы он указывал на домен нового портала разработчика, и измените суффикс.

    • С /docs/services/[serverName]/console/openidconnect/authorizationcode/callback на /signin-oauth/code/callback/[serverName] для потока предоставления кода авторизации.
    • С /docs/services/[serverName]/console/openidconnect/implicit/callback на /signin-oauth/implicit/callback для потока неявного предоставления разрешения.

Следующие шаги

См. дополнительные сведения о портале разработчика: