Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация
Публикация – это процесс, в результате которого ваши API становятся доступны разработчикам приложений.
Видео. В следующем видео рассказывается об основных принципах публикации с помощью API.
Публикация API включает следующие задачи, описанные в этой статье:
- Создайте в Edge продукты API, которые объединяют ваши API.
- Зарегистрируйте разработчиков приложений в Edge.
- Зарегистрируйте приложения разработчиков в Edge.
- Предоставляйте документацию и поддержку сообщества для своих API.
Задача 1. Создайте продукт API в Edge
Первая задача при публикации – создать продукт API. Продукт API – это набор ресурсов API, которые предлагаются разработчикам приложений в виде пакета. Создавайте продукты API с помощью API управления Edge или интерфейса. Подробнее о продуктах API…
На рисунке показан API, состоящий из двух продуктов, каждый из которых содержит три ресурса API.
Как поставщик API, вы отвечаете за создание API и продуктов API, которые поддерживают контроль доступа, ограничения на использование и другие бизнес-требования. Например, вы можете:
- Выпустите бесплатный продукт API, который предоставляет доступ только для чтения к ресурсам API.
- Выпустите второй продукт API по минимальной цене, который позволяет читать и записывать те же ресурсы API, что и бесплатная версия, но с низким лимитом доступа, например 1000 запросов в день.
- Выпустите третий продукт API по более высокой цене, который позволяет читать и записывать данные в тот же ресурс API, но с высоким лимитом доступа.
Важно помнить, что Edge позволяет создавать продукты API, соответствующие бизнес-требованиям ваших API.
Подробнее о том, как создавать продукты API…
Задача 2. Зарегистрируйте разработчика приложений в Edge
Разработчик создает приложения, которые используют ваши API. Разработчик приложения регистрируется в Apigee Edge, прежде чем регистрировать свое приложение. После регистрации приложения он получает ключ API, который предоставляет приложению доступ к API.
В процессе регистрации приложения вы можете указать, кто будет иметь доступ к вашим API. Вы можете в любой момент удалить разработчика приложений. В этом случае все ключи API, связанные с ним, станут недействительными, и разработчик потеряет доступ к вашим API.
Как поставщик API, вы сами решаете, как регистрировать разработчиков. Например, вы можете использовать процесс регистрации вручную, при котором потенциальный разработчик должен связаться с вашей организацией, чтобы зарегистрироваться. Потенциальный разработчик должен предоставить всю необходимую информацию, например адрес электронной почты, имя, фамилию и название компании. Если вы одобрите запрос разработчика, то сможете зарегистрировать его вручную в интерфейсе управления Edge. Подробнее о том, как управлять разработчиками приложений…
Apigee также предоставляет инструменты, которые можно использовать для автоматизации процесса регистрации разработчиков. Пример:
- Используйте API управления Apigee Edge, чтобы интегрировать функцию регистрации в существующий сайт. Edge Management API – это REST API, который можно использовать для выполнения всех аспектов процесса регистрации разработчика. Подробнее о том, как публиковать API с помощью Edge Management API…
- Зарегистрируйте разработчиков на портале Apigee Developer Services. На портале есть встроенная поддержка регистрации разработчиков, а также множество других функций для работы с API. Подробнее о том, что такое портал для разработчиков…
Задача 3. Зарегистрируйте приложение разработчика в Edge
Чтобы приложение могло получить доступ к вашим API, его необходимо зарегистрировать в Edge. Однако зарегистрировать приложение в Edge может только зарегистрированный разработчик.
При регистрации приложения разработчик выбирает один или несколько продуктов API. Например, вы можете опубликовать несколько продуктов API, соответствующих разным типам сервисов и тарифным планам. Разработчик приложения сможет выбрать нужные ему продукты API из списка доступных.
После регистрации приложения в Edge ему присваивается уникальный ключ API. Приложение должно передавать этот ключ API в составе каждого запроса к ресурсу API. Ключ аутентифицируется, и, если он действителен, запрос выполняется. В любой момент вы как поставщик услуг можете отозвать ключ, чтобы приложение больше не могло получить доступ к вашим API.
Как поставщик API, вы сами решаете, как регистрировать приложения. Вы можете:
- Используйте ручной процесс, при котором разработчик должен связаться с вашей организацией, чтобы зарегистрировать приложение. В ответ вы отправите разработчику ключ API, возможно, по электронной почте.
- Используйте API управления Edge, чтобы интегрировать в свой сайт функции регистрации приложений и доставки ключей.
- Если у вас платный аккаунт Edge, используйте портал Apigee Developer Services, в котором встроена поддержка регистрации приложений и доставки ключей API.
Подробнее о том, как зарегистрировать приложение и управлять ключами API…
Задача 4. Задокументируйте API
При публикации продуктов API важно предоставить документацию и механизм обратной связи с разработчиками. Порталы для разработчиков с функциями публикации в социальных сетях все чаще используются для общения с сообществом разработчиков. Это относится к статическому контенту, например документации по API и условиям использования, а также к динамическому контенту, созданному сообществом, например блогам и форумам, и функциям поддержки клиентов.
Вы можете создать собственный сайт для размещения документации или, если у вас платный аккаунт Edge, использовать портал Apigee Developer Services. На портале есть встроенная поддержка документации, блогов, форумов и других типов контента, необходимых для поддержки сообщества разработчиков.
SmartDocs позволяет создавать документацию по API на портале Developer Services, делая ее полностью интерактивной. Интерактивная документация с помощью SmartDocs позволяет пользователям портала:
- Подробнее об API
- Отправка запроса к API
- Как посмотреть мгновенный ответ, полученный от API
Например, на рисунке ниже показан API, описанный на портале с помощью SmartDocs. Этот API предоставляет информацию о погоде в определенном местоположении:
Разработчик вводит значение параметра запроса w, чтобы указать местоположение, а затем нажимает кнопку Отправить запрос, чтобы посмотреть запрос и ответ в реальном времени. Создав интерактивную документацию по API, вы поможете пользователям портала изучать, тестировать и оценивать ваши API.
Edge Management API – это REST API, который позволяет получать доступ к API-сервисам с помощью любого HTTP-клиента. Apigee использует SmartDocs для создания интерактивной документации по API управления Edge. Документация по API доступна здесь.
Подробнее о том, как использовать SmartDocs для документирования API…