Основная терминология

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

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

Apigee предоставляет обширную информацию об API и передовых методах их разработки и использования. Чтобы начать, просмотрите веб-трансляцию по проектированию API или загрузите бесплатную электронную книгу «Проектирование веб-API: недостающее звено. Лучшие практики создания интерфейсов, которые нравятся разработчикам» .

Фасад Edge для одного или нескольких API, общих служб HTTP или приложений (например, Node.js ).

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

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

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

Чтобы упростить управление вашими API, Apigee дополняет эти необработанные URI отображаемыми именами и описаниями. Edge позволяет вам прикреплять политики и код к URI, обеспечивая детальный контроль и управление поведением ваших API.

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

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

Сокращение приложения . Термин «приложение» стал относиться к мобильным приложениям, использующим API. Разработчики реализуют приложения на разных языках программирования, используя различные технологии и платформы. Разработчики, которые хотят использовать API, регистрируют приложения в организации поставщика API в Apigee Edge.

Когда приложение регистрируется, Apigee генерирует ключ API и секрет, идентифицирующие приложение. Разработчик встраивает ключ API в приложение, которое предоставляет ключ при отправке запросов. Службы API обеспечивают безопасность ключа API посредством прямой проверки ключа API или через OAuth.

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

• Тестовая среда обычно используется для развертывания прокси API во время разработки.
• Среда prod обычно используется для продвижения прокси-серверов API из тестовой среды после того, как они полностью разработаны и протестированы.

Контейнер для всех объектов в учетной записи Apigee Edge, включая прокси API, продукты API, пакеты API, приложения и разработчиков.

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

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

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

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

Версия интерфейса API, ориентированного на разработчика.

Например, pivotaltracker.com/services/v3 или api.enterprise.apigee.com/v1 .

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