Настройка регистрации приложения

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

Разработчики используют страницу «Мои приложения» на портале служб разработчиков для регистрации приложений. Разработчики получают доступ к странице «Мои приложения» из главного меню портала:

Чтобы зарегистрировать новое приложение, разработчик нажимает кнопку «Добавить новое приложение» на странице «Мои приложения».

Затем на портале отображается форма регистрации приложения по умолчанию:

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

Как поставщик API вы имеете полный контроль над процессом регистрации приложения. Например, вы можете настроить:

• Список продуктов API, доступных на портале
• Существует ли продукт API по умолчанию
• Требуется ли URL обратного вызова
• Утверждается ли ключ API вручную или автоматически для продукта API
• Требуется ли какая-либо другая информация на странице «Добавить приложение» для регистрации приложения.

В этом разделе описывается, как настроить процесс регистрации приложения для вашего портала. Однако в этом разделе не описывается, как создавать продукты API. Подробнее см.:

• Создавайте продукты API
• Использование API управления Edge для публикации API

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

Указание продуктов API, доступных на портале

Существует два способа указать продукты API, доступные при доступе разработчика к порталу:

• Указание уровня доступа при создании продукта API
• Ограничение доступа к продукту API на основе ролей

Указание уровня доступа при создании продукта API

Когда вы создаете продукт API, вы указываете параметр уровня доступа продукта, как показано ниже:

Дополнительные сведения о том, как уровень доступа влияет на доступность продукта API на портале разработчиков Drupal 7, см. в разделе Уровень доступа .

Ограничение доступа к продукту API на основе ролей

Включив модуль Drupal доступа к ролям продуктов API, вы можете указать роли, которые могут получить доступ к каждому продукту API.

Чтобы ограничить доступ к продукту API на основе ролей разработчика:

1. Войдите на свой портал как пользователь с правами администратора или создания контента.
2. Просмотрите роли и назначения пользователей на портале разработки:
   • Выберите «Люди» > «Разрешения» > «Роли» в меню администрирования Drupal и при необходимости добавьте или отредактируйте роли и разрешения разработчика.
   • Выберите «Люди» в меню администрирования Drupal и при необходимости отредактируйте назначения пользователей и ролей.
3. Выберите Конфигурация > Портал разработки > Доступ к роли продукта API в меню администрирования Drupal.
4. Выберите роли, которым вы хотите предоставить доступ к каждому продукту API.
5. Нажмите Сохранить конфигурацию .

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

Чтобы зарегистрировать новое приложение, разработчик нажимает кнопку «Добавить новое приложение» на странице «Мои приложения», чтобы открыть форму добавления приложения:

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

На портале доступны следующие параметры конфигурации для управления выбором продукта API при регистрации приложения:

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

Вы также можете управлять элементом HTML, который появляется в форме, которую разработчик использует для выбора продукта API. Опции включают в себя:

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

Чтобы установить опцию выбора продукта API:

1. Войдите на свой портал как пользователь с правами администратора или создания контента.
2. Выберите Конфигурация > Настройки портала разработки > Настройки приложения в меню администрирования Drupal.
3. На странице «Настройки приложения» разверните область «Настройки продукта API» .
4. В разделе «Обработка продуктов API» выберите параметр, управляющий выбором продуктов API.
5. Если вы укажете параметр «Связать все приложения с одним или несколькими продуктами API по умолчанию (настроенными ниже)», установите продукт по умолчанию в разделе Продукт API по умолчанию .
6. В разделе «Виджет продукта API» выберите элемент HTML, используемый разработчиками для выбора продуктов API.
7. Сохраните конфигурацию.

Настройка обработки URL обратного вызова

