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

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

Категория разработчиков — это группа разработчиков или компаний со схожими характеристиками, которая позволяет настроить монетизацию для работы с этой конкретной категорией. Например, вы можете создать тарифные планы, которые будут применяться ко всем разработчикам, создающим приложения для распределения дохода, создав категорию разработчиков под названием "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 в теле запроса, присвоив ему значение внутреннего идентификатора категории. Например, следующий запрос добавляет уже существующего разработчика в категорию разработчиков с именем "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} — это идентификатор категории разработчиков (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} — это идентификатор категории, которую необходимо обновить. В теле запроса необходимо указать обновляемые настройки и 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.