Регистрируйте приложения и управляйте ключами API

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

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

Введение

Регистрация приложения обеспечивает основной механизм контроля доступа к вашим API.

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

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

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

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

Изучение страницы приложений

Откройте и изучите страницу приложений, как описано ниже.

Край

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

  1. Войдите на сайт apigee.com/edge .
  2. Выберите «Опубликовать» > «Приложения» на левой панели навигации.

Отобразится страница приложений.

Как показано на рисунке, страница «Приложения» позволяет:

Классический Edge (частное облако)

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

  1. Войдите по адресу http:// ms-ip :9000 , где ms-ip — это IP-адрес или DNS-имя узла сервера управления.
  2. Выберите «Опубликовать» > «Приложения для разработчиков» на верхней панели навигации.

Откроется страница приложений разработчика.

Регистрация приложения

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

Зарегистрированные приложения добавляются в:

Чтобы зарегистрировать приложение в Edge:

  1. Откройте страницу приложений.
  2. Нажмите + Приложение .
  3. Укажите детали приложения :
    Поле Описание Необходимый?
    Имя Название приложения. Вы не можете изменить имя после создания приложения. Это имя используется в вызовах API управления. Да
    Отображаемое имя Отображаемое имя приложения, которое отображается в пользовательском интерфейсе управления Edge и на портале разработчика. Нет
    Компания/Застройщик

    Примечание . Apigee Hybrid не поддерживает корпоративные приложения; это поле не применяется.

    Выберите «Компания» или «Разработчик» , а затем выберите имя компании или «разработчика» из раскрывающегося списка.
    Примечание. Из соображений производительности в раскрывающемся списке отображаются не все компании или разработчики. Начните вводить название компании, имя разработчика или адрес электронной почты в поле поиска. См. также Регистрация разработчиков приложений .

    		 Да
    URL обратного вызова Обычно указывает URL-адрес приложения, предназначенного для получения кода авторизации от имени клиентского приложения. Это значение не является обязательным для всех продуктов API. Нет
    Примечания Описательные примечания к приложению. Нет
  4. Укажите учетные данные , включая срок действия и статус ключа API, а также связанные продукты API.
    В разделе «Учетные данные» нажмите и введите следующую информацию:
    Поле Описание
    Срок действия Настройте срок или дату истечения срока действия или установите бессрочный срок действия ключа API и нажмите «ОК» .
    Продукты Свяжите один или несколько продуктов API с ключом API:
    1. Нажмите Добавить продукт .
    2. Выберите один или несколько продуктов API из списка.
    3. Нажмите Добавить .
    4. Установите статус «Одобрено» или «Отменено» для каждого продукта API.
    5. Повторите шаги, чтобы добавить больше продуктов API.
  5. Укажите пользовательские атрибуты :
    1. В разделе «Пользовательские атрибуты» нажмите .
    2. Введите имя и значение.
    3. Нажмите «Добавить» или «Добавить и запустить другой» .
      Максимальное количество пользовательских атрибутов, которые вы можете добавить, — 18.
  6. Нажмите Создать .

Если продукты API, которые вы связали с приложением, требовали ручного утверждения своих ключей API, одобрите их, как описано в разделе «Утверждение или отзыв ключей API» .

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

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

Просмотр и редактирование приложения

Чтобы просмотреть и отредактировать приложение:

  1. Откройте страницу приложений.
  2. Нажмите на строку приложения, которое вы хотите просмотреть и отредактировать.
    Отобразятся сведения о приложении.
  3. Чтобы отредактировать приложение, нажмите «Изменить» .
  4. Выполните одну или несколько из следующих задач:
  5. Нажмите Сохранить .

Управление учетными данными

При редактировании приложения вы можете управлять его учетными данными в разделе «Учетные данные» , как показано на следующем рисунке:

Как показано на предыдущем рисунке, в разделе «Учетные данные» вы можете выполнять следующие задачи с помощью пользовательского интерфейса:

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

Просмотр ключа и секрета API

Чтобы просмотреть ключ и секрет API:

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

Утверждение или отзыв ключа API

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

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

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

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

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

Управление продуктами API в приложении

Управляйте продуктами API в своем приложении, выполняя следующие задачи:

Добавление продукта API в приложение

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

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

Удаление продукта API из приложения

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

  1. Откройте страницу приложений.
  2. Нажмите на строку приложения, которое вы хотите просмотреть и отредактировать.
  3. Нажмите «Изменить» .
  4. Нажмите рядом с продуктом API.
  5. Нажмите Сохранить .

Вы можете повторно добавить удаленный товар.

Создание новых учетных данных

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

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

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

Одобрение или отзыв приложения

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

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

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

  1. Откройте страницу приложений.
  2. Нажмите на строку приложения, которое вы хотите просмотреть и отредактировать.
  3. Нажмите «Изменить» .
  4. Выберите «Утвердить» или «Отменить» в поле «Статус приложения» , чтобы утвердить или отозвать приложение соответственно.
  5. Нажмите Сохранить .

Удаление приложения

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

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

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

  1. Откройте страницу приложений.
  2. Поместите курсор в строку приложения, которое вы хотите удалить.
  3. Нажмите в столбце действий.

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

Регистрация приложений и управление ключами API с помощью API

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

См. также Импорт существующих потребительских ключей и секретов .