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

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

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

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

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

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

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

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

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

Изучите страницу профиля организации

Откройте страницу профиля организации, как описано ниже.

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

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

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

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

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.

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

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

• Управление настраиваемыми атрибутами для разработчика приложения
• Управляющие компании и разработчики приложений
• Управление разработчиками приложений