Basic terminology

Интерфейс прикладного программирования (API) – это интерфейс, который позволяет одному приложению использовать функции или данные другого приложения.

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

Apigee предоставляет много информации об API и рекомендации по их разработке и использованию. Чтобы начать, посмотрите веб-трансляцию "Проектирование API" или скачайте бесплатную электронную книгу Web API Design: The Missing Link Best Practices for Crafting Interfaces that Developers Love.

Фасад на 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.

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

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

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

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

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

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

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

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

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