Вы просматриваете документацию 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 предоставляются две среды: «тестовая» и «рабочая». «Тестовая» среда обычно используется для развертывания тестируемых API. Среда prod обычно используется для развертывания API для производственного использования. |
| гибридная налоговая модель | Налоговая модель, в которой поставщик API выступает в качестве раскрытого агента разработчика. Однако поставщик API уплачивает налог с продаж, взимаемый со своих подписчиков, в местные налоговые органы от имени разработчика. |
| неявный предел | Лимит (например, лимит предоплаченного баланса разработчика), установленный при монетизации. |
| монетизация | Компонент Apigee Edge Developer Services, обеспечивающий простой в использовании и гибкий способ монетизации продуктов 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 — версии. |