Как пользователи портала взаимодействуют с вашим порталом

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

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

В следующих разделах описывается, как пользователи портала взаимодействуют с вашим порталом.

Войдите на портал

В следующих разделах описывается, как пользователи портала входят в интегрированный портал, используя свои учетные данные (встроенный поставщик идентификации) или с помощью SAML (бета-версия).

Если вы включите как встроенный, так и SAML-провайдеры идентификации , пользователи портала смогут выбрать предпочтительный способ входа в систему.

Войдите на портал, используя учетные данные пользователя (встроенный поставщик идентификации).

При включении встроенного поставщика идентификации пользователи портала могут входить в интегрированный портал, используя свои учетные данные (имя пользователя и пароль), как описано в следующих разделах:

Создайте учетную запись пользователя на интегрированном портале.

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

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

  1. Перейдите на портал.

  2. Нажмите «Войти» .

    Отобразится страница входа.

  3. Нажмите «Создать учетную запись» .

    Отобразится страница «Создать учетную запись».

    Диалог создания учетной записи

  4. Заполните форму.

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

  5. Ознакомьтесь с условиями и примите их.

  6. Нажмите «Создать учетную запись» .

  7. Заполните форму CAPTCHA и нажмите «Подтвердить» (если отображается).

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

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

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

  9. Войдите в интегрированный портал (описано ниже).

Войдите в интегрированный портал.

Благодаря встроенному поставщику идентификационных данных, после регистрации и одобрения пользователей на интегрированном портале, они входят в систему, используя свои учетные данные (имя пользователя и пароль).

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

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

Смените пароль

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

  1. Перейдите на портал.
  2. Нажмите «Войти» .
  3. Нажмите «Сбросить пароль» .
  4. Введите адрес электронной почты учетной записи, которую необходимо сбросить.

  5. Нажмите «Отправить ссылку для сброса пароля» .

    Ссылка для сброса пароля будет отправлена ​​на электронный адрес.

  6. Перейдите по ссылке в подтверждающем электронном письме.

  7. Введите новый пароль и подтвердите его.

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

  8. Нажмите «Создать новый пароль» .

Войдите на портал, используя аутентификацию SAML (бета-версия).

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

  1. Перейдите на портал.
  2. Нажмите «Войти» .

  3. Нажмите «Войти через SAML» .

    Вы будете перенаправлены на сайт поставщика SAML.

  4. При появлении запроса введите учетные данные вашего поставщика идентификации SAML.

Просмотреть справочную документацию по API

Пользователи портала могут просмотреть опубликованную вами на портале справочную документацию по API следующим образом:

  1. Перейдите на портал.

  2. Нажмите «API» в верхней панели навигации. Отобразится страница с API. Например:

    страница API

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

  4. Нажмите на карточку API, чтобы просмотреть справочную документацию по API. Отобразится справочная документация по API.

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

Разделение ответственности за приложение с помощью команд разработчиков (бета-версия)

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

О ролях в команде разработчиков

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

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

Перейти на страницу «Команды»

На странице «Команды» отображаются команды разработчиков, в которых вы состоите.

Чтобы перейти на страницу Teams:

  1. Войдите на портал.
  2. В портале в раскрывающемся списке учетных записей пользователей выберите «Команды» .

Отображается страница «Команды», позволяющая вам:

Добавить команды разработчиков

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

  1. Войдите на портал.
  2. В портале в раскрывающемся списке учетных записей пользователей выберите «Команды» .
  3. Нажмите + Новая команда .
  4. Введите название и описание.

  5. Чтобы добавить участника в команду разработчиков, нажмите кнопку «+ Добавить еще одного участника» , введите адрес электронной почты пользователя портала и выберите роль в команде разработчиков .

    Повторите эти действия, чтобы добавить дополнительных участников.

  6. Чтобы удалить участника из команды разработчиков, нажмите здесь. значок удаления рядом с тем участником команды разработчиков, которого вы хотите удалить.

  7. Нажмите «Создать» .

