Управление компаниями и разработчиками, использующими Edge

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

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

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

• Если вашим разработчикам монетизации необходимы учетные данные для входа в систему для доступа к пользовательскому интерфейсу или API Edge, им сначала необходимо иметь собственную учетную запись администратора Apigee.
• Если вам нужно просто создать разработчиков тестов, которым не нужны учетные данные (например, если вы хотите выполнять вызовы API с вымышленными разработчиками тестов), учетные записи Apigee не требуются.

Управление разработчиками приложений с помощью пользовательского интерфейса

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

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

Создавайте, управляйте и активируйте компании, как описано в следующих разделах.

Изучение страницы компаний

Откройте страницу «Компании», как описано ниже.

Добавление компании

Чтобы добавить компанию:

1. Откройте страницу компаний .
2. Нажмите + Компания .
3. Введите данные компании.

   Обязательные поля включают в себя:

   • Название компании
   • Администратор (пользователь, который является основным администратором компании)
   • Тип платежа

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

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

Активация и деактивация компании

Чтобы активировать и деактивировать компанию:

1. Откройте страницу компании .
2. Наведите курсор на компанию, которую вы хотите активировать и включить. в меню действий.
   Отключите переключатель, чтобы деактивировать компанию.

Редактирование компании

Чтобы отредактировать компанию:

1. Откройте страницу компании .
2. Наведите курсор на компанию, которую хотите изменить, и нажмите в меню действий.
3. При необходимости обновите сведения о компании.
4. Нажмите Обновить компанию , чтобы сохранить изменения.

Удаление компании

Чтобы удалить компанию:

1. Откройте страницу компаний .
2. Наведите курсор на компанию, которую хотите удалить, и нажмите в меню действий.
3. Нажмите «Удалить» , чтобы подтвердить операцию удаления.

Управление компаниями и разработчиками с помощью API

Использование API для управления компаниями и разработчиками описано в следующих разделах.

Создание и обновление компаний и разработчиков с помощью API

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

• Создать компанию
• Создать разработчика
  Примечание . Настройте информацию о монетизации при создании разработчика, передав специальные атрибуты.
• Добавьте или обновите разработчиков компании
  Примечание . При желании вы можете назначить роль разработчику, хотя это и не обязательно. Чтобы получить список ролей разработчика, см. раздел Получение ролей разработчика .
• Список настроек монетизации для всех разработчиков или для одного разработчика
  Примечание . Определите информацию о монетизации, передав специальные атрибуты при создании или обновлении разработчика. Вы можете просмотреть набор пользовательских атрибутов монетизации с помощью стандартного (не монетизационного) API, чтобы просмотреть список всех разработчиков или одного разработчика .

Управление ролями разработчиков с помощью API

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

Создание роли разработчика

Чтобы создать роль разработчика, отправьте POST-запрос organizations/{org_name}/developer-roles . При оформлении запроса вам необходимо указать в теле запроса название и описание роли, а также идентификатор организации. Например:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "appDeveloper",
   "description": "App Developer",
   "organization": {
       "id": "{org_name}" 
   }  
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

Получение ролей разработчика

Чтобы получить роли разработчика, отправьте запрос GET на адрес организации/{org_id}/developer-roles. Например:

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

Ответ должен выглядеть примерно так (показана только часть ответа):

{
  "description" : "App Developer",
  "id" : "appdeveloper",
  "name" : "appDeveloper",
  "organization" : {
   ...
  }
}

Параметры конфигурации роли разработчика для API

Следующие параметры конфигурации роли разработчика доступны API:

Получение ставки налога для разработчика с помощью API

Вы можете получить текущую ставку налога для разработчика, отправив GET-запрос organizations/{org_name}/tax-engine . При оформлении запроса необходимо в качестве параметра запроса указать идентификацию разработчика. Например:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tax-engine?developerId=dev7@myorg.com" \
-u email:password

Ответ должен выглядеть примерно так:

