Управление категориями разработчиков

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

Категория разработчиков – это группа разработчиков или компаний со схожими характеристиками, которая позволяет вам настроить монетизацию для работы с этой конкретной категорией. Например, вы можете создать тарифные планы, которые будут применяться ко всем разработчикам, разрабатывающим приложения для распределения доходов, создав категорию разработчиков под названием «revenue_sharing» и добавив в нее разработчиков. Дополнительную информацию о создании тарифных планов с категориями разработчиков см. в разделе Создание тарифных планов .

Изучение страницы категорий разработчиков

Откройте страницу «Категории разработчиков» с помощью пользовательского интерфейса Edge или классического пользовательского интерфейса Edge, как описано в следующих разделах.

Пограничный интерфейс

Чтобы получить доступ к странице разработки категорий:

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

Откроется страница категорий разработчиков.

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

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

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

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

Откроется страница категорий разработчиков.

Страница категорий разработчиков позволяет вам:

Добавление категории разработчика

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

  1. Откройте страницу «Разработка категорий» .
  2. Нажмите + Категория разработчика .
  3. Введите имя новой категории и краткое описание.
  4. Нажмите «Создать категорию разработчика» .

Добавление компании в категорию застройщиков

Добавьте компанию в категорию разработчиков. Компания может принадлежать только к одной категории застройщиков.

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

  1. Выберите «Опубликовать» > «Компании» на верхней панели навигации.
  2. Выберите компанию, которую хотите добавить в категорию разработчиков.
  3. Нажмите «Изменить» на странице компании.
  4. Выберите категорию разработчика для компании.
  5. Нажмите Сохранить .

Редактирование категории разработчика

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

  1. Откройте страницу «Разработка категорий» .
  2. Наведите курсор на категорию разработчиков, которую вы хотите изменить, и нажмите .
  3. Введите категорию разработчика.
  4. Нажмите «Обновить категорию разработчика» .

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

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

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

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

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

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

Добавьте категорию разработчика, отправив запрос POST к /mint/organizations/{org_name}/developer-categories .

При отправке запроса вы указываете name и description категории в полезных данных. Например:

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories" \
  -H "Content-Type:application/json"  \
  -d '{
    "name": "Gold",
    "description": "Gold membership"
  }' \
  -u email:password

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

{
  "description" : "Gold membership",
  "id" : "aa6f960a-d9fd-416e-be39-c071418aabd0",
  "name" : "Gold"
}

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

Добавьте разработчика или компанию в категорию разработчиков, когда вы добавляете или редактируете компанию или разработчика, отправляя POST- запрос к следующим ресурсам соответственно:

  • /организации/{org_name}/компании
  • /организации/{org_name}/разработчики

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

  • /организации/{имя_организации}/компании/{company_id}
  • /organizations/{org_name}/developers/{developer_id}

Компания или девелопер может принадлежать только к одной категории разработчиков.

Укажите MINT_DEVELOPER_CATEGORY в качестве атрибута в теле запроса с внутренним идентификатором категории в качестве значения. Например, следующий запрос добавляет уже существующего разработчика в категорию разработчиков с именем «Gold» и идентификатором aa6f960a-d9fd-416e-be39-c071418aabd0 .

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/K4jW2QLjZ1h8GFA8" \
  -H "Content-Type: application/json" \
  -d '{
   "email" : "developer@apigee.com",
    "developerId" : "K4jW2QLjZ1h8GFA8",
    "firstName" : "Dev",
    "lastName" : "One",
    "userName" : "devone",    
    "attributes" : [ {
      "name" : "MINT_REGISTRATION_ID",
      "value" : "dev1"
    }, {
      "name" : "MINT_DEVELOPER_LEGAL_NAME",
      "value" : "DEV ONE"
    }, {
      "name" : "MINT_DEVELOPER_TYPE",
      "value" : "TRUSTED"
    }, {
      "name" : "MINT_BILLING_TYPE",
      "value" : "PREPAID"
    }, {
      "name" : "MINT_IS_BROKER",
      "value" : "TRUE"
    }, {
      "name" : "MINT_DEVELOPER_CATEGORY",
      "value" : "aa6f960a-d9fd-416e-be39-c071418aabd0"
    }, {
      "name" : "MINT_DEVELOPER_ADDRESS",
      "value" : "{
                   "address1": "Dev One Address",
                   "city": "Pleasanton",
                   "country": "US",
                   "isPrimary": "true",
                   "state": "CA",
                   "zip": "94588"
                }"
    }
  }' \
  -u email:password

Просмотр категорий разработчиков с помощью API

Просмотр определенной категории разработчиков или всех категорий разработчиков в организации.

Просмотрите определенную категорию разработчиков, отправив запрос GET к /mint/organizations/{org_name}/developer-categories/{category_id} , где {category_id} — это идентификатор категории разработчика (идентификатор возвращается в ответе при добавлении категория разработчика). Например:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \
  -H "Accept:application/json" \
  -u email:password

Просмотрите все категории разработчиков API для организации, отправив запрос GET к /mint/organizations/{org_id}/developer-categories . Например:

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

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

Измените категорию разработчика, отправив запрос PUT к /mint/organizations/{org_name}/developer-categories/{category_id} , где {category_id} — это идентификатор обновляемой категории. В теле запроса необходимо указать обновленные настройки и идентификатор категории разработчика. Например, следующий запрос редактирует описание категории разработчиков:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \
  -H "Content-Type: application/json"  \
  -d '{
    "id": "aa6f960a-d9fd-416e-be39-c071418aabd0",
    "description": "Premium membership"
  }' \
  -u email:password

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

Удалите категорию разработчиков, отправив запрос DELETE на /mint/organizations/{org_name}/developer-categories/{category_id} , где {category_id} — это идентификатор категории разработчиков, которую нужно удалить. Например:

curl -X DELETE "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \
  -H "Accept:application/json" \
  -u email:password

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

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

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

Имя свойства. Установите значение MINT_DEVELOPER_CATEGORY.

Н/Д Да
value

Идентификатор категории разработчиков, в которую добавлен разработчик.

Н/Д Да, чтобы установить категорию разработчика.