Понимание организаций

Вы просматриваете документацию по 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 :

    В URL-адресе apigee.com/organizations/docs/proxy /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.

На блок-схеме показано, как среда, пользователь, продукт API и разработчик связаны с приложением, ключом API/токеном OAuth и прокси-сервером API.

Эта модель не отображает все функции 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. Фактическое приложение разработчика использует тот же ключ для доступа ко всем продуктам API, связанным с приложением (зарегистрированное представление приложения разработчика в Edge).

В любой момент вы можете отозвать ключ, чтобы приложение разработчика больше не имело доступа к вашим API (даже если зарегистрированное представление приложения разработчика все еще существует в вашей организации). Или вы можете определить ограничение по времени для ключа, чтобы разработчик должен был обновить ключ через определенное время.

О средах

Среда — это контекст выполнения прокси-серверов API в организации. Вы должны развернуть прокси-сервер API в среде, прежде чем к нему можно будет получить доступ. Вы можете развернуть прокси-сервер API в одной среде или в нескольких средах.

Организация может содержать несколько сред. Например, вы можете определить среды dev , test и prod в организации.

Организация предоставляет возможности для некоторых возможностей Apigee. Например, данные карты «ключ-значение» (KVM) могут быть доступны на уровне организации, а это означает, что прокси-серверы API, развернутые в любой среде, будут получать те же данные из KVM. Некоторые возможности, такие как кэширование, могут быть привязаны к организации или к конкретной среде внутри организации. Данные аналитики Apigee разделены по комбинации организации и среды.

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