0.09

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

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

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

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

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

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

• Если вашим разработчикам монетизации необходимы учетные данные для входа в систему для доступа к пользовательскому интерфейсу или API Edge, им сначала необходимо иметь собственную учетную запись администратора Apigee.
• Если вам нужно просто создать разработчиков тестов, которым не нужны учетные данные (например, если вы хотите выполнять вызовы API с вымышленными разработчиками тестов), учетные записи Apigee не требуются.

Управление разработчиками приложений с помощью пользовательского интерфейса

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

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

Создавайте, управляйте и активируйте компании, как описано в следующих разделах.

Изучение страницы компаний

Откройте страницу «Компании», как описано ниже.

Добавление компании

Чтобы добавить компанию:

1. Откройте страницу компаний .
2. Нажмите + Компания .
3. Введите данные компании.

   Обязательные поля включают в себя:

   • Название компании
   • Администратор (пользователь, который является основным администратором компании)
   • Тип платежа

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

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

Активация и деактивация компании

Чтобы активировать и деактивировать компанию:

1. Откройте страницу компании .
2. Наведите курсор на компанию, которую вы хотите активировать и включить. в меню действий.
   Отключите переключатель, чтобы деактивировать компанию.

Редактирование компании

Чтобы отредактировать компанию:

1. Откройте страницу компании .
2. Наведите курсор на компанию, которую хотите изменить, и нажмите в меню действий.
3. При необходимости обновите сведения о компании.
4. Нажмите Обновить компанию , чтобы сохранить изменения.

Удаление компании

Чтобы удалить компанию:

1. Откройте страницу компаний .
2. Наведите курсор на компанию, которую хотите удалить, и нажмите в меню действий.
3. Нажмите «Удалить» , чтобы подтвердить операцию удаления.

Управление компаниями и разработчиками с помощью API

Использование API для управления компаниями и разработчиками описано в следующих разделах.

Создание и обновление компаний и разработчиков с помощью API

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

• Создать компанию
• Создать разработчика
  Примечание . Настройте информацию о монетизации при создании разработчика, передав специальные атрибуты.
• Добавьте или обновите разработчиков компании
  Примечание . При желании вы можете назначить роль разработчику, хотя это и не обязательно. Чтобы получить список ролей разработчика, см. раздел Получение ролей разработчика .
• Список настроек монетизации для всех разработчиков или для одного разработчика
  Примечание . Определите информацию о монетизации, передав специальные атрибуты при создании или обновлении разработчика. Вы можете просмотреть набор пользовательских атрибутов монетизации с помощью стандартного (не монетизационного) API, чтобы просмотреть список всех разработчиков или одного разработчика .

Управление ролями разработчиков с помощью API

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

Создание роли разработчика

Чтобы создать роль разработчика, отправьте POST-запрос organizations/{org_name}/developer-roles . При оформлении запроса вам необходимо указать в теле запроса название и описание роли, а также идентификатор организации. Например:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "appDeveloper",
   "description": "App Developer",
   "organization": {
       "id": "{org_name}" 
   }  
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

Получение ролей разработчика

Чтобы получить роли разработчика, отправьте запрос GET на адрес организации/{org_id}/developer-roles. Например:

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

Ответ должен выглядеть примерно так (показана только часть ответа):

{
  "description" : "App Developer",
  "id" : "appdeveloper",
  "name" : "appDeveloper",
  "organization" : {
   ...
  }
}

Параметры конфигурации роли разработчика для API

Следующие параметры конфигурации роли разработчика доступны API:

Получение ставки налога для разработчика с помощью API

Вы можете получить текущую ставку налога для разработчика, отправив GET-запрос organizations/{org_name}/tax-engine . При оформлении запроса необходимо в качестве параметра запроса указать идентификацию разработчика. Например:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tax-engine?developerId=dev7@myorg.com" \
-u email:password

Ответ должен выглядеть примерно так:

0.09

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

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

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