Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация
В Apigee есть несколько концепций, которые являются общими идеями, но имеют уникальное значение.
| Термин | Определение |
|---|---|
| API | Прокси-сервер, который действует как фасад для существующего API. Вместо того чтобы вызывать существующий API, разработчики начинают вызывать новый API, сгенерированный Apigee. Этот фасад отделяет ваш общедоступный интерфейс от внутреннего API, защищая разработчиков от изменений в бэкенде и позволяя вам внедрять инновации на периферии без влияния на внутренние команды разработчиков. Пока вы вносите изменения в серверную часть, разработчики могут продолжать использовать тот же API без перебоев. В более сложных сценариях Apigee позволяет предоставлять несколько интерфейсов для одного и того же API, что дает возможность настраивать сигнатуру API в соответствии с потребностями различных групп разработчиков. |
| Базовый путь и ресурсы API | API состоит из базового пути и набора ресурсов (также известных как пути к ресурсам). Для каждого API вы определяете один корневой URL и несколько путей к ресурсам. API можно представить как набор URI, у которых есть общий базовый путь. Чтобы вам было проще управлять API, Apigee дополняет эти URI отображаемыми именами и описаниями. |
| Потребитель API | Синоним термина "разработчик приложений", который использует API, созданные поставщиком API. |
| Разработчик API | Программист в организации, предоставляющей API, который создает API. Эти API используются разработчиками приложений (потребителями API) для создания приложений. |
| Пакет API | Набор продуктов API, которые предлагаются разработчикам в виде пакета и обычно связаны с тарифным планом. |
| Продукт API | Набор ресурсов API (URI), объединенных с контрактом на обслуживание и представленных разработчикам в виде пакета. Продукт API также может включать некоторые метаданные, относящиеся к вашей компании, для мониторинга или анализа. Монетизировать один или несколько ресурсов можно, добавив их в продукт API, который затем можно включить в пакет API для монетизации. |
| Поставщик API | Поставщик API создает API (с помощью Edge), чтобы потребители API (разработчики приложений) могли их использовать. |
| разработчик приложений; | В Edge разработчики приложений регистрируют свои приложения у поставщика API, чтобы получить ключи API, необходимые для вызова прокси API поставщика. |
| Приложения | Разработчики используют приложения для доступа к ресурсам в ваших продуктах API. При создании приложения вы выбираете продукт API, который нужно включить, и Apigee генерирует ключ. У каждого приложения есть один ключ, который предоставляет доступ к нескольким продуктам API. Приложения позволяют контролировать, кто может получить доступ к вашим ресурсам. Вы можете управлять доступом к своим продуктам API, отзывая и обновляя ключи приложений. Вы можете управлять доступом к наборам ресурсов, отзывая или удаляя доступ к продуктам в приложении. |
| информацию о балансе; | Для разработчика с предоплатой – баланс в аккаунте разработчика. |
| закрытая корректировка | Корректировка, примененная в опубликованных платежных документах. |
| Закрытый расчетный месяц | Полный календарный месяц, за который были опубликованы платежные документы. |
| Свой вариант | Ограничение (например, на количество транзакций в продукте API), которое можно задать явным образом с помощью монетизации. Также называется явным ограничением. |
| Тарифный план для разработчиков | Тарифный план, который применяется ко всем разработчикам в определенной категории и доступен для покупки всем разработчикам в этой категории. |
| тарифный план для разработчиков | Тарифный план, который применяется к определенному разработчику и доступен для покупки только ему. |
| раскрытый агент; | В коммерческом праве – лицо, уполномоченное действовать от имени другого лица (принципала) для установления правовых отношений с третьим лицом. В монетизации налоговая модель может быть настроена для плана с совместным доходом таким образом, чтобы поставщик API выступал в качестве раскрытого агента разработчика для сбора дохода (и, возможно, налога с продаж) от имени разработчика. |
| раскрытая налоговая модель; | Налоговая модель, в которой поставщик API выступает в качестве раскрытого агента разработчика. |
| среда; | Контекст выполнения API во время работы. Чтобы API можно было использовать во время выполнения, его необходимо развернуть в среде. По умолчанию организации Apigee предоставляются с двумя средами: test и prod. Среда тестирования обычно используется для развертывания API, которые проходят тестирование. Среда prod обычно используется для развертывания API в рабочей среде. |
| гибридная налоговая модель; | Налоговая модель, в которой поставщик API выступает в качестве раскрытого агента разработчика. Однако поставщик API платит налог с продаж, собранный с подписчиков, местным налоговым органам от имени разработчика. |
| неявное ограничение | Лимит, установленный монетизацией (например, лимит предоплаченного баланса разработчика). |
| монетизация | Компонент сервисов разработчика Apigee Edge, который позволяет легко и гибко монетизировать продукты API. |
| сумма, использованная за месяц; | Общее использование разработчиком сервиса за месяц, включая плату за настройку, комиссию за транзакции и регулярную плату. |
| ежемесячные платежи; | Регулярные платежи, которые разработчик получает от пользователей, купивших тарифные планы. Тарифные планы могут включать ежемесячную комиссию, которая взимается с разработчика независимо от использования. |
| заявление о взаимозачете; | Финансовый документ, в котором показаны чистые остатки между счетами и отчетами о доле дохода. |
| открытая корректировка | Корректировка, которая ещё не была применена в опубликованных платежных документах. |
| открытый платежный месяц | Полный календарный месяц, за который не были опубликованы окончательные платежные документы. |
| организация; | Контейнер для всех объектов в вашем аккаунте Apigee, включая API, продукты API, пакеты API, приложения и разработчиков. Для каждой организации, в которой вы состоите, требуется аккаунт пользователя. (У большинства пользователей аккаунт только в одной организации.) В каждом запросе к API необходимо указывать свои учетные данные (имя пользователя и пароль) и название организации. |
| каталог пакетов; | Список пакетов API. Для каждого пакета указаны продукты API и тарифные планы. |
| сумма предоплаты; | Сумма, доступная разработчику с предоплатой для оплаты пакетов API. |
| разработчик с предоплатой; | Разработчик, который заранее оплачивает использование продукта API. Средства списываются с баланса разработчика с предоплатой при использовании продукта API. У разработчика должна быть достаточная сумма предоплаты для покупки продукта API. Статус предоплаты или постоплаты назначается разработчикам поставщиком API. |
| Правила | Этап обработки, который выполняется как атомарная, многократно используемая единица логики в рамках процесса API. Обычно правила включают маршрутизацию запросов к нужной конечной точке, преобразование формата сообщений, применение контроля доступа, вызов удаленных сервисов для получения дополнительной информации, маскировку конфиденциальных данных для внешних пользователей, проверку содержимого сообщений на наличие потенциальных угроз, кеширование распространенных ответов для повышения производительности и т. д. Правила могут выполняться условно в зависимости от контента или контекста запроса или ответного сообщения. Например, если запрос был отправлен со смартфона, может быть выполнено правило преобразования, чтобы настроить формат ответа. |
| разработчик с постоплатой | Разработчик, который получает ежемесячные счета за использование продуктов API. Разработчик оплачивает использование продуктов API в соответствии с условиями оплаты, указанными в тарифных планах, перечисленных в счете. Статус разработчика (с предоплатой или оплатой по факту) назначается поставщиком API. |
| ценовые категории; | Диапазон возможных цен, по которым можно продавать товар. |
| тарифный план с ценами из прейскуранта; | Тарифный план, в котором разработчик платит фиксированную или переменную ставку за каждую транзакцию, связанную с монетизированным продуктом API. |
| Тарифный план | Спецификация комиссий, других сборов и доли дохода за использование продуктов API, предлагаемых в монетизируемом пакете API. |
| resource path |
Путь к ресурсу – это концепция RESTful, унифицированный идентификатор ресурса (URI), который определяет сетевой путь к определенному ресурсу. |
| план с распределением дохода; | Тарифный план, в котором процент дохода, полученного от каждой транзакции с монетизированным продуктом API, передается разработчику приложения, отправившего запрос. |
| долю дохода и тарифную сетку; | Тарифный план, в котором процент дохода, полученного от каждой транзакции с монетизированным продуктом API, передается разработчику приложения, отправившего запрос. За каждую транзакцию с разработчика взимается фиксированная или переменная комиссия. |
| счет с самовыставлением; | Финансовый документ, который создается вместо отчета о распределении дохода. В нем указана сумма, которую нужно выплатить разработчику, и он действует как счет, выставленный поставщику API от имени разработчика. |
| стандартный тарифный план; | Тарифный план, доступный для покупки всем разработчикам. |
| tax | Общая сумма налога, взимаемого с использования и сборов разработчика. |
| пополнить счет; | Действие, которое разработчик с предоплатой выполняет, чтобы пополнить сумму предоплаты. |
| правила записи транзакций; | Механизм, позволяющий монетизации получать параметры транзакций и специальные атрибуты. Монетизация использует эту информацию для обработки, например для применения тарифных планов к запросам и ответам API на основе специальных атрибутов, полученных в каждой транзакции. |
| агент, не раскрывающий свою личность | Организация (или оператор), которая участвует в поставке приложений и считается покупателем контента от имени разработчика (только для целей налогообложения). Как нераскрытый агент, организация (или оператор) может собирать и учитывать налоги, подлежащие уплате конечными пользователями. Этот статус имеет значение только для налоговых целей и не влияет на юридический статус разработчика в цепочке поставок. |
| неуказанная налоговая модель | Налоговая модель, при которой поставщик API вычитает налог, взимаемый с конечных пользователей, и выплачивает его местным налоговым органам. |
| версия | Версия интерфейса API для разработчиков. Примеры: pivotaltracker.com/services/v3 или api.enterprise.apigee.com/v1. (Этот термин отличается от понятия "ревизия", которое обозначает нумерованный пакет конфигурации и правил, объединенных в прокси API и контролируемых системой контроля версий.) Проще говоря, у интерфейсов API есть версии, а у прокси API – ревизии. |