Руководство по создавать и публиковать продукт;

ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API

В службе Управления API Azure продукт содержит один или несколько API, использование квоты и условия использования. Как только продукт будет опубликован, разработчики могут подписаться на него и начать использовать API продукта.

В этом руководстве описано следующее:

• Создание и публикация продукта
• добавлять API к продукту.
• Доступ к API продукта

Необходимые компоненты

• Ознакомьтесь с терминологией службы управления API в Azure.
• Выполните задачи в кратком руководстве по созданию экземпляра службы управления API Azure.
• Также выполните задачи из руководства по импорту и публикации первого API.

Создание и публикация продукта

Портал

1. Войдите на портал Azure и перейдите к своему экземпляру службы Управления API.

2. На панели навигации слева выберите Продукты>+ Добавить.

   

3. В окне Добавить продукт введите значения, описанные в следующей таблице, чтобы создать продукт.

   

   Имя	Описание
   Показать имя	Имя, которое будет отображаться на портале разработчика.
   Description	Укажите подробные сведения о продукте, например его назначение, интерфейсы API, к которым он предоставляет доступ, и другую информацию.
   State	Нажмите кнопку Опубликовано, чтобы опубликовать продукт. Прежде чем можно будет вызывать интерфейсы API в продукте, сам продукт должен быть опубликован. По умолчанию новые продукты не опубликованы и видны только группе Администраторов.
   Требуется подписка	Выберите, требуется ли пользователю подписаться на продукт (продукт защищен), а ключ подписки должен использоваться для доступа к API продукта. Если подписка не требуется (продукт открыт), ключ подписки не требуется для доступа к API продукта. См. раздел Доступ к API продукта далее в этой статье.
   Запрос утверждения	Укажите, требуется ли, чтобы администратор рассматривал и принимал или отклонял попытки подписаться на этот продукт. Если флажок не установлен, попытки подписаться будут утверждаться автоматически.
   Ограничение числа подписок	При необходимости ограничьте число одновременных подписок.
   Юридические условия	Можно указать условия использования продукта, которые должны принимать подписчики, если они хотят использовать этот продукт.
   Программные интерфейсы	Выберите один или несколько API. Вы также можете добавить API после создания продукта. Дополнительные сведения см. в разделе Добавление API к продукту далее в этой статье. Если продукт открыт (не требует подписки), можно добавить только API, который не связан с другим открытым продуктом.

4. Щелкните Создать, чтобы создать новый продукт.

Внимание

Будьте осторожны при настройке продукта, для которого не требуется подписка. Эта конфигурация может предоставлять слишком много разрешений и повышать уязвимость API продукта к некоторым угрозам безопасности API.

Azure CLI

Чтобы начать работу с Azure CLI:

• Используйте среду Bash в Azure Cloud Shell. Дополнительные сведения см . в кратком руководстве по Bash в Azure Cloud Shell.

  

• Если вы предпочитаете выполнять справочные команды CLI локально, установите Azure CLI. Если вы работаете в Windows или macOS, Azure CLI можно запустить в контейнере Docker. Дополнительные сведения см. в статье Как запустить Azure CLI в контейнере Docker.

  • Если вы используете локальную установку, выполните вход в Azure CLI с помощью команды az login. Чтобы выполнить аутентификацию, следуйте инструкциям в окне терминала. Сведения о других возможностях, доступных при входе, см. в статье Вход с помощью Azure CLI.

  • Установите расширение Azure CLI при первом использовании, когда появится соответствующий запрос. Дополнительные сведения о расширениях см. в статье Использование расширений с Azure CLI.

  • Выполните команду az version, чтобы узнать установленную версию и зависимые библиотеки. Чтобы обновиться до последней версии, выполните команду az upgrade.

Чтобы создать продукт, выполните команду az apim product create.

az apim product create --resource-group apim-hello-word-resource-group \
    --product-name "Contoso product" --product-id contoso-product \
    --service-name apim-hello-world --subscription-required true \
    --state published --description "This is a test."

Вы можете указать разные значения для этого продукта:

Параметр	Описание
--product-name	Имя, которое будет отображаться на портале разработчика.
--description	Укажите подробные сведения о продукте, например его назначение, интерфейсы API, к которым он предоставляет доступ, и другую информацию.
--state	Щелкните Опубликовано, чтобы опубликовать продукт. Прежде чем можно будет вызывать интерфейсы API в продукте, сам продукт должен быть опубликован. По умолчанию новые продукты не опубликованы и видны только группе Администраторов.
--subscription-required	Выберите, требуется ли пользователю подписаться на продукт (продукт защищен) или подписка не требуется (продукт открыт). См. раздел Доступ к API продукта далее в этой статье.
--approval-required	Укажите, требуется ли, чтобы администратор рассматривал и принимал или отклонял попытки подписаться на этот продукт. Если флажок не установлен, попытки подписаться будут утверждаться автоматически.
--subscriptions-limit	При необходимости ограничьте число одновременных подписок.
--legal-terms	Можно указать условия использования продукта, которые должны принимать подписчики, если они хотят использовать этот продукт.

Внимание

Будьте осторожны при настройке продукта, для которого не требуется подписка. Эта конфигурация может предоставлять слишком много разрешений и повышать уязвимость API продукта к некоторым угрозам безопасности API.

Чтобы просмотреть текущие продукты, выполните команду az apim product list.

az apim product list --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --output table

Чтобы удалить продукт, выполните команду az apim product delete:

az apim product delete --product-id contoso-product \
    --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --delete-subscriptions true

Добавление дополнительных конфигураций

Продолжайте настройку продукта после его сохранения. В экземпляре управления API выберите продукт в окне Продукты. Добавление или обновление:

Позиция	Description
Настройки	Метаданные и состояние продукта
Программные интерфейсы	API, связанные с продуктом
Политики	Политики, применяемые к API продукта
Управление доступом	Видимость продукта для разработчиков или гостей
Подписки	Подписчики продукта

Добавление интерфейсов API в продукт

Продуктами называют ассоциации из одного или нескольких API. В продуктах можно объединить много API-интерфейсов и предлагать их разработчикам через портал разработчика. Во время создания продукта можно добавить один или несколько существующих API. API также можно добавить к продукту позже с помощью страницы Настройки для продуктов или при создании самого API.

Добавление API к существующему продукту

Портал

1. В области навигации экземпляра управления API слева выберите Продукты.
2. Выберите продукт, а затем выберите API.
3. Выберите Add API Key (Добавить ключ API).
4. Выберите один или несколько API, а затем нажмите Выбрать.

Azure CLI

1. Чтобы просмотреть управляемые API, выполните команду az apim api list:

   az apim api list --resource-group apim-hello-word-resource-group \
       --service-name apim-hello-world --output table
   

2. Чтобы добавить API в продукт, выполните команду az apim product api add:

   az apim product api add --resource-group apim-hello-word-resource-group \
       --api-id demo-conference-api --product-id contoso-product \
       --service-name apim-hello-world
   

3. Чтобы проверить добавление, выполните команду az apim product api list:

   az apim product api list --resource-group apim-hello-word-resource-group \
       --product-id contoso-product --service-name apim-hello-world --output table
   

Чтобы удалить API из продукта, выполните команду az apim product api delete :

az apim product api delete --resource-group apim-hello-word-resource-group \
    --api-id demo-conference-api --product-id contoso-product \
    --service-name apim-hello-world

Доступ к API продукта

После публикации продукта разработчики могут получить доступ к API. В зависимости от настройки продукта может потребоваться подписаться на продукт для доступа.

• Защищенный продукт — разработчики должны сначала подписаться на защищенный продукт, чтобы получить доступ к API продукта. После этого они получат ключ подписки, который подходит для доступа к любому API в этом продукте. Создавая экземпляр Управления API, вы автоматически становитесь его администратором. Поэтому вы по умолчанию будете подписаны на все соответствующие продукты. См. дополнительные сведения о Подписках в службе Управления API Azure.

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

  Совет

  Подписку пользователя на продукт с индивидуальными ключами подписки можно создать или обновить с помощью REST API или команды PowerShell.

• Открыть продукт — разработчики могут получить доступ к API открытого продукта без ключа подписки. Однако вы можете настроить другие механизмы для защиты клиентского доступа к API, включая OAuth 2.0, сертификаты клиента и ограничение IP-адресов вызывающего абонента.

  Примечание.

  Открытые продукты не перечислены на портале разработчиков, чтобы узнать о них или подписаться на них. Они видны только группе Администратор istrators. Вам потребуется использовать другой механизм для информирования разработчиков о API, к которым можно получить доступ без ключа подписки.

  Когда клиент выполняет запрос API без ключа подписки:

  • Управление API проверяет, связан ли API с открытым продуктом. API можно связать не более чем с одним открытым продуктом.

  • Если открытый продукт существует, он обрабатывает запрос в контексте открытого продукта. Политики и правила управления доступом, настроенные для продукта, можно применить.

Дополнительные сведения см. в статье о том, как Управление API обрабатывает запросы с ключами подписки или без нее.

Следующие шаги

Из этого руководства вы узнали, как:

• Создание и публикация продукта
• добавлять API к продукту.
• Доступ к API продукта

Перейдите к следующему руководству:

Create blank API and mock API responses (Создание пустого API и имитация ответов API)