Редактирование состава команды разработчиков и ролей.

Чтобы изменить состав команды разработчиков и их роли:

  1. Войдите на портал.
  2. В портале в раскрывающемся списке учетных записей пользователей выберите «Команды» .
  3. Щелкните в строке команды разработчиков, которую вы хотите отредактировать и в которой вы являетесь владельцем.

  4. Выполните один или несколько из следующих шагов:

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

  5. Нажмите « Сохранить ».

Уйдите из команды разработчиков.

Чтобы выйти из команды разработчиков:

  1. Войдите на портал.
  2. В портале в раскрывающемся списке учетных записей пользователей выберите «Команды» .
  3. Щёлкните по строке команды разработчиков, из которой вы хотите удалить себя.
  4. Нажмите « Покинуть команду» .

Удалить команду разработчиков

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

  1. Войдите на портал.
  2. В портале в раскрывающемся списке учетных записей пользователей выберите «Команды» .
  3. Щёлкните по строке команды разработчиков, которую хотите удалить.
  4. Нажмите значок удаления .
  5. Нажмите «Подтвердить» , чтобы подтвердить удаление.

Зарегистрировать приложения

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

Зарегистрируйте приложения разработчика

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

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

  4. Выберите владельца приложения в раскрывающемся списке «Владелец» .

    По умолчанию вы являетесь владельцем приложения. При желании выберите команду разработчиков из выпадающего меню, чтобы разделить ответственность за приложение с другими членами команды разработчиков. См. раздел «Разделение ответственности за приложение с помощью команд разработчиков (бета-версия)» .

  5. В разделе «Каталог API» выберите один или несколько API.

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

  6. Если вы выберете API в разделе «Аутентифицированные API», введите URL-адрес обратного вызова.

    Для получения более подробной информации см. раздел «Об URL-адресах обратного вызова» .

  7. Нажмите «Создать» .

Зарегистрировать приложения команды разработчиков

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

Чтобы узнать больше, как это сделать:

Для регистрации приложений команды разработчиков:

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

  5. Выберите владельца приложения в раскрывающемся списке «Владелец» .

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

  6. В разделе «Каталог API» выберите один или несколько API.

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

  7. Если вы выберете API в разделе «Аутентифицированные API», введите URL-адрес обратного вызова.

    Для получения более подробной информации см. раздел «Об URL-адресах обратного вызова» .

  8. Нажмите «Создать» .

Управление API в приложении

Как разработчик API, вы публикуете API , чтобы пользователи портала могли использовать ваши API-продукты.

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

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

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

Просмотреть ключ и секрет API для приложения

Пользователи портала могут управлять ключом API для приложения через ваш портал следующим образом:

  1. Выберите «Приложения» в раскрывающемся списке учетной записи пользователя.
  2. Нажмите на приложение в списке.
  3. Ключи API можно посмотреть в разделе «Ключи API».
  4. Убедитесь, что статус ключа API — «Активный». Если ваш ключ API требует подтверждения и еще не был подтвержден, статус будет отображаться как «Ожидает подтверждения» .
  5. Нажмите «Показать секрет» , чтобы увидеть секрет.
  6. Наведите курсор на ключ или секрет API и нажмитезначок удаления скопировать это в буфер обмена.

Поменяйте API-ключ для приложения.

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

Пользователи портала могут изменить ключ API для приложения на вашем портале следующим образом:

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

Отозвать ключ API для приложения

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

Пользователи портала могут отозвать ключ API для приложения через ваш портал следующим образом:

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

  4. Нажмите «Подтвердить» , чтобы подтвердить операцию.

    Статус ключа обновлен до «Отозван».

Редактировать сведения о приложении

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

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

Удалить приложение

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

  1. Выберите «Приложения» в раскрывающемся списке учетной записи пользователя.
  2. Нажмите на приложение в списке.
  3. Нажмите УДАЛИТЬ .
  4. Нажмите «Подтвердить» , чтобы подтвердить операцию.

Приложение удалено и исключено из списка приложений.