Administrar categorías para desarrolladores

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X.
info

Una categoría de desarrolladores es una agrupación de desarrolladores o empresas con características similares que te permite configurar la monetización para que funcione en esa categoría específica. Por ejemplo, puedes crear planes de tarifas que se apliquen a todos los desarrolladores que desarrollen apps para el reparto de ingresos. Para ello, crea una categoría de desarrolladores llamada "revenue_sharing" y agrega desarrolladores a ella. Para obtener más información sobre cómo crear planes de tarifas con categorías de desarrolladores, consulta Crea planes de tarifas.

Explora la página Categorías de desarrolladores

Accede a la página Categorías de desarrolladores con la IU de Edge o la IU clásica de Edge, como se describe en las siguientes secciones.

IU de Edge

Para acceder a la página Develop Categories, haz lo siguiente:

  1. Accede a apigee.com/edge.
  2. Selecciona Publicar > Monetización > Categorías de desarrolladores en la barra de navegación izquierda.

Se mostrará la página Categorías de desarrolladores.

Como se destaca en la figura, la página Categorías de desarrolladores te permite hacer lo siguiente:

  • Consulta las categorías de desarrolladores actuales
  • Agregar, editar o borrar una categoría de desarrollador

Classic Edge (nube privada)

Para acceder a la página Develop Categories con la IU clásica de Edge, haz lo siguiente:

  1. Accede a http://ms-ip:9000, donde ms-ip es la dirección IP o el nombre de DNS del nodo del servidor de administración.
  2. Selecciona Publicar > Categorías de desarrolladores en la barra de navegación superior.

Se mostrará la página Categorías de desarrolladores.

La página Categorías de desarrolladores te permite hacer lo siguiente:

  • Consulta las categorías de desarrolladores actuales
  • Agregar, editar o borrar una categoría de desarrollador

Cómo agregar una categoría de desarrollador

Para agregar una categoría de desarrollador con la IU, haz lo siguiente:

  1. Accede a la página Categorías de desarrollo.
  2. Haz clic en + Categoría de desarrollador.
  3. Ingresa un nombre para la nueva categoría y una descripción breve.
  4. Haz clic en Create Developer Category.

Cómo agregar una empresa a una categoría de desarrollador

Agrega una empresa a una categoría de desarrollador. Una empresa solo puede pertenecer a una categoría de desarrollador.

Para agregar una empresa a una categoría de desarrollador, haz lo siguiente:

  1. Selecciona Publicar > Empresas en la barra de navegación superior.
  2. Selecciona la empresa que deseas agregar a la categoría de desarrollador.
  3. Haz clic en Editar en la página de la empresa.
  4. Selecciona la categoría de desarrollador para la empresa.
  5. Haz clic en Guardar.

Cómo editar una categoría de desarrollador

Para editar una categoría de desarrollador con la IU, haz lo siguiente:

  1. Accede a la página Categorías de desarrollo.
  2. Coloca el cursor sobre la categoría de desarrollador que deseas editar y haz clic en .
  3. Ingresa la categoría de desarrollador.
  4. Haz clic en Actualizar categoría de desarrollador.

Cómo borrar una categoría de desarrollador

Para borrar una categoría de desarrollador con la IU, haz lo siguiente:

  1. Accede a la página Categorías de desarrollo.
  2. Coloca el cursor sobre la categoría de desarrollador que deseas editar.
  3. Haz clic en .
  4. Haz clic en Borrar para confirmar la operación.

Administra categorías de desarrolladores con la API

Administra las categorías de desarrolladores con la API, como se describe en las siguientes secciones.

Cómo agregar una categoría de desarrollador con la API

Agrega una categoría de desarrollador enviando una solicitud POST a /mint/organizations/{org_name}/developer-categories.

Cuando envíes la solicitud, debes especificar la categoría name y description en la carga útil. Por ejemplo:

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

La respuesta debería ser similar a la siguiente:

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

Cómo agregar un desarrollador o una empresa a una categoría de desarrolladores con la API

Agrega un desarrollador o una empresa a una categoría de desarrolladores cuando agregues o edites la empresa o el desarrollador emitiendo una solicitud POST a los siguientes recursos, respectivamente:

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

Para agregar un desarrollador o una empresa a una categoría de desarrolladores cuando edites la empresa o el desarrollador, envía una solicitud PUT a los siguientes recursos, respectivamente:

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

Una empresa o un desarrollador solo pueden pertenecer a una categoría de desarrollador.

Especifica MINT_DEVELOPER_CATEGORY como un atributo en el cuerpo de la solicitud con el ID interno de la categoría como valor. Por ejemplo, la siguiente solicitud agrega un desarrollador ya existente a la categoría de desarrolladores denominada "Oro", que tiene un ID de 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

Visualiza categorías de desarrolladores con la API

Ver una categoría de desarrollador específica o todas las categorías de desarrolladores de una organización

Para ver una categoría de desarrollador específica, envía una solicitud GET a /mint/organizations/{org_name}/developer-categories/{category_id}, donde {category_id} es la identificación de la categoría de desarrollador (el ID se devuelve en la respuesta cuando agregas la categoría de desarrollador). Por ejemplo:

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

Para ver todas las categorías de desarrolladores de API de una organización, envía una solicitud GET a /mint/organizations/{org_id}/developer-categories. Por ejemplo:

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

Edita una categoría de desarrollador con la API

Para editar una categoría de desarrollador, envía una solicitud PUT a /mint/organizations/{org_name}/developer-categories/{category_id}, donde {category_id} es la identificación de la categoría que se actualizará. En el cuerpo de la solicitud, debes especificar la configuración actualizada y el ID de la categoría de desarrollador. Por ejemplo, la siguiente solicitud edita la descripción de una categoría de desarrollador:

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

Borra una categoría de desarrollador con la API

Para borrar una categoría de desarrollador, envía una solicitud DELETE a /mint/organizations/{org_name}/developer-categories/{category_id}, donde {category_id} es la identificación de la categoría de desarrollador que se borrará. Por ejemplo:

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

Propiedades de configuración de la categoría de desarrollador para la API

En la siguiente tabla, se resumen las propiedades de configuración que se pueden establecer con la API.

Nombre Descripción Predeterminado ¿Obligatorio?
name

El nombre de la propiedad Se establece en MINT_DEVELOPER_CATEGORY.

N/A
value

Es el ID de la categoría de desarrollador a la que se agrega el desarrollador.

N/A Sí, para establecer la categoría de desarrollador.