Как управлять профилем организации

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

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

О профиле организации

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

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

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

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

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

Страница "Профиль организации"

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

Edge

Чтобы перейти на страницу профиля организации в интерфейсе 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 в календарном месяце.
  • CALENDAR_MONTH – оплата производится ежемесячно.

Подробнее о том, как настроить платежный цикл с помощью API…

Н/Д Да
country

Код ISO 3166-2 страны, в которой работает организация, например BR для Бразилии.

 Н/Д Да
currency

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

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

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

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

 Н/Д Да
description

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

 Н/Д Нет
hasBillingAdjustment

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

  • true – корректировки включены;
  • false – корректировки отключены.
 Н/Д Нет
hasBroker

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

  • true – доход рассчитывается на основе чистой прибыли.
  • 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 – счета с самовыставлением доступны не всем разработчикам приложений.
 false Нет
separateInvoiceForFees

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

  • true – комиссия указывается в отдельном счете;
  • false – отдельный счет для комиссии не публикуется.
 false Да
status

Статус организации. Действительные значения:

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

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

  • ПРЕДОПЛАТА. Разработчик заранее оплачивает использование продукта API. Средства списываются с баланса разработчика при использовании продукта API. У разработчика должна быть достаточная сумма предоплаты для покупки продукта API.
  • POSTPAID Разработчику ежемесячно выставляется счет за использование продуктов API. Разработчик оплачивает использование продуктов API в соответствии с условиями оплаты, указанными в тарифных планах, включенных в счет.
  • BOTH – поддерживаются оба типа оплаты. Значение по умолчанию – PREPAID.

Подробнее о том, как настроить типы оплаты по факту и с предоплатой с помощью API…

ПРЕДОПЛАТА Да
taxModel

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

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

Действительные значения:

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

Страна, в которой организация зарегистрирована в налоговых целях.

 Н/Д Нет
taxRegNo

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

 Н/Д Нет
transactionRelayURL

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

 Н/Д Нет
timezone

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

 Н/Д Да

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

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