Вы просматриваете документацию 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, 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, обычно он используется как пользователь в другой организации или для использования служб Edge API. |
Приложение | Разработчики создают одно или несколько клиентских приложений, использующих ваши 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 разделены по комбинации организации и среды.
Ниже показаны основные объекты, которыми вы управляете в организации, включая те, которые определены глобально в организации, а также те, которые определены специально для среды:
