Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация
Организация – это контейнер верхнего уровня в Apigee Edge. Он содержит все прокси API и связанные с ними ресурсы. Ниже мы подробнее расскажем об организациях, а пока приведем несколько практических советов:
- По умолчанию название организации входит в URL, используемый для вызова прокси API, как описано в разделе О виртуальных хостах.
Пример:
http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
- Название вашей организации указано в URL интерфейса управления Edge. Например, по следующему URL можно посмотреть прокси API для организации
docs:
- Вы можете принадлежать к нескольким организациям в качестве пользователя или администратора с определенными разрешениями. Если в интерфейсе управления Edge вы принадлежите к нескольким организациям, вы можете переключаться между ними, как описано в разделе Переключение между организациями.
- Когда вы совершаете вызовы с помощью API управления как пользователь с ролью администратора организации, в большинстве вызовов организация является обязательной частью пути. Например, следующий запрос cURL к API управления возвращает список всех прокси API в организации:
curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address
Видео. Посмотрите короткое видео о том, как организации поддерживают многопользовательскую архитектуру для управления API.
Компоненты организации
При создании аккаунта Edge автоматически создается организация. После этого вы сможете добавлять пользователей в организацию, создавать прокси API и продукты API, а также регистрировать разработчиков и приложения.
На изображении ниже показаны основные компоненты организационной модели Edge. Эта модель определяет, как ваши API, продукты API, приложения и разработчики приложений связаны в Edge.
Эта модель не показывает все функции Apigee Edge. Если вы включили монетизацию, в модели будут дополнительные компоненты. Подробнее о монетизации… Подробнее о том, как управлять компаниями и разработчиками с монетизацией…
Названия организаций
Название организации:
- Организация, проводящая оценку:
username-eval - Платная версия. Определяется пользователем при первоначальной инициализации.
После создания организации ее название изменить нельзя.
Название организации становится частью URL прокси API и частью URL при отправке запроса к Edge Management API. Например, типичный URL, используемый для доступа к прокси-серверу API, имеет следующий вид:
http://org-name-env.apigee.net/v1/weather/forecastrss
где:
- org-name – название вашей организации.
- env – это среда развертывания прокси-сервера API, которая может быть тестовой (test) или рабочей (prod).
Пример:
http://myorg-test.apigee.net/v1/weather/forecastrss
Компоненты организации
В таблице ниже приведено более подробное описание компонентов организационной модели.
| Компонент | Описание |
|---|---|
|
Организация |
Каждый аккаунт Apigee сопоставляется с одной или несколькими организациями в Apigee Edge. Организация содержит представление всех компонентов, включая прокси API, продукты API, пакеты API, приложения и разработчиков. Владельцы аккаунтов могут быть связаны с несколькими организациями. Некоторые владельцы аккаунтов могут быть членами нескольких организаций, поддерживающих разные сообщества разработчиков приложений. |
| Среда | Контекст выполнения API-прокси в организации. Подробнее о средах рассказывается в разделе ниже. |
|
Пользователь |
Если вы создаете аккаунт в организации, где пользователь, создающий аккаунт, автоматически становится администратором, вы можете создать больше пользователей. Пользователи составляют команду API организации, в которую могут входить администраторы, создатели прокси API и продуктов API, пользователи, отслеживающие аналитику и другую статистику, и другие. У разных пользователей могут быть разные роли и права доступа. Например, назначьте некоторым пользователям роли администраторов организации и операций с правами на изменение организации и ее компонентов. Определите других пользователей с разрешениями на создание прокси API и продуктов API, но без прав на изменение других пользователей. Пользователи могут быть участниками нескольких организаций. Например, ваша компания может определить несколько организаций в Apigee Edge для поддержки разных сообществ разработчиков. Однако внутри компании одни и те же сотрудники создают все прокси API и продукты API, поэтому они являются членами всех ваших организаций. Чтобы стать пользователем, не нужно создавать аккаунт Apigee, то есть организацию Apigee. Администратор может добавить вас в существующую организацию. Все пользователи входят в Apigee Edge на странице https://enterprise.apigee.com. |
|
прокси-сервер API |
Пользователи в организации создают один или несколько прокси API. Прокси-сервер API определяет сопоставление общедоступной конечной точки HTTP с бэкенд-службой. Прокси API также можно настроить так, чтобы они обеспечивали безопасность (например, с помощью OAuth), преобразовывали сообщения (например, из XML в JSON), ограничивали трафик в серверные сервисы и выполняли другие полезные операции с запросом, ответом и вызовами сервисов. Edge собирает данные для анализа прокси API. |
|
Продукт API |
Пользователи в организации создают один или несколько продуктов API, каждый из которых представляет собой набор прокси API, объединенных с тарифным планом. Этот контракт на обслуживание может устанавливать ограничения на доступ к прокси-серверам API, обеспечивать безопасность, разрешать мониторинг и статистику, а также предоставлять дополнительные функции. Edge собирает данные для аналитики продуктов API. |
|
Разработчик |
Организация содержит одного или нескольких разработчиков, которые создают приложения, использующие API (объединенные в продукты API), определенные вашей организацией. Разработчики используют API, но не могут создавать их или выполнять другие действия в организации. Разработчики могут быть сотрудниками вашей компании, партнерами или внешними разработчиками, которые платят за доступ к вашим API. Разработчики должны быть зарегистрированы в вашей организации, чтобы иметь возможность зарегистрировать приложение и получить ключ API для доступа к вашим API. Как поставщик API, вы сами решаете, как добавлять, обновлять или удалять разработчиков в своей организации. Вы можете добавить их вручную через интерфейс управления Edge, создать портал для разработчиков для регистрации через сайт или определить собственный механизм регистрации с помощью API управления Edge. Разработчику не обязательно иметь аккаунт в Edge, и большинству из них не нужно ничего знать об этом браузере. Если у разработчика есть аккаунт в Edge, то, как правило, он используется в качестве аккаунта пользователя в другой организации или для доступа к сервисам Edge API. |
|
Для приложений |
Разработчики создают одно или несколько клиентских приложений, которые используют ваши API. Разработчики должны регистрировать свои приложения в вашей организации. Приложение в Edge – это представление реального приложения разработчика, которое предоставляет ему ключ API для передачи с каждым запросом к вашим API. Поскольку все приложения зарегистрированы в вашей организации, вы можете использовать Edge для мониторинга и сбора аналитической информации о приложении и его использовании ваших API. |
|
Ключ API или токен OAuth |
В зависимости от механизма авторизации, заданного для ваших API, приложение передает ключ API вместе с каждым запросом к ним. Если ключ действителен, запрос будет разрешен. Edge поддерживает различные типы аутентификации, например простой ключ API, двухсторонняя аутентификация OAuth, трехсторонняя аутентификация OAuth и другие. Как поставщик API, вы должны определить способ регистрации приложений разработчиками. Зарегистрировав приложение, вы передадите разработчику ключ, необходимый для доступа к вашим API. При регистрации приложения разработчик может выбрать один или несколько продуктов API. В настоящем приложении разработчика используется тот же ключ для доступа ко всем продуктам API, связанным с приложением (зарегистрированным представлением приложения разработчика в Edge). Вы можете в любой момент отозвать ключ, чтобы приложение разработчика больше не имело доступа к вашим API (даже если зарегистрированное представление приложения разработчика по-прежнему существует в вашей организации). Вы также можете задать временное ограничение для ключа, чтобы разработчик должен был обновить его по истечении определенного времени. |
О средах
Среда – это контекст выполнения API-прокси в организации. Чтобы получить доступ к прокси-серверу API, его необходимо развернуть в среде. Прокси API можно развернуть в одной или нескольких средах.
Организация может содержать несколько сред. Например, в организации можно определить среды dev, test и prod.
Организация определяет область действия некоторых функций Apigee. Например, данные из карты "ключ-значение" (KVM) можно сделать доступными на уровне организации. Это означает, что прокси API, развернутые в любой среде, будут получать одни и те же данные из KVM. Некоторые функции, например кеширование, можно настроить на уровне организации или определенной среды в организации. Данные аналитики Apigee разделяются по организации и среде.
Ниже перечислены основные объекты, которыми вы управляете в организации, в том числе определенные глобально в организации и определенные специально для среды:
