Поделиться через


Как Управление API поддерживает монетизацию

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

С помощью платформы службы Управление API Azure можно выполнять следующие действия:

  • Публикация API-интерфейсов, на которые подписаны ваши потребители.
  • Исключение рисков.
  • Ускорение графика реализации проекта.
  • Уверенное масштабирование API-интерфейсов.

В этом документе рассматриваются функции Управления API, которые позволяют реализовать стратегию монетизации, например, обеспечивая беспроблемную работу для выполнения следующих действий:

  • Обнаружение общедоступных API.
  • Ввод сведений для оплаты.
  • Активация подписки.
  • Использование API.
  • Мониторинг использования.
  • Автоматическая оплата за использование API.

На схеме ниже представлены основные функции Управления API.

Схема основных функций монетизации Управления API

Обнаружение API

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

Дополнительные сведения о добавлении содержимого и управлении фирменной символикой портала разработчика см. в обзоре портала разработчика.

Упаковка API

Управление API позволяет управлять упаковкой и представлением API-интерфейсов, применяя концепции продуктов и политик.

Продукты

Интерфейсы API публикуются через продукты. Продукты позволяют определить следующее:

  • Интерфейсы API, к которым может получить доступ подписчик.
  • Конкретные политики регулирования, например, применяющие к определенной подписке ограничения в виде месячной квоты вызовов.

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

Настройте продукты Управления API, чтобы упаковать базовый API для отражения модели дополучения дохода, включая следующее:

  • Отношение "один к одному" между каждым уровнем в модели получения дохода.
  • Соответствующий продукт Управления API.

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

Политики

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

Компонент политики Description
План продаж Определяет общее число вызовов, которые пользователь может выполнить в API за определенный период времени. Например, "100 вызовов в месяц". Когда пользователь достигает квоты, вызовы API завершаются ошибкой, и вызывающий объект получает код состояния отклика 403 Forbidden.
Ограничение скорости Определяет количество вызовов в течение скользящего временного интервала, которые можно выполнить в API. Например, "200 вызовов в минуту". Предназначено для предотвращения возникновения пиковых нагрузок при использовании API, выходящих за пределы оплачиваемого уровня качества обслуживания выбранного продукта. При превышении предела вызовов вызывающий объект получает код состояния ответа 429 Too Many Requests.

Дополнительные сведения о политиках см. в документации по Политикам в службе "Управление API" Azure.

Потребление API

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

  1. Пользователи API устанавливают подписки API при регистрации для конкретного продукта Управления API.
  2. Интегрируйте процесс подписки с поставщиком платежных услуг с помощью делегирования Управления API.
  3. После успешного предоставления сведений об оплате пользователи получают доступ к API с помощью созданного уникального ключа безопасности для подписки.

См. дополнительные сведения о подписках см. в документации Подписки в службе "Управление API" Azure.

Отслеживание использования API

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

  • API
  • Географический регион
  • Операции API
  • Продукт
  • Запросить
  • Отток подписок
  • Время
  • User

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

Дополнительные сведения см. в статье Получение аналитики в службе управления API Azure.

Безопасность

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

Интеграция

Обеспечьте простую работу с монетизацией с помощью интерфейсной интеграции и интеграции серверной части между Управлением API и выбранным поставщиком платежных услуг. Используйте делегирование Управления API для интерфейсной интеграции и REST API для интеграции серверной части.

Делегирование

В примерах проектов можно использовать делегирование Управления API для создания пользовательских интеграций со сторонними поставщиками платежных услуг. В демонстрационной версии используется делегирование как для регистрации или входа, так и для подписки на продукт.

Рабочий процесс регистрации и входа

  1. Разработчик щелкает ссылку для входа или регистрации на портале разработчика APIM.
  2. Браузер перенаправляется на конечную точку делегирования (настроенную для страницы в приложении пользовательского портала управления счетами).
  3. Приложение пользовательского портала управления счетами представляет пользовательский интерфейс для входа или регистрации.
  4. После успешного входа или регистрации пользователь проходит проверку подлинности и перенаправляется обратно на начальную страницу портала разработчика Управления API.

Рабочий процесс подписки на продукт

  1. Разработчик выбирает продукт на портале разработчика APIM и щелкает кнопку Подписаться.
  2. Браузер перенаправляется на конечную точку делегирования (настроенную для страницы в приложении пользовательского портала управления счетами).
  3. Пользовательское приложение портала выставления счетов:
    • Представляет пользовательский интерфейс, настроенный в зависимости от поставщика платежных услуг (Stripe или Adyen).
    • Принимает пользователя с помощью соответствующего процесса извлечения.
  4. Пользователь перенаправляется обратно на начальную страницу продукта Управления API.
    • Продукт будет активным, а ключи API станут доступными.

REST API

Используйте REST API для Управления API, чтобы автоматизировать работу стратегии монетизации.

В примерах проектов API используется, чтобы программным путем выполнять следующее:

  • Получать продукты и политики Управления API, чтобы обеспечить синхронизированную конфигурацию схожих концепций у поставщиков платежных услуг, таких как Stripe.
  • Регулярно опрашивать Управление API, чтобы получить метрики использования API для каждой подписки и управлять процессом выставления счетов.

Дополнительные сведения см. в обзоре REST API Управления API Azure.

DevOps

Управление версиями и автоматизация изменений развертывания в управлении API с помощью Azure Resource Manager, включая настройку функций, реализующих стратегию монетизации, например:

  • Продукты
  • Политики
  • Портал разработчика

В примерах проектов Azure Resource Manager скрипты дополняются JSON-файлом, который определяет модель ценообразования для каждого продукта Управления API. С помощью этого дополнения можно синхронизировать конфигурацию между Управлением API и выбранным поставщиком платежных услуг. Все решение управляется в рамках одного репозитория системы управления версиями, чтобы:

  • Координировать все изменения, связанные с развитием текущей стратегии монетизации, как единый выпуск.
  • Вносить изменения, следуя требованиям к управлению и аудиту.

Инициализация и развертывание

Управление API можно развернуть, используя следующее:

  • Пользовательский интерфейс портала Azure, или
  • Подход "инфраструктура как код" с помощью шаблонов Azure Resource Manager.

Видео

Интеграция службы "Управление API" с помощью платежного шлюза Adyen

Интеграция службы "Управление API" с помощью платежного шлюза Stripe

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