Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация
Как поставщик API, вы разработали набор API для доступа к своим серверным сервисам. Следующий шаг – создать портал для разработчиков, чтобы они могли:
- Как узнать больше о своих данных и предложениях сервисов
- Изучите подробную документацию, в том числе примеры использования, руководства и справочную документацию, чтобы узнать, как использовать API.
- Зарегистрируйтесь, чтобы создавать приложения, использующие ваши API.
Обзор решений для портала для разработчиков
Apigee поддерживает несколько решений для портала разработчика, которые перечислены в таблице ниже. Они различаются по сложности, от простых готовых решений до полностью настраиваемых и расширяемых. При выборе решения необходимо учитывать требования к настройке, а также время и знания, необходимые для реализации портала.
| Решение | Функции | Размещено в Apigee? | Поддержка (требуется лицензионная подписка) |
|---|---|---|---|
| Интегрированный портал Apigee | Простая разработка портала самообслуживания. (Только для клиентов Apigee Edge Public Cloud) |
Да | Круглосуточная поддержка Apigee |
| Портал Drupal 10 | Разработка полностью настраиваемого портала самообслуживания с использованием проектов Drupal 10 с открытым исходным кодом. Интеграция с Apigee с помощью модуля Apigee Edge. | Нет | Круглосуточная поддержка Apigee по устранению неполадок |
| Специальный портал | Полностью настраиваемый портал, который можно создать самостоятельно с помощью API платформы Apigee. | Нет | Круглосуточная поддержка Apigee только для API платформы Apigee |
Как выбрать портал для разработчиков
Чтобы помочь вам выбрать решение для портала для разработчиков, ознакомьтесь с приведенной ниже схемой и сравнением функций порталов для разработчиков.
Если вы используете Apigee Edge для общедоступного облака, рекомендуем создать интегрированный портал Apigee, если вы планируете поддерживать распространенные варианты использования для разработки портала, такие как стандартная регистрация и создание приложений, а также вносить больше стилистических, чем функциональных изменений.
В настоящее время порталы на основе Drupal – единственный вариант для клиентов Apigee Edge для частного облака и монетизации.
Сравнение функций портала для разработчиков
В таблице ниже сравниваются функции встроенного портала Apigee и портала для разработчиков на основе Drupal.
| Функция | Встроенный портал | Drupal |
|---|---|---|
| Создание контента для портала с помощью разметки Markdown |
|
|
| Разработка контента портала с помощью HTML |
|
|
| Справочная документация по API, созданная на основе спецификаций OpenAPI |
|
|
| Поддержка спецификации OpenAPI версии 3 |
|
|
| Как отправлять запросы в реальном времени из документации по API |
|
|
| Специальная тема |
|
|
| Настраиваемые меню |
|
|
| Сторонние теги, например Google Аналитики |
|
|
| Пользовательский код JavaScript |
|
|
| Пользовательское доменное имя |
|
|
| Включен протокол HTTPS |
|
|
| Условия создания аккаунта |
|
|
| Оптимизация для мобильных устройств |
|
|
| Интеграция со специальными скриптами и тегами скриптов |
|
|
| Настройки SMTP |
|
|
| Настройка шаблона электронного письма |
|
|
| CAPTCHA для защиты от спама |
|
|
| Роли и разрешения для аккаунтов разработчиков и потребителей |
|
|
| Интегрированный вход |
|
|
| API для управления контентом | Как использовать Drupal | |
| Монетизация | Скоро |
|
| Настройка поиска | * |
|
| Блоги и форумы | ** |
|
| Шаблоны страниц для создания контента |
|
|
| Аналитика приложений на портале |
|
|
| Управление событиями на основе правил |
|
|
| Возможность расширения с помощью дополнительных модулей |
|
|
| Специальные процессы регистрации приложений |
|
|
| Собственные процессы регистрации разработчиков |
|
|
| Журналы портала |
|
|
| Проверка ссылок |
|
|
| Поддержка Microsoft Internet Explorer/Microsoft Edge | Только Microsoft Edge |
|
| Поддержка Apigee | См. таблицу выше | См. таблицу выше |
Как создать интегрированный портал
Если вы используете Apigee Edge для общедоступного облака, вы можете быстро создать простой портал для разработчиков в интерфейсе Edge. Перейдите на страницу https://apigee.com/edge, войдите в аккаунт и выберите Publish > Portals (Публикация > Порталы) на боковой панели навигации интерфейса Edge. Подробную информацию можно найти в статье Как создать интегрированный портал.
На рисунке ниже показана целевая страница интегрированного портала.
Как создать портал на основе Drupal
С помощью инструментов разработки портала Drupal можно создать полностью настраиваемый портал для разработчиков. Drupal предоставляет широкий набор функций и все возможности CMS Drupal с дополнительными модулями Drupal, разработанными Apigee. Однако для создания портала на основе Drupal требуется больше времени и усилий.
Apigee Edge совместим со следующими версиями Drupal:
| Версия | Описание |
|---|---|
| Drupal 10 | Надежная система управления контентом (CMS) корпоративного уровня с открытым исходным кодом, управляемая клиентом. Поскольку Drupal 10 – это ПО с открытым исходным кодом, вы можете расширять и улучшать фреймворк для разработки портала Drupal 10, а также использовать знания сообщества Drupal. Дополнительную информацию можно найти в статье Как создать портал с помощью Drupal 10. |
Как создать собственный портал с помощью API Apigee Edge
Создайте собственный полностью настраиваемый портал, используя API Apigee Edge, перечисленные в таблице ниже. Статьи по теме
| Категория | API Apigee | Описание |
| Аналитика | Статистика | Просматривать статистику по API. |
| Ключи API | Ключи приложений: разработчик | Управляйте ключами API, используемыми для авторизации использования API в приложениях. |
| Продукты API | Продукты API | Управляйте продуктами API, которые вы публикуете на портале для разработчиков. |
| Приложения | Приложения | Управляйте приложениями, зарегистрированными разработчиками для использования ваших API. |
| Разработчикам | Разработчики | Управляйте разработчиками, зарегистрированными на вашем портале для разработчиков. |
| Монетизация | Монетизация | Монетизируйте свои API. |
Упростите интеграцию клиентского портала с помощью клиентской библиотеки Apigee Edge для PHP. SDK позволяет легко создавать модули PHP, использующие API Apigee, описанные в таблице выше. Дополнительную информацию о клиентской библиотеке Apigee API для PHP можно найти в следующих источниках: