Как разработчики приложений взаимодействуют с вашим порталом (оригинальная версия)

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

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

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

Как в Edge отслеживаются регистрация и вход разработчиков приложений

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

Когда разработчик самостоятельно регистрируется, в конфигурацию разработчика добавляется настраиваемый атрибут _apiportal, а статус разработчика устанавливается на значение unverified, указывающее, что разработчик не вошел на портал. Пример: {"status":"unverified","portals":{}}

Когда разработчик впервые входит на портал, настраиваемый атрибут _apiportal обновляется, чтобы отслеживать название портала и время доступа, а статус разработчика меняется на active. Каждый раз, когда разработчик входит на портал, настраиваемый атрибут обновляется, чтобы сбросить значение lastVisit (в формате epoch) для этого портала. Пример: {"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}

Как зарегистрировать аккаунт разработчика приложений

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

Когда разработчик приложений регистрируется на вашем портале:

• Информация о разработчике приложения создается и хранится в Edge. Подробнее о том, где хранятся данные аккаунта разработчика…
• Разработчик приложения указан в списке зарегистрированных разработчиков. Подробнее о том, как найти страницу разработчика…

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

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

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

3. Выберите Sign up (Зарегистрироваться).
   Откроется диалоговое окно.

   

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

5. Нажмите Создать.
   Откроется диалоговое окно.

   

6. Нажмите на защищенную ссылку в письме, чтобы открыть портал и установить сеанс с аутентификацией.

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

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

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

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

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

4. Нажмите Войти.
   Откроется диалоговое окно.

   

5. Нажмите на защищенную ссылку в письме, чтобы открыть портал и установить сеанс с аутентификацией.

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

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

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

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

Разработчики приложений могут управлять продуктами API в своих приложениях. Товары, добавленные через API, появятся на странице сведений о приложении. Для некоторых продуктов API одобрение не предоставляется автоматически. Статус Ожидание означает, что доступ к продукту API запрошен, но ещё не предоставлен.

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

1. В раскрывающемся меню выберите Мои приложения.
2. Нажмите на название приложения.
3. Нажмите Управление товарами.

4. Нажмите на переключатель Доступ, чтобы разрешить или запретить приложению доступ к продукту API.

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

5. Нажмите Запросить, чтобы запросить разрешение на использование продукта API, который ещё не разрешен.

6. Нажмите Сохранить.

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

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

1. В раскрывающемся меню выберите Мои приложения.
2. Нажмите на название приложения.
3. Посмотрите ключ API в разделе Ключи.
4. Нажмите Посмотреть секрет, чтобы увидеть секрет ключа API.
5. Убедитесь, что статус ключа API – "Одобрено".

Как провести ротацию ключа API для приложения

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

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

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

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

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

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

1. В раскрывающемся меню выберите Мои приложения.
2. Нажмите на название приложения.
3. В разделе "Ключи" нажмите История ключей, чтобы посмотреть список устаревших ключей.
4. Наведите курсор на устаревший ключ API, который нужно деактивировать, чтобы открыть меню действий.
5. Нажмите , чтобы развернуть меню действий.
6. Нажмите Деактивировать.
7. Нажмите Деактивировать, чтобы подтвердить операцию.
   Статус ключа изменится на "Аннулирован".

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

Разработчики приложений могут изменять информацию О приложении следующим образом:

1. В раскрывающемся меню выберите Мои приложения.
2. Нажмите на название приложения.
3. Измените поля "Название" или "Описание".
4. Нажмите Сохранить.

Приложение будет удалено и исчезнет из списка "Мои приложения".

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

Разработчики приложений могут удалить их из вашего портала. Для этого нужно:

1. В раскрывающемся меню выберите Мои приложения.
2. Нажмите на название приложения.
3. Нажмите Удалить в правом верхнем углу страницы.

Приложение будет удалено и исчезнет из списка "Мои приложения".