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

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

Определяя стабильные и упрощенные точки доступа к логике и данным приложения, 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 Services обеспечивает безопасность ключа API посредством прямой проверки ключа API или через OAuth.

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

• Тестовая среда обычно используется для развертывания API-прокси в процессе разработки.
• Производственная среда обычно используется для переноса API-прокси из тестовой среды после их полной разработки и тестирования.

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

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

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

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

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

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

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

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