Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info
В 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-продукт, который нужно включить, и Apigee генерирует ключ. Каждое приложение имеет один ключ, предоставляющий доступ к нескольким API-продуктам. Приложения позволяют контролировать доступ к вашим ресурсам. Вы можете контролировать доступ к вашим API-продуктам, отзывая и обновляя ключ приложения. А также вы можете контролировать доступ к пакетам ресурсов, отзывая или удаляя доступ к продуктам в приложении. |
| детали баланса | Для разработчика с предоплатой это баланс на его счете. |
| закрытая регулировка | Корректировка, внесенная в опубликованные платежные документы. |
| закрытый расчетный месяц | Полный календарный месяц, за который были опубликованы платежные документы. |
| пользовательский лимит | Ограничение (например, ограничение на количество транзакций по продукту API), которое можно явно установить с помощью монетизации. Также называется явным ограничением. |
| тарифный план для категории разработчиков | Тарифный план, который применяется ко всем застройщикам в определенной категории и доступен для приобретения всем застройщикам в этой категории. |
| тарифный план для разработчиков | Тарифный план, действующий для конкретного застройщика и доступный для приобретения только этому застройщику. |
| раскрытый агент | В коммерческом праве это лицо, уполномоченное действовать от имени другого лица (называемого принципалом) для создания правовых отношений с третьей стороной. В монетизации может быть создана налоговая модель для плана распределения доходов, при которой поставщик API действует как раскрытый агент разработчика для сбора доходов (и, возможно, налогов с продаж) от имени разработчика. |
| раскрытая налоговая модель | Налоговая модель, в которой поставщик API выступает в качестве раскрытого агента разработчика. |
| среда | Контекст выполнения API во время выполнения. API должен быть развернут в среде, прежде чем к нему можно будет получить доступ во время выполнения. По умолчанию организациям Apigee предоставляются две среды: «test» и «prod». Среда «test» обычно используется для развертывания 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. |
| ресурс путь | В концепции RESTful путь к ресурсу — это унифицированный идентификатор ресурса (URI), определяющий сетевой путь к заданному ресурсу. |
| план распределения доходов по ставкам | Тарифный план, в соответствии с которым определенный процент от дохода, полученного от каждой транзакции с использованием монетизированного API-продукта, распределяется между разработчиком приложения, отправившего запрос. |
| План распределения доходов и прейскурант цен | Тарифный план, в соответствии с которым определенный процент от дохода, полученного от каждой транзакции с использованием монетизированного API-продукта, распределяется между разработчиком приложения, отправившего запрос. С разработчика также взимается фиксированная или переменная плата за каждую транзакцию. |
| счет-фактура для самостоятельного выставления счетов | Финансовый документ, который генерируется вместо отчета о распределении доходов. В нем подробно указывается сумма, причитающаяся разработчику, и он служит счетом-фактурой для поставщика API от имени разработчика. |
| стандартный тарифный план | Тарифный план, доступный для приобретения всем застройщикам. |
| налог | Общая сумма налога, применяемого к использованию и сборам разработчика. |
| пополнить счет | Действие, предпринимаемое разработчиком предоплаченных услуг для пополнения предоплаченного баланса. |
| политика регистрации транзакций | Механизм, позволяющий системе монетизации фиксировать параметры транзакций и пользовательские атрибуты. Эта информация необходима для обработки запросов монетизации, например, для применения тарифных планов к запросам и ответам API на основе пользовательских атрибутов, зафиксированных в каждой транзакции. |
| нераскрытый агент | Организация (или оператор), участвующая в предоставлении базовых приложений, которая считается приобретающей контент от имени разработчика (исключительно для целей налогообложения). В качестве нераскрытого агента организация (или оператор) может собирать и учитывать налоги, причитающиеся с конечных пользователей. Этот статус имеет значение только для целей налогообложения — правовой статус разработчика в цепочке поставок остается неизменным. |
| нераскрытая налоговая модель | Модель налогообложения, при которой поставщик API удерживает налог, собранный с конечных пользователей, и перечисляет его в местные налоговые органы. |
| версия | Версия интерфейса API, доступного разработчикам. Например, pivotaltracker.com/services/v3 или api.enterprise.apigee.com/v1 . (Этот термин отличается от «ревизии», которая представляет собой пронумерованный, контролируемый по версиям пакет конфигураций и политик, включенный в API-прокси. Короче говоря, у интерфейсов API есть версии, а у API-прокси — ревизии.) |