Связь между порталом на базе Drupal и Edge

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

Портал Developer Services выступает в качестве клиента для Apigee Edge. Это означает, что портал не функционирует как автономная система. Вместо этого большая часть информации, используемой порталом, фактически хранится в Edge. При необходимости портал отправляет запрос HTTP или HTTPS для получения информации из Edge или для отправки информации в Edge.

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

Настройте соединение между порталом и Edge

Портал должен сообщать Edge три вида информации, как указано ниже.

  • URL-адрес конечной точки Edge

    Конечная точка по умолчанию для облачной версии Edge — https://api.enterprise.apigee.com/v1 .

    Для установки частного облака URL-адрес имеет следующий вид: http:// EdgePrivateCloudIp :8080/v1 или https:// EdgePrivateCloudIp : TLSport /v1 .

    Где EdgePrivateCloudIp — это IP-адрес сервера Edge Management Server, а TLSport — это порт TLS/SSL для API управления Edge. Например, 8443.
  • Название организации Apigee

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

    Вызовы с портала в Edge аутентифицируются и требуют пользователя с правами администратора разработчика . Когда для вас предоставляется портал разработчика, в вашу организацию добавляется роль администратора разработчика. Эта роль, включающая одного пользователя с именем devadmin+{org_name}@apigee.com , предназначена исключительно для подключения вашего портала разработчика к вашей организации Edge. Поскольку на портале отображаются ваши приложения для разработчиков Edge, продукты API и т. д., он должен синхронизироваться с вашей организацией Edge, выполняя вызовы API управления, требующие аутентификации. «Пользователь» devadmin имеет необходимые разрешения.

Чтобы просмотреть информацию о подключении:

  1. В меню администрирования Drupal выберите «Конфигурация» > «Портал разработки» > «Настройки приложения» .

Чтобы изменить конфигурацию:

Способ изменения конфигурации зависит от установки и версии портала:

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

Обеспечение доступа к Edge с портала

Поскольку большая часть информации, используемой порталом, хранится в Edge, вы должны убедиться, что портал имеет доступ к Edge. Портал инициирует связь с Edge, отправляя запросы REST через HTTP и HTTPS. Например, когда разработчик регистрирует новое приложение на портале, портал отправляет Edge запрос на отправку информации о приложении в Edge.

И Edge, и портал можно развернуть в облаке или локально, при этом вы можете смешивать типы развертываний. Например, вы можете развернуть оба в облаке, оба локально или развернуть один в облаке и один локально:

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

Видео: посмотрите короткое видео, чтобы узнать больше о том, как портал разработчика взаимодействует с Apigee Edge, и убедиться, что соединение работает.

Управление приложениями и ключами API с портала

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

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

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

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

Если разработчик затем добавляет, удаляет или изменяет приложение, портал отправляет эти изменения в Edge.

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

  • Добавить, удалить или изменить приложение разработчика
  • Отозвать или утвердить ключ API для приложения

Ниже показано то же приложение «Моя погода», как оно отображается администратору в пользовательском интерфейсе Edge:

Управление разработчиками с портала

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

Информация о разработчике, хранящаяся в Edge, включает в себя:

  • Имя
  • Фамилия
  • Адрес электронной почты
  • Необязательная дополнительная информация, отправленная с портала

Портал хранит ту же информацию, что и Edge, но также хранит дополнительную информацию, в том числе:

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

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

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

Дополнительную информацию см. в разделе Добавление учетных записей пользователей и управление ими .

Синхронизация разработчиков приложений между порталом и Edge

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

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

Синхронизировать портал с разработчиками приложений в Edge

:
  • Войдите на свой портал как пользователь с правами администратора или создания контента.
  • Выберите «Люди» в меню администрирования Drupal.
  • Нажмите кнопку «Синхронизация разработчиков портала разработки» в верхней части страницы, чтобы синхронизироваться с разработчиками приложений в Edge.
,

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

Портал Developer Services выступает в качестве клиента для Apigee Edge. Это означает, что портал не функционирует как автономная система. Вместо этого большая часть информации, используемой порталом, фактически хранится в Edge. При необходимости портал отправляет запрос HTTP или HTTPS для получения информации из Edge или для отправки информации в Edge.

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

Настройте соединение между порталом и Edge

Портал должен сообщать Edge три вида информации, как указано ниже.

  • URL-адрес конечной точки Edge

    Конечная точка по умолчанию для облачной версии Edge — https://api.enterprise.apigee.com/v1 .

    Для установки частного облака URL-адрес имеет следующий вид: http:// EdgePrivateCloudIp :8080/v1 или https:// EdgePrivateCloudIp : TLSport /v1 .

    Где EdgePrivateCloudIp — это IP-адрес сервера Edge Management Server, а TLSport — это порт TLS/SSL для API управления Edge. Например, 8443.
  • Название организации Apigee

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

    Вызовы с портала в Edge аутентифицируются и требуют пользователя с правами администратора разработчика . Когда для вас предоставляется портал разработчика, в вашу организацию добавляется роль администратора разработчика. Эта роль, включающая одного пользователя с именем devadmin+{org_name}@apigee.com , предназначена исключительно для подключения вашего портала разработчика к вашей организации Edge. Поскольку на портале отображаются ваши приложения для разработчиков Edge, продукты API и т. д., он должен синхронизироваться с вашей организацией Edge, выполняя вызовы API управления, требующие аутентификации. «Пользователь» devadmin имеет необходимые разрешения.

Чтобы просмотреть информацию о подключении:

  1. В меню администрирования Drupal выберите «Конфигурация» > «Портал разработки» > «Настройки приложения» .

Чтобы изменить конфигурацию:

Способ изменения конфигурации зависит от установки и версии портала:

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

Обеспечение доступа к Edge с портала

Поскольку большая часть информации, используемой порталом, хранится в Edge, вы должны убедиться, что портал имеет доступ к Edge. Портал инициирует связь с Edge, отправляя запросы REST через HTTP и HTTPS. Например, когда разработчик регистрирует новое приложение на портале, портал отправляет Edge запрос на отправку информации о приложении в Edge.

И Edge, и портал можно развернуть в облаке или локально, при этом вы можете смешивать типы развертываний. Например, вы можете развернуть оба в облаке, оба локально или развернуть один в облаке и один локально:

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

Видео: посмотрите короткое видео, чтобы узнать больше о том, как портал разработчика взаимодействует с Apigee Edge, и убедиться, что соединение работает.

Управление приложениями и ключами API с портала

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

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

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

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

Если разработчик затем добавляет, удаляет или изменяет приложение, портал отправляет эти изменения в Edge.

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

  • Добавить, удалить или изменить приложение разработчика
  • Отозвать или утвердить ключ API для приложения

Ниже показано то же приложение «Моя погода», как оно отображается администратору в пользовательском интерфейсе Edge:

Управление разработчиками с портала

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

Информация о разработчике, хранящаяся в Edge, включает в себя:

  • Имя
  • Фамилия
  • Адрес электронной почты
  • Необязательная дополнительная информация, отправленная с портала

Портал хранит ту же информацию, что и Edge, но также хранит дополнительную информацию, в том числе:

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

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

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

Дополнительную информацию см. в разделе Добавление учетных записей пользователей и управление ими .

Синхронизация разработчиков приложений между порталом и Edge

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

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

Синхронизация портала с разработчиками приложений в Edge

:
  • Войдите на свой портал как пользователь с правами администратора или создания контента.
  • Выберите «Люди» в меню администрирования Drupal.
  • Нажмите кнопку «Синхронизация разработчиков портала разработки» в верхней части страницы, чтобы синхронизироваться с разработчиками приложений в Edge.