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

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

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

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

Как войти на портал

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

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

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

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

Как создать аккаунт пользователя на интегрированном портале

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

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

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

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

    Откроется страница входа.

  3. Нажмите Создать аккаунт.

    Откроется страница создания аккаунта.

    Диалоговое окно "Создать аккаунт"

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

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

  5. Прочитайте и примите условия.

  6. Нажмите Создать аккаунт.

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

    Аккаунт пользователя будет создан, и ему будет отправлено письмо с подтверждением.

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

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

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

Как войти на интегрированный портал

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

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

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

Как изменить пароль

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

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

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

    На указанный адрес электронной почты будет отправлена ссылка для сброса пароля.

  6. Нажмите на ссылку в письме с подтверждением.

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

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

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

Как войти на портал с помощью аутентификации SAML (бета-версия)

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

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

  3. Нажмите login with SAML (войти с помощью 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 или секрет и нажмите delete-icon, чтобы скопировать его в буфер обмена.

Как провести ротацию ключа 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. Нажмите Подтвердить.

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