Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация
Apigee Edge – это платформа для разработки API и управления ими. Используя прокси-серверы, Edge предоставляет абстракцию или фасад для API бэкенд-служб, а также обеспечивает безопасность, ограничение частоты запросов, квоты, статистику и многое другое.
Например, вы можете посмотреть вебкаст о том, как Walgreens использует API и Apigee Edge, чтобы создать обширную экосистему приложений для печати фотографий, получения рецептов и других услуг.
Цифровая трансформация
В этом видео рассказывается, как Apigee помогает развивать цифровой бизнес.
Выбор между управлением сервисами и управлением API
В этом видео рассказывается о важных различиях между управлением сервисами и управлением API. отделу компании.
Как сделать свои сервисы доступными в интернете
Сегодня компании хотят сделать свои внутренние сервисы доступными в интернете, чтобы их могли использовать приложения, работающие на мобильных устройствах и компьютерах. Компания может захотеть предоставить доступ к сервисам, которые содержат информацию о ценах и наличии товаров, сервисам продаж и заказов, сервисам отслеживания заказов и любым другим сервисам, необходимым клиентским приложениям.
Компании часто предоставляют сервисы в виде набора конечных точек HTTP. Затем разработчики клиентских приложений отправляют HTTP-запросы к этим конечным точкам. В зависимости от конечной точки сервис может вернуть клиентскому приложению данные в формате XML или JSON.
Клиентские приложения, использующие эти сервисы, могут быть реализованы как отдельные приложения для мобильных устройств или планшетов, как приложения HTML5, работающие в браузере, или как приложения любого другого типа, которые могут отправлять запросы к конечной точке HTTP и использовать любые данные ответа. Эти приложения могут быть разработаны и выпущены той же компанией, которая предоставляет сервисы, или сторонними разработчиками, использующими общедоступные сервисы.
На изображении ниже показана такая модель.
Поскольку поставщики предоставляют свои услуги через интернет, они должны предпринять все необходимые меры для защиты своих сервисов от несанкционированного доступа. Поставщикам услуг следует учитывать следующее:
- Безопасность. Как вы будете контролировать доступ к своим сервисам, чтобы предотвратить несанкционированный доступ?
- Совместимость. Будут ли ваши сервисы работать на разных платформах и устройствах?
- Измеримость. Как вы отслеживаете доступность сервисов?
- Монетизация. Как вы отслеживаете и выставляете счета клиентам за доступ к своим сервисам?
- и многие другие факторы.
После выпуска клиентского приложения, которое обращается к каким-либо сервисам, поставщик услуг обязан обеспечить их дальнейшую работу при добавлении, изменении или удалении этих сервисов. Поставщик услуг также должен уведомлять разработчиков приложений о любых изменениях в сервисах, чтобы клиентские приложения оставались синхронизированными с этими сервисами.
Разработчики клиентских приложений сталкиваются с трудностями при использовании сервисов от разных поставщиков. Сегодня поставщики услуг могут использовать множество технологий, чтобы предоставлять свои сервисы. Одно и то же клиентское приложение может использовать один механизм для доступа к сервису одного поставщика и другой механизм для доступа к сервису другого поставщика. Разработчики приложений могут столкнуться с ситуацией, когда им приходится использовать разные механизмы для доступа к сервисам одного и того же поставщика.
Как сделать сервисы доступными через Apigee Edge
Apigee Edge позволяет предоставлять безопасный доступ к сервисам с помощью четко определенного API, который единообразен для всех сервисов независимо от их реализации. Единый API:
- Разработчикам приложений будет проще использовать ваши сервисы.
- Позволяет изменить реализацию бэкенд-службы, не затрагивая общедоступный API.
- Позволяет использовать встроенные в Edge функции аналитики, монетизации, портала разработчика и другие.
На изображении ниже показана архитектура, в которой Edge обрабатывает запросы от клиентских приложений к вашим серверным службам:
Вместо того чтобы разработчики приложений напрямую использовали ваши сервисы, они получают доступ к прокси-серверу API, созданному в Edge. Прокси-сервер API представляет собой сопоставление общедоступной конечной точки HTTP с вашей бэкенд-службой. Создавая прокси-сервер API, вы позволяете Edge обрабатывать задачи по обеспечению безопасности и авторизации, необходимые для защиты ваших сервисов, а также анализировать, отслеживать и монетизировать эти сервисы.
Поскольку разработчики приложений отправляют HTTP-запросы к прокси API, а не напрямую к вашим сервисам, им не нужно знать, как реализованы ваши сервисы. Разработчику нужно знать только следующее:
- URL конечной точки прокси API.
- Любые параметры запроса, заголовки или параметры тела, переданные в запросе.
- Любые необходимые учетные данные для аутентификации и авторизации.
- Формат ответа, в том числе формат данных ответа, например XML или JSON.
Прокси-сервер API изолирует разработчика приложений от вашей бэкенд-службы. Поэтому вы можете менять реализацию сервиса, если общедоступный API остается неизменным. Благодаря единообразному API клиентской части существующие клиентские приложения продолжат работать независимо от изменений в бэкенде.
Вы можете использовать правила в прокси-сервере API, чтобы добавить функции в сервис, не внося никаких изменений в бэкенд-службу. Например, вы можете добавить в прокси-сервер правила, чтобы выполнять преобразование и фильтрацию данных, повышать безопасность, выполнять условную логику или собственный код, а также выполнять многие другие действия. Важно помнить, что правила реализуются на платформе Edge, а не на внутреннем сервере.
Подробнее о API и прокси API…
Как создать продукт API
Прокси-сервер API – это конечная точка HTTP в Apigee Edge, которую разработчики используют для доступа к вашим внутренним сервисам. Хотя это возможно, обычно отдельные прокси API не предоставляются. Вместо этого вы группируете один или несколько прокси API в продукт API.
Продукт API – это набор прокси API, объединенных с тарифным планом. Этот контракт на обслуживание может устанавливать ограничения на доступ к прокси-серверам API, обеспечивать безопасность, разрешать мониторинг и статистику, а также предоставлять дополнительные функции. Продукты API также являются основным механизмом, который Edge использует для авторизации и контроля доступа к вашим API.
При создании продуктов API у вас будет много возможностей. Например, несколько продуктов API могут использовать один и тот же прокси-сервер API. На рисунке ниже показаны три продукта API. Обратите внимание, что все продукты предоставляют доступ к прокси API 3, но только продукт А – к прокси API 1.
Для каждого продукта API можно задать разные свойства. Например, вы можете предложить один продукт API с низким лимитом доступа (1000 запросов в день) по низкой цене. Затем вы выпускаете другой продукт API, который предоставляет доступ к тому же прокси API, но с гораздо более высоким лимитом доступа за более высокую цену. Или вы можете создать бесплатный продукт API, который предоставляет доступ к вашим сервисам только для чтения, а затем продавать продукт API для тех же прокси API, который предоставляет доступ для чтения и записи.
Подробнее о том, как управлять продуктами API…
Как разрешить клиентскому приложению доступ к продукту API
Если разработчик приложения хочет получить доступ к вашим сервисам, он должен сначала зарегистрировать клиентское приложение в вашем продукте API.
После регистрации разработчик приложений получает ключ API, который он должен включать в каждый запрос к прокси-серверу API, входящему в продукт API. Этот ключ проходит аутентификацию, и если она успешна, запросу разрешается доступ к вашей бэкенд-службе.
Вы можете в любой момент отозвать ключ, чтобы клиентское приложение больше не имело доступа к вашим сервисам. Вы также можете задать временное ограничение для ключа, чтобы разработчик должен был обновить его через определенный период времени.
Вы сами решаете, как обрабатывать запросы на регистрацию от разработчиков, которые хотят получить доступ к вашим продуктам API. С помощью сервисов для разработчиков Apigee Edge можно автоматизировать процесс регистрации или вручную управлять доступом.
Как создавать продукты API и предоставлять к ним доступ разработчикам
- Создайте один или несколько прокси API, которые сопоставляют общедоступные URL с вашими внутренними сервисами.
- Создайте продукт API, в который будут входить прокси API.
- Разверните прокси API и продукт API.
- Сообщите разработчикам, что продукт API доступен.
Когда разработчики узнают о доступности вашего API-продукта, они:
- Зарегистрировать клиентские приложения в вашем продукте API.
- Получите ключ API для продукта API.
- Отправляйте запросы к сервисам через прокси API (которые входят в состав продукта API) и передавайте ключ API с каждым запросом.
Компоненты Apigee Edge
Apigee Edge состоит из среды выполнения API, инструментов мониторинга и аналитики, а также сервисов для разработчиков, которые вместе образуют комплексную инфраструктуру для создания, защиты, управления и эксплуатации API.
На рисунке ниже показаны сервисы Edge:
Среда выполнения Edge API
Сервисы API Apigee Edge предназначены для создания и использования API. Вы можете создавать прокси API как поставщик услуг или использовать API, SDK и другие удобные сервисы как разработчик приложений.
Сервер управления API предоставляет инструменты для добавления и настройки прокси API, создания продуктов API, а также управления разработчиками приложений и клиентскими приложениями. Он снимает с ваших внутренних сервисов многие распространенные задачи по управлению. При добавлении прокси-сервера API вы можете применить к нему правила, чтобы повысить безопасность, ограничить частоту запросов, настроить медиацию, кеширование и т. д. Вы также можете настроить поведение прокси-сервера API, применив собственные скрипты, выполнив вызовы к сторонним API и сервисам и т. д. Подробнее о API и прокси API…
Если вы разработчик Node.js, вы можете легко добавлять модули Node.js в Edge, чтобы создавать API и их комбинации, используя все преимущества Edge, от преобразования сообщений до безопасности и аналитики.
Мониторинг и анализ на периферии
Apigee Edge API Analytics предоставляет мощные инструменты для отслеживания краткосрочных и долгосрочных тенденций использования ваших API. Вы можете сегментировать аудиторию по лучшим разработчикам и приложениям, анализировать использование по методу API, чтобы понять, куда инвестировать средства, а также создавать специальные отчеты на уровне бизнеса или операций.
Когда данные проходят через Edge, собираются различные типы информации по умолчанию, в том числе URL, IP-адрес, идентификатор пользователя для информации о вызове API, задержка, данные об ошибках и т. д. Вы можете создать правила, чтобы добавить другую информацию, например заголовки, параметры запроса и части запроса или ответа, извлеченные из XML или JSON. Эта информация собирается асинхронно по отношению к фактическому потоку запросов и ответов, поэтому не влияет на производительность API.
В интерфейсе управления можно просматривать несколько показателей и параметров в браузере, как показано на рисунке ниже.
Однако вы также можете получить доступ к сервису "Аналитика" и управлять им с помощью интерфейса командной строки или RESTful API. Подробнее об API Аналитики…
Экосистема разработчиков Edge
Apigee Edge предоставляет разработчикам сервисы, которые позволяют:
- Управляйте сообществом разработчиков приложений, которые используют ваши сервисы.
- Сотрудничайте с внутренними и внешними разработчиками и формализуйте отношения с помощью финансовых моделей.
- Привлекать разработчиков и создать портал для разработчиков. Разработчики приложений подключаются к вашему порталу, чтобы получить доступ к документации по API, узнать больше о ваших общедоступных продуктах API и управлять ключами API.
Каждый клиент Edge может создать собственный портал для разработчиков в облаке или локально с помощью Apigee Edge для частного облака.
В Apigee Edge можно создавать два типа порталов:
- Встроенный портал, который можно быстро настроить. Подробнее о том, как создать интегрированный портал…
- Портал на основе Drupal. Подробнее о том, как создать портал на основе Drupal…
Монетизация
Возможности монетизации предоставляют финансовую инфраструктуру и связи, необходимые для того, чтобы превратить сообщество разработчиков в канал для ваших цифровых активов. Монетизация позволяет создавать различные тарифные планы, в соответствии с которыми разработчики платят за использование ваших продуктов API или вы платите разработчикам в рамках соглашений о разделе дохода.
К ним относятся тарифные планы с предоплатой, тарифные планы с постоплатой, тарифные планы с фиксированной платой, тарифные планы с переменной платой, тарифные планы с бесплатным доступом к базовым функциям, тарифные планы, разработанные специально для определенных разработчиков, тарифные планы, распространяющиеся на группы разработчиков, и т. д. Кроме того, монетизация включает отчеты и платежи.
Подробнее о монетизации…
Версии браузера Edge
Apigee Edge предлагается в следующих вариантах:
- Облако. Размещенная версия SaaS, в которой Apigee поддерживает среду, позволяя вам сосредоточиться на создании сервисов и определении API для этих сервисов.
- Частное облако. Локальная установка, в которой вы контролируете аппаратную среду и отвечаете за установку, обновление, обслуживание и другие административные процессы.
Если вас интересует гибридная версия Apigee, ознакомьтесь со следующими разделами Apigee X:
Функциональность версий для общедоступного и частного облака очень похожа. Однако версия для частного облака не поддерживает все функции версии для общедоступного облака. В частном облаке не поддерживаются следующие функции:
- Целевые страницы, размещенные на вашем сайте
- Расширения
- Интегрированные порталы для разработчиков (Примечание. Поддерживаются порталы для разработчиков на основе Drupal).
- Мониторинг API
- Sense
Список различий между версиями приведен в статье Сравнение продуктов Apigee.
Между API также есть незначительные различия, описанные в разделе Различия между API Edge для общедоступного облака и API частного облака.
Public Cloud поддерживает как бесплатные, так и платные аккаунты. Для использования частного облака требуются платные аккаунты.
Чтобы обеспечить полную поддержку локальной установки, версия Private Cloud включает такие компоненты, как сервер управления Apigee, базу данных NoSQL Apache Cassandra, сервер OpenLDAP, маршрутизатор сообщений и процессор сообщений.