Создайте свой портал с помощью Drupal 7

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

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

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

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

В следующем видеоролике представлен портал Apigee Developer Services.

На следующем рисунке показана домашняя страница портала разработчика по умолчанию:

Портал разработчиков по сути представляет собой систему управления контентом (CMS), основанную на проекте Drupal с открытым исходным кодом ( http://www.drupal.org ). Drupal предоставляет основной набор функций в виде модулей, которые упрощают создание контента для веб-сайтов и управление ими.

Портал разработчиков «из коробки» позволяет создавать документацию по API, поддерживает ведение блогов и предоставляет тематические форумы. Вы также можете настроить портал разработчика в соответствии со своими конкретными требованиями. Настройка позволяет изменить внешний вид портала, а также способ взаимодействия разработчиков с порталом.

Меню Drupal используется для выполнения большинства настроек. Если вы войдете на портал как пользователь с правами администратора, меню Drupal появится вверху каждой страницы портала:

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

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

Типы пользователей портала

На следующем изображении показаны два типа пользователей портала:

• Разработчики составляют сообщество пользователей, которые создают приложения с использованием ваших API. Разработчики приложений используют портал, чтобы узнать о ваших API через SmartDocs, зарегистрировать учетную запись на портале, зарегистрировать приложения, использующие ваши API, взаимодействовать с сообществом разработчиков и просматривать статистическую информацию об использовании ими приложений на информационной панели.
• Команда API — это поставщик API, который создает контент портала, делает свои API доступными для разработчиков приложений, предоставляет документацию по API и предоставляет разработчикам механизм регистрации приложений и получения ключей API. Команда API выполняет базовую настройку портала разработчика, чтобы:
  • Настройте автоматические или ручные запросы ключей API.
  • Поддерживать документацию API, форумы и блоги и, при необходимости, вносить изменения во все изменения.
  • Обрабатывать комментарии пользователей и модерировать форум.
  • Включите управление доступом на основе ролей (RBAC), чтобы контролировать доступ к функциям портала. Например, администратор может включить элементы управления, позволяющие зарегистрированному пользователю создавать сообщения на форуме или использовать консоли тестирования.
  • Настройте уведомления по электронной почте для администраторов и разработчиков о создании и утверждении пользователей.
  • Настройте веб-формы, такие как страницы «Свяжитесь с нами».

На этом рисунке не показан третий тип пользователей портала — менеджер по продукту API . Менеджер по продукту API отвечает за определение того, как команда API создает портал, в том числе:

• Определение способа упаковки API в продукты
• Определение правил одобрения приложения
• Если на портале включена монетизация, определение цен и планов выставления счетов для продуктов API. Дополнительную информацию о монетизации см. в разделе Обзор монетизации .

Настройка портала разработчика

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

• Легкий доступ к вашим API
• Документация, такая как практические руководства и справочные документы.
• Контент, предоставленный сообществом, например блоги и дискуссионные форумы.
• Пример кода
• Простой процесс регистрации, позволяющий быстро утверждать новых разработчиков, приложения и API.
• Управляемые права и учетные данные
• Многоуровневый контроль доступа
• Внешний вид, соответствующий вашей организации

Портал поставляется с предустановленной базовой конфигурацией. Например, изначально портал настроен так, чтобы любой мог зарегистрироваться в качестве разработчика, но администратор должен утвердить каждую регистрацию, прежде чем разработчик сможет войти на портал. После одобрения регистрации разработчик может зарегистрировать приложение, запросить ключ API и использовать портал для доступа к ресурсам API.

Шаги процесса регистрации по умолчанию:

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

Этот нестандартный опыт легко настраивается. Например, вы можете переопределить схему регистрации и авторизации по умолчанию, чтобы новый разработчик автоматически одобрялся и входил в систему после регистрации. Или вы можете потребовать от разработчика принять ряд положений и условий, прежде чем он сможет войти в систему в первый раз.

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

Дополнительные сведения см. в разделе Настройка внешнего вида .

Администрирование портала разработчиков

Разработчики используют ваш портал разработчиков для доступа и использования вашего API. Администраторы выполняют задачи по управлению учетными записями, такие как:

• Настройка процесса регистрации разработчика, включая поля регистрации, встроенные в Captcha, а также автоматическое или ручное одобрение.
• Добавление или одобрение разработчиков. По умолчанию любой разработчик может зарегистрироваться через портал разработчиков, но ему необходимо получить одобрение администратора через пользовательский интерфейс портала разработки. Администраторы также могут создавать разработчиков прямо на портале. Затем портал автоматически отправляет разработчику электронное письмо о том, что для него создана учетная запись.
• Изменение аккаунта разработчика. Например, администраторы могут изменить статус учетной записи пользователя с активного на заблокированный или изменить информацию профиля разработчика, такую ​​как название компании.
• Удаление разработчика. Администраторы могут отключить или удалить учетную запись разработчика.
• Назначение ролей и разрешений. Администраторы могут назначить определенную роль учетной записи разработчика. Роль связана с различными разрешениями, такими как разрешение на создание книг или другого контента. Вы также можете изменить разрешения, связанные с ролью, или создать новые роли.

Дополнительную информацию см. в разделе Добавление учетных записей пользователей и управление ими .

Краткое описание функций портала для разработчиков

В следующей таблице содержится сводная информация о функциях портала разработчика: