Управление профилем организации

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

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

Информация об организации

В рамках первоначальной настройки монетизации Команда специалистов по настройке Apigee Edge создаст профиль вашей организации.

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

Настройте основную информацию о вашей организации, включая:

  • Название организации, адрес и страна деятельности.
  • Тип оплаты (предоплата, постоплата или оба варианта), как описано в разделе «Понимание типа оплаты».
  • Расчетный период (пропорционально или по календарному месяцу)
  • Базовая валюта
  • Налоговая модель, используемая вашей организацией

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

Изучите страницу «Профиль организации».

Перейдите на страницу «Профиль организации», как описано ниже.

Край

Чтобы получить доступ к странице профиля организации с помощью пользовательского интерфейса Edge:

  1. Войдите на сайт apigee.com/edge .
  2. В левой панели навигации выберите «Публикация» > «Монетизация» > «Профиль организации» .

Отображается страница «Профиль организации».

Как показано на рисунке, страница «Профиль организации» позволяет вам:

Классический Edge (частное облако)

Чтобы получить доступ к странице профиля организации с помощью классического интерфейса Edge:

  1. Войдите в систему по http:// ms-ip :9000 , где ms-ip — это IP-адрес или DNS-имя узла сервера управления.
  2. В верхней панели навигации выберите «Администрирование» > «Профиль организации» .

Отображается страница «Профиль организации».

Страница «Профиль организации» позволяет вам:

Редактируйте профиль организации с помощью пользовательского интерфейса.

Чтобы отредактировать профиль организации с помощью пользовательского интерфейса:

  1. Перейдите на страницу «Профиль организации» .
  2. Нажмите «Редактировать» .
  3. В разделе «Название и информация» отредактируйте название организации и страну деятельности.
  4. В разделе «Налоги и валюта» отредактируйте следующие поля:
    Поле Описание
    Налоговая модель

    Примечание: Применяется только в том случае, если вы настроили тарифные планы с распределением доходов и хотите создавать платежные документы.

    Модель налогообложения для планов распределения доходов, определяющая тип необходимых платежных документов.

    Допустимые значения включают:

    • Уведомление: Поставщик API выступает в качестве уполномоченного агента разработчика. Валовая выручка (включая налог с продаж), полученная от конечного пользователя, передается разработчику. Комиссия поставщика API взимается с разработчика в виде счета-фактуры. Поставщик API не занимается налогом с продаж, взимаемым с конечного пользователя, и обязанность по отчетности по налогу с продаж лежит на разработчике.
    • Информация не разглашается: поставщик API действует как нераскрытый агент разработчика, удерживает налог, взимаемый с конечных пользователей, и перечисляет его в местные налоговые органы. Разработчик выставляет поставщику API счет на сумму чистой прибыли, причитающейся разработчику (за вычетом налога с продаж и комиссии поставщика API).
    • Гибридный вариант: поставщик API выступает в качестве раскрытого агента разработчика. Однако поставщик API уплачивает налог с продаж, собранный с его подписчиков, местным налоговым органам от имени разработчика. Оставшуюся выручку поставщик API передает разработчику, а затем выставляет счет за комиссионные сборы.
    Валюта

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

    Чтобы добавить валюту:

    1. Нажмите « Добавить валюту» .
    2. Выберите валюту из выпадающего меню в поле «Валюта» .
    3. При желании в поле «Минимальное пополнение» можно установить минимальную сумму, которую разработчики приложений могут пополнить на свой предоплаченный счет в указанной валюте.
    4. Нажмите «Добавить» .
    5. При желании вы можете установить валюту по умолчанию, выбрав соответствующую радиокнопку.
    6. Повторите шаги, чтобы добавить дополнительные валюты.

    Чтобы удалить валюту, наведите курсор на валюту, которую хотите удалить, и щелкните по ней. .

  5. Управляйте условиями использования, как описано в разделе «Управление условиями использования с помощью пользовательского интерфейса» .
  6. Нажмите « Сохранить ».

Управляйте профилем организации с помощью API.

Управляйте профилем организации с помощью API, как описано в следующих разделах.

Просмотрите профиль организации с помощью API.

Чтобы просмотреть профиль вашей организации, отправьте GET-запрос по адресу /mint/organizations/{org_name} . Например:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Accept: application/json" \
  -u email:password

Ниже приведён пример ответа. Для получения дополнительной информации о показанных параметрах см. раздел «Свойства конфигурации профиля организации для API» .

{
    "address" : [ {
      "address1" : "Test address”,
      "city" : "Test City",
      "country" : "US",
      "id" : "test-address",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "54321"
    } ],
    "approveTrusted" : false,
    "approveUntrusted" : false,
    "billingCycle" : "CALENDAR_MONTH",
    "country" : "US",
    "currency" : "USD",
    "description" : "Test organization",
    "hasBillingAdjustment" : true,
    "hasBroker" : false,
    "hasSelfBilling" : false,
    "hasSeparateInvoiceForProduct" : false,
    "id" : "{org_name}"
    "issueNettingStmt" : false,
    "logoUrl" : " https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
    "name" : "myorg",
    "nettingStmtPerCurrency" : false,
    "regNo" : "RegNo-1234-myorg",
    "selfBillingAsExchOrg" : false,
    "selfBillingForAllDev" : false,
    "separateInvoiceForFees" : true,
    "status" : "ACTIVE",
    "supportedBillingType" : "PREPAID",
    "taxModel" : "UNDISCLOSED",
    "taxRegNo" : "TaxRegNo-1234-myorg",
    "timezone" : "UTC"
}

Редактируйте профиль организации с помощью API.

Отредактируйте профиль организации, отправив PUT-запрос на адрес /mint/organizations/{org_name} . При редактировании профиля организации необходимо указать все свойства профиля, а не только те, которые вы редактируете.

Чтобы изменить валюту по умолчанию для организации, установите значение currency равным коду валюты ISO 4217, которую вы хотите установить в качестве валюты по умолчанию.

Например, следующий вызов API обновляет currency до USD и параметр налоговой модели до HYBRID (обновленные поля выделены в примере). Для получения дополнительной информации о показанных параметрах см. раздел «Свойства конфигурации профиля организации для API» .

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
  "address" : [ { 
    "address1" : "Test address”,
    "city" : "Test City",
    "country" : "US",
    "id" : "corp-address",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "54321"
  } ], 
  "approveTrusted" : false, 
  "approveUntrusted" : false, 
  "billingCycle" : "CALENDAR_MONTH", 
  "country" : "US", 
  "currency" : "USD", 
  "description" : "Test organization", 
  "hasBillingAdjustment" : true, 
  "hasBroker" : false, 
  "hasSelfBilling" : false, 
  "hasSeparateInvoiceForProduct" : false,
  "id" : "myorg", 
  "issueNettingStmt" : false, 
  "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
  "name" : "{org_name}", 
  "nettingStmtPerCurrency" : false, 
  "regNo" : "RegNo-1234-myorg", 
  "selfBillingAsExchOrg" : false, 
  "selfBillingForAllDev" : false, 
  "separateInvoiceForFees" : false, 
  "status" : "ACTIVE", 
  "supportedBillingType" : "POSTPAID",
  "taxModel" : "HYBRID", 
  "taxRegNo" : "TaxRegNo-1234-myorg", 
  "timezone" : "UTC" 
}' \

-u email:password

Настройте типы оплаты для предоплаченных и постоплатных тарифов с помощью API.

В учетных записях разработчиков можно настроить следующие типы оплаты: предоплата, постоплата или оба варианта.

При использовании предоплаченных аккаунтов разработчики заранее оплачивают использование ваших API. Средства списываются с предоплаченного баланса разработчика, который поддерживается через интегрированную платежную систему. Разработчик должен поддерживать предоплаченный баланс, достаточный для приобретения API.

При использовании постоплатных аккаунтов разработчикам выставляется счет ежемесячно (посредством счета-фактуры) в конце месяца. Разработчик оплачивает использование API-продуктов в соответствии с условиями оплаты, установленными в тарифном плане (планах), указанном в счете-фактуре.

Чтобы настроить предоплаченные и постоплатные типы оплаты для вашей организации, установите свойство supportedBillingType на одно из следующих значений, чтобы указать, какие типы оплаты допустимы: PREPAID , POSTPAID или BOTH . Если вы установите значение BOTH , по умолчанию будет использоваться PREPAID при добавлении разработчика приложений или компании. В этом случае вы можете явно установить тип оплаты для компании или разработчика приложений с помощью API, как описано в разделе «Управление компаниями и разработчиками приложений» .

Например:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
  "address" : [ {
    "address1" : "Test address",
    "city" : "Test City",
    "country" : "US",
    "id" : "corp-address",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "54321"
  } ],
  "approveTrusted" : false,
  "approveUntrusted" : false,
  "billingCycle" : "CALENDAR_MONTH",
  "country" : "US",
  "currency" : "USD",
  "description" : "Test organization",
  "hasBillingAdjustment" : true,
  "hasBroker" : false,
  "hasSelfBilling" : false,
  "hasSeparateInvoiceForProduct" : false,
  "id" : "myorg",
  "issueNettingStmt" : false,
  "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
  "name" : "{org_name}",
  "nettingStmtPerCurrency" : false,
  "regNo" : "RegNo-1234-myorg",
  "selfBillingAsExchOrg" : false,
  "selfBillingForAllDev" : false,
  "separateInvoiceForFees" : false,
  "status" : "ACTIVE",
  "supportedBillingType" : "POSTPAID",
  "taxModel" : "HYBRID",
  "taxRegNo" : "TaxRegNo-1234-myorg",
  "timezone" : "UTC"
  }' \
  -u email:password

Настройте цикл выставления счетов с помощью API.

Чтобы настроить цикл выставления счетов для вашей организации, установите для свойства billingCycle одно из следующих значений:

  • PRORATED : выставление счетов производится исходя из количества дней использования API-продукта в календарном месяце.
  • CALENDAR_MONTH : Выставление счетов производится ежемесячно.

Например:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
    "address" : [ {
      "address1" : "Test address",
      "city" : "Test City",
      "country" : "US",
      "id" : "corp-address",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "54321"
    } ],
    "approveTrusted" : false,
    "approveUntrusted" : false,
    "billingCycle" : "CALENDAR_MONTH",
    "country" : "US",
    "currency" : "USD",
    "description" : "Test organization",
    "hasBillingAdjustment" : true,
    "hasBroker" : false,
    "hasSelfBilling" : false,
    "hasSeparateInvoiceForProduct" : false,
    "id" : "myorg",
    "issueNettingStmt" : false,
    "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
    "name" : "{org_name}",
    "nettingStmtPerCurrency" : false,
    "regNo" : "RegNo-1234-myorg",
    "selfBillingAsExchOrg" : false,
    "selfBillingForAllDev" : false,
    "separateInvoiceForFees" : false,
    "status" : "ACTIVE",
    "supportedBillingType" : "POSTPAID",
    "taxModel" : "HYBRID",
    "taxRegNo" : "TaxRegNo-1234-myorg",
    "timezone" : "UTC"
  }' \
  -u email:password

Свойства конфигурации профиля организации для API

Профиль организации позволяет задавать следующие параметры конфигурации с помощью API.

Имя Описание По умолчанию Необходимый?
address

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

 Н/Д Нет
approveTrusted

Этот флаг не используется.

Н/Д Нет
approveUntrusted

Этот флаг не используется.

Н/Д Нет
billingCycle

Период расчетного цикла. Значение может быть одним из следующих:

  • Пропорциональная оплата: расчет производится исходя из количества дней использования API-продукта в календарном месяце.
  • КАЛЕНДАРНЫЙ МЕСЯЦ: Выставление счетов производится ежемесячно.

См. раздел «Настройка цикла выставления счетов с помощью API» .

 Н/Д Да
country

Код ISO 3166-2, обозначающий страну деятельности организации, например, BR для Бразилии.

 Н/Д Да
currency

Код ISO 4217 обозначает «базовую» или учетную валюту, используемую организацией (например, USD для обозначения доллара США).

Для планов с распределением дохода: для вашего плана используется указанная валюта.

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

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

 Н/Д Да
description

Краткое описание организации.

 Н/Д Нет
hasBillingAdjustment

Флаг, указывающий, разрешены ли корректировки. Если разрешены, вы можете вносить корректировки в данные о трафике, регистрируемые API-сервисами для ваших API-продуктов. Значение может быть одним из следующих:

  • true: Настройки включены.
  • false: Настройки недоступны.
 Н/Д Нет
hasBroker

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

  • Верно: Выручка рассчитывается на основе чистой прибыли.
  • false: Выручка рассчитывается не на основе чистой прибыли.
 Н/Д Нет
hasSelfBilling

Флаг, указывающий системе монетизации на необходимость генерации счета-фактуры для самостоятельного выставления счетов вместо отчета о распределении доходов. Счет-фактура для самостоятельного выставления счетов — это финансовый документ, в котором подробно указана сумма, причитающаяся разработчику приложения. Он выступает в качестве счета-фактуры для поставщика API от имени разработчика приложения. Значение может быть одним из следующих:

  • true: Формирует счета-фактуры для самостоятельного выставления счетов вместо отчетов о распределении доходов.
  • false: Отключает возможность выставления счетов самостоятельно.
 Н/Д Нет
hasSeparateInvoiceForProduct

Флаг, определяющий, будет ли создаваться отдельный счет-фактура для каждого продукта API. Значение может быть одним из следующих:

  • true: Для каждого продукта API генерируется отдельный счет-фактура.
  • false: Отдельный счет-фактура не создается для каждого продукта API.
 Н/Д Нет
id

Идентификатор организации.

 Н/Д Нет
issueNettingStmt

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

  • true: Уведомление о взаимозачете формируется при создании платежных документов.
  • false: Заявление о взаимозачете не формируется при создании платежных документов.
 Н/Д Нет
logoUrl

URL-адрес логотипа организации.

 Н/Д Нет
name

Название организации.

 Н/Д Да
netPaymentAdviceNote

Уведомление о платеже безналичным расчетом.

 Н/Д Нет
nettingStmtPerCurrency

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

  • true: Для каждой используемой валюты формируется отдельная выписка по взаимозачету.
  • false: Отдельная выписка по взаимозачету не формируется для каждой используемой валюты.
 Н/Д Нет
regNo

Регистрационный номер организации. Номер, который вы вводите для этого объекта недвижимости, отображается в нижней части платежных документов.

 Н/Д Нет
selfBillingAsExchOrg

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

  • true: Самостоятельное выставление счетов включено для организаций, использующих биржевые услуги.
  • false: Самостоятельное выставление счетов недоступно для организаций, использующих биржевые операции.
 Н/Д Нет
selfBillingForAllDev

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

  • true: Самостоятельное выставление счетов включено для всех разработчиков приложений.
  • false: Самостоятельное выставление счетов доступно не всем разработчикам приложений.
 ЛОЖЬ Нет
separateInvoiceForFees

Флаг, указывающий, следует ли выставлять отдельный счет за услуги. Значение может быть одним из следующих:

  • true: Отдельный счет за услуги выставляется отдельно.
  • false: Отдельный счет за услуги не выставляется.
 ЛОЖЬ Да
status

Статус организации. Допустимые значения включают:

  • АКТИВНО: Учетная запись организации зарегистрирована в системе монетизации и доступна для использования.
  • НЕАКТИВНО: Учетная запись организации зарегистрирована в системе монетизации, но недоступна для использования.
 Н/Д Нет
supportedBillingType

Модель оплаты для разработчиков, используемая для выставления счетов. Значение может быть одним из следующих:

  • ПРЕДОПЛАТА : Разработчик оплачивает использование API-продукта авансом. Средства списываются с баланса разработчика при использовании API-продукта. Разработчик должен поддерживать предоплаченный баланс, достаточный для приобретения API-продукта.
  • ПОСТОПЛАТНАЯ ОПЛАТА : Разработчику выставляется ежемесячный счет (посредством счета-фактуры) за использование API-продуктов. Разработчик оплачивает использование API-продуктов в соответствии с условиями оплаты, установленными в тарифном плане (планах), указанном в счете-фактуре.
  • ОБА : Поддерживаются оба типа оплаты. По умолчанию — предоплаченный.

См. раздел «Настройка типов выставления счетов для предоплаченных и постоплатных тарифов с помощью API» .

 ПРЕДОПЛАЧЕНО Да
taxModel

Примечание: Применяется только в том случае, если вы настроили тарифные планы с распределением доходов и хотите создавать платежные документы.

Модель налогообложения для планов распределения доходов, определяющая тип необходимых платежных документов.

Допустимые значения включают:

  • Уведомление: Поставщик API выступает в качестве уполномоченного агента разработчика. Валовая выручка (включая налог с продаж), полученная от конечного пользователя, передается разработчику. Комиссия поставщика API взимается с разработчика в виде счета-фактуры. Поставщик API не занимается налогом с продаж, взимаемым с конечного пользователя, и обязанность по отчетности по налогу с продаж лежит на разработчике.
  • Информация не разглашается: поставщик API действует как нераскрытый агент разработчика, удерживает налог, взимаемый с конечных пользователей, и перечисляет его в местные налоговые органы. Разработчик выставляет поставщику API счет на сумму чистой прибыли, причитающейся разработчику (за вычетом налога с продаж и комиссии поставщика API).
  • Гибридный вариант: поставщик API выступает в качестве раскрытого агента разработчика. Однако поставщик API уплачивает налог с продаж, собранный с его подписчиков, местным налоговым органам от имени разработчика. Оставшуюся выручку поставщик API передает разработчику, а затем выставляет счет за комиссионные сборы.
 Н/Д Да
taxNexus

Страна, в которой организация зарегистрирована для целей налогообложения.

 Н/Д Нет
taxRegNo

Регистрационный номер налогоплательщика или номер плательщика НДС организации, если применимо. Этот параметр является необязательным, поскольку регистрационный номер налогоплательщика или номер плательщика НДС не применяется во всех странах. Введенный вами номер отображается в нижней части платежных документов.

 Н/Д Нет
transactionRelayURL

URL другой системы, в которую могут передаваться транзакции, например, хранилища данных.

 Н/Д Нет
timezone

Идентификатор часового пояса, используемого организацией для своей деятельности, например, America/New_York или Europe/Paris. Также поддерживаются сокращения часовых поясов, такие как UTC, EST (Eastern Standard Time) или CET (Central European Time).

 Н/Д Да

Изменение настроек профиля монетизации для компании или разработчика приложения.

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