Как управлять категориями разработчиков

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

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

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

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

Как добавить категорию разработчика

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

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 к следующим ресурсам:

• /organizations/{org_name}/companies
• /organizations/{org_name}/developers

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

• /organizations/{org_name}/companies/{company_id}
• /organizations/{org_name}/developers/{developer_id}

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

Укажите MINT_DEVELOPER_CATEGORY в качестве атрибута в теле запроса, используя внутренний идентификатор категории в качестве значения. Например, следующий запрос добавляет уже существующего разработчика в категорию "Золото" с идентификатором 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.