Если прокси-сервер API в вашем продукте API использует «трехсторонний OAuth» (тип предоставления кода авторизации), разработчикам необходимо указать URL-адрес обратного вызова при регистрации своих приложений. URL-адрес обратного вызова обычно указывает URL-адрес приложения, предназначенного для получения кода авторизации от имени клиентского приложения. Кроме того, эта строка URL-адреса используется для проверки. Клиент обязан отправлять этот URL-адрес в Apigee Edge при запросе кодов авторизации и токенов доступа, а параметр redirect_uri должен совпадать с зарегистрированным. Дополнительные сведения см. в разделе Реализация типа предоставления кода авторизации .

Чтобы управлять URL-адресом обратного вызова для выбора продукта API:

1. Войдите на свой портал как пользователь с правами администратора или создания контента.
2. Выберите Конфигурация > Настройки портала разработки > Атрибуты приложения в меню администрирования Drupal.
3. На странице «Настройки приложения» разверните область настроек URL-адреса обратного вызова .
4. В разделе «Обработка URL-адреса обратного вызова» выберите один из следующих вариантов.
   • URL-адрес обратного вызова необходим для всех приложений разработчика.
   • URL-адрес обратного вызова является необязательным для всех приложений разработчика.
   • URL-адрес обратного вызова не требуется и не отображается.
5. Сохраните конфигурацию.

Отображение аналитики использования приложения

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

• Пропускная способность
• Максимальное время ответа
• Минимальное время ответа
• Количество сообщений
• Количество ошибок

Чтобы включить аналитику на портале:

1. Войдите на свой портал как пользователь с правами администратора или создания контента.
2. Выберите Конфигурация > Портал разработки > Настройки приложения в меню администрирования Drupal.
3. На странице «Настройки приложения» разверните область «Настройки производительности приложения» .
4. Установите флажок «Показать вкладку аналитики приложений для разработчиков» .
5. Выберите «Тестирование» или «Производство» для параметра «Среда», чтобы запросить аналитические данные . Для общедоступного портала обычно вы выбираете Производство .
6. Сохраните конфигурацию.

Чтобы отобразить аналитику на портале для приложения:

1. Выберите название приложения на странице «Мои приложения».
2. Выберите ссылку Analytics для приложения.
3. Выберите тип аналитики для отображения и диапазон дат:
4. Отображается выбранная информация:
   

Одобрение или отзыв ключа API для продукта API вручную.

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

Вы контролируете процесс утверждения ключей для каждого продукта API при создании продукта API:

Процесс утверждения может быть:

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

Дополнительные сведения см. в разделе Создание продуктов API .

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

Чтобы просмотреть список продуктов API для приложения и статус утверждения ключа для продукта API, разработчик выбирает имя приложения на странице «Мои приложения», а затем выбирает ссылку «Продукты»:

В этом примере продукт Premium Weather API использует утверждение вручную и ожидает одобрения ключа администратором. Продукт с бесплатным API использует автоматическое одобрение, и использование ключа для доступа к нему одобрено.

Чтобы вручную утвердить или отозвать ключ:

1. Войдите в пользовательский интерфейс управления Edge как пользователь с правами администратора вашей организации.
2. Выберите «Платформа API» в раскрывающемся списке в правом верхнем углу.
3. Выберите «Опубликовать» > «Приложения разработчика», чтобы открыть список приложений разработчика.
4. Нажмите кнопку «Ожидание» , чтобы просмотреть список приложений с ожидающими запросами ключей:
   

   

5. Выберите имя приложения, которое вы хотите одобрить.
6. На странице сведений о приложении нажмите кнопку «Изменить» в правом верхнем углу.
7. В списке продуктов API для приложения в разделе «Действия» :
   • Чтобы утвердить ключ , нажмите кнопку «Утвердить» для каждого продукта API, требующего одобрения вручную.
     

     

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

     

8. Сохраните приложение. Ключ API теперь одобрен.

Управление кэшированием продуктов и приложений через API

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

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

По умолчанию портал настроен на перестроение кэшей продуктов API и приложений для разработчиков при каждом запуске cron.

Чтобы указать, следует ли перестраивать кэши продуктов API и приложений для разработчиков при каждом запуске cron:

1. Войдите на свой портал как пользователь с правами администратора или создания контента.
2. В меню Drupal выберите Конфигурация > Настройки портала разработки > Настройки приложения .
3. Установите или снимите флажок Перестраивать кэши продуктов API и приложений разработчика при каждом запуске cron .
4. Сохраните настройки.

Чтобы обновить кеши вручную:

1. Войдите на свой портал как пользователь с правами администратора или создания контента.
2. В меню Drupal выберите значок «Домой» > «Очистить все кеши».

Настройка полей формы, используемых для регистрации приложения

Когда разработчик регистрирует приложение, на портале отображается форма по умолчанию:

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

• Обязательный или необязательный
• Отображается различными элементами HTML, такими как текстовые поля, переключатели, флажки и т. д.
• Можно настроить отображение в любом месте формы между полем «URL обратного вызова» и полем «Продукт».

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

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

Например, просмотрите новые поля формы в пользовательском интерфейсе управления Edge, выбрав «Публикация» > «Приложения для разработчиков», а затем выбрав имя приложения. Значения новых полей появятся в области «Пользовательские атрибуты» на странице с именем, соответствующим внутреннему имени поля:

Значения полей также отображаются в области «Сведения» приложения на странице «Мои приложения» разработчика:

Разработчик также может редактировать значения, выбрав ссылку «Изменить» для приложения на странице «Мои приложения».

В приведенных ниже процедурах описано, как настроить формы создания приложений с помощью интерфейса администратора. Разработчик Drupal может выполнять дополнительные настройки, включая изменение страницы «Мои приложения», используя собственные перехватчики. Чтобы узнать больше о том, как изменить поведение с помощью кода, см. примеры API приложений в файле: /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php .

Чтобы добавить поле в форму регистрации приложения:

1. Войдите на свой портал как пользователь с правами администратора или создания контента.
2. Убедитесь, что модуль управления атрибутами приложений DevConnect включен.
3. В меню администрирования Drupal выберите «Конфигурация» > «Настройки портала разработки» > «Атрибуты приложения портала разработки» .
4. Нажмите кнопку «Добавить атрибут приложения Dev Portal» в верхней части страницы.
5. Настройте поле. Например, для поля «Идентификатор клиента», показанного выше, используйте следующие настройки:
   • Внутреннее имя = cust_id. Это имя переменной, используемой для хранения значения поля.
   • Публичное имя = идентификатор клиента.
   • Описание = Введите свой идентификатор клиента.
   • Установите флажок Требовать этот атрибут.
   • Установите флажок «Показать этот атрибут».
   • Виджет = Текстовое поле
   • Выберите «Сохранить», чтобы вернуться на страницу «Атрибуты приложения портала разработки».
6. Выберите «Сохранить изменения» .
7. Выберите значок «Домой» > «Очистить все кеши» в меню Drupal.
   Возможно, вам придется очистить кеш браузера, прежде чем новое поле появится в форме.

Чтобы добавить необязательное поле, позволяющее разработчику указать платформу для приложения, установите атрибуты поля следующим образом:

• Внутреннее имя = предполагаемые_платформы
• Публичное имя = Платформы
• Описание = Укажите одну или несколько платформ для вашего приложения.
• Снимите флажки «Требовать этот атрибут».
• Установите флажок «Показать этот атрибут».
• Виджет = Список флажков
• Выберите «Сохранить», чтобы вернуться на страницу «Атрибуты приложения портала разработки».

Чтобы изменить порядок атрибутов в форме:

1. Войдите на свой портал как пользователь с правами администратора или создания контента.
2. В меню администрирования Drupal выберите «Конфигурация» > «Настройки портала разработки» > «Атрибуты приложения портала разработки» .
3. Выберите символ плюс, + , в столбце Имя и перетащите свойство в то место, где вы хотите отобразить его в форме.
4. Сохраните изменения.