Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info
Организация — это контейнер верхнего уровня в 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-адреса при отправке запроса к API управления Edge. Например, типичный URL-адрес, используемый для доступа к API-прокси, имеет следующий вид:
http://org-name-env.apigee.net/v1/weather/forecastrss
где:
- org-name — это название вашей организации.
- env — это среда развертывания API-прокси, которая может быть тестовой или производственной.
Например:
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-прокси в сочетании с тарифным планом. Этот тарифный план может устанавливать ограничения доступа к API-прокси, обеспечивать безопасность, разрешать мониторинг и аналитику, а также предоставлять дополнительные функции. Edge собирает данные для аналитики API-продуктов. |
Разработчик | В организации работает один или несколько разработчиков, которые создают приложения, использующие API (объединенные в API-продукты), определенные вашей организацией. Разработчики используют API, но не могут создавать API или выполнять какие-либо другие действия в организации. Разработчики могут быть штатными сотрудниками вашей компании, партнерами или внешними разработчиками, которые платят за доступ к вашим API. Разработчики должны быть зарегистрированы в вашей организации, прежде чем они смогут зарегистрировать приложение и получить ключ API для доступа к вашим API. Как поставщик API, вы сами определяете, как добавлять, обновлять или удалять разработчиков в вашей организации. Вы можете добавлять их вручную через пользовательский интерфейс управления Edge, создать портал для разработчиков для их регистрации через веб-сайт или определить собственный механизм регистрации, используя API управления Edge. Разработчику не обязательно иметь учетную запись в Edge, и большинству разработчиков не нужно ничего знать об Edge. Если у разработчика и есть учетная запись в Edge, то, как правило, это пользователь из другой организации или для использования API-сервисов Edge. |
Приложение | Разработчики создают одно или несколько клиентских приложений, которые используют ваши API. Разработчики должны зарегистрировать свои приложения в вашей организации. Приложение в Edge представляет собой прототип реального приложения разработчика и предоставляет ему ключ API, который он передает с каждым запросом к вашим API. Поскольку все приложения зарегистрированы в вашей организации, вы можете использовать Edge для мониторинга и сбора аналитической информации о приложении и об использовании им ваших API. |
Ключ API/токен OAuth | В зависимости от механизма авторизации, который вы определяете для своих API, приложение передает ключ API вместе с каждым запросом к вашим API. Если этот ключ действителен, запрос разрешается. Edge поддерживает различные типы аутентификации, такие как простой ключ API, двухэтапная OAuth, трехэтапная OAuth и другие. Как поставщик API, вы должны определить способ регистрации приложений разработчиками. Именно путем регистрации приложения вы возвращаете разработчику ключ, необходимый для доступа к вашим API. При регистрации приложения разработчик может выбрать доступ к одному или нескольким API-продуктам. Фактическое приложение разработчика использует один и тот же ключ для доступа ко всем API-продуктам, связанным с приложением (зарегистрированное представление приложения разработчика в Edge). В любой момент вы можете отозвать ключ, чтобы приложение разработчика больше не имело доступа к вашим API (даже если зарегистрированное представление приложения разработчика все еще существует в вашей организации). Или вы можете установить ограничение по времени для ключа, чтобы разработчик должен был обновить ключ через определенное время. |
Об окружающей среде
Среда — это контекст выполнения API-прокси в организации. Для доступа к API-прокси необходимо развернуть его в определенной среде. API-прокси можно развернуть как в одной, так и в нескольких средах.
В организации может быть несколько сред. Например, в организации можно определить среду dev , test и prod .
Организация определяет область применения некоторых возможностей Apigee. Например, данные в формате «ключ-значение-карта» (KVM) могут быть доступны на уровне организации, что означает, что API-прокси, развернутые в любой среде, будут получать одни и те же данные из KVM. Некоторые возможности, такие как кэширование, могут быть ограничены рамками организации или конкретной среды внутри организации. Данные аналитики Apigee разделяются по сочетанию организации и среды.
Ниже представлены основные сущности, которыми вы управляете в организации, включая те, которые определены на глобальном уровне в организации, и те, которые определены специально для конкретной среды:
