Administrar empresas y desarrolladores con Edge

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Información

Si quieres tener más control sobre las empresas y los desarrolladores que participan en tu programa de API monetizado (por ejemplo, si quieres crear empresas y desarrolladores internos con fines de prueba), puedes crear empresas y desarrolladores de forma manual con la IU y la API de administración.

Una consideración principal que determina si necesitas crear empresas y desarrolladores de forma manual es si los desarrolladores necesitarán credenciales para acceder a la IU de administración, enviar credenciales en llamadas a la API de Edge Management o acceder a un portal para desarrolladores.

• Si tus desarrolladores de monetización necesitan credenciales de acceso para acceder a la IU o la API de Edge, primero deben tener su propia cuenta de administrador de Apigee.
• Si solo necesitas crear desarrolladores de prueba que no necesitan credenciales (por ejemplo, si quieres realizar llamadas a la API con desarrolladores de prueba ficticios), no se requieren cuentas de Apigee.

Administra desarrolladores de apps con la IU

Crea, administra y activa desarrolladores de apps con la IU de Edge, como se describe en Administra desarrolladores de apps. Después de crear los desarrolladores de apps, puedes agregarlos a empresas, como se describe en las siguientes secciones.

Administra empresas con la IU

Crea, administra y activa empresas, como se describe en las siguientes secciones.

Exploración de la página Empresas

Acceda a la página Empresas, tal como se describe a continuación.

Agregar una empresa

Para agregar una empresa, haz lo siguiente:

1. Acceda a la página Empresas.
2. Haga clic en + Empresa.
3. Ingresa los datos de la empresa.

   Los siguientes son los campos obligatorios:

   • Nombre de la empresa
   • Administrador (el usuario que es el administrador principal de la empresa)
   • Tipo de facturación

   Según la configuración de facturación de la monetización, es posible que el tipo de facturación sea PREPAID o POSTPAID de forma predeterminada. Para obtener más información, consulta Cómo configurar tipos de facturación prepagada y pospago con la API.

4. Agrega uno o más desarrolladores a la empresa.
   1. En la sección Desarrolladores, ingresa una string en el campo Add Developer para mostrar la lista de desarrolladores que coinciden con la string.
   2. Selecciona un desarrollador de la lista desplegable.
   3. Repite el proceso para agregar más desarrolladores a la empresa.
5. Agrega uno o más atributos personalizados.
   1. En la sección Atributos personalizados, haz clic en + Nuevo.
   2. Ingresa el nombre y el valor del atributo personalizado.
   3. Repite el proceso para agregar atributos personalizados adicionales a la empresa.
6. Haz clic en Crear empresa.

Activar y desactivar una empresa

Para activar y desactivar una empresa, sigue estos pasos:

1. Accede a la página Empresa.
2. Coloca el cursor sobre la empresa que deseas activar y habilita en el menú de acciones.
   Inhabilite el botón de activación para desactivar la empresa.

Edición de una empresa

Para editar una empresa, sigue estos pasos:

1. Accede a la página Empresa.
2. Coloque el cursor sobre la empresa que desea editar y haga clic en en el menú de acciones.
3. Actualiza los detalles de la empresa según sea necesario.
4. Haz clic en Actualizar empresa para guardar los cambios.

Eliminación de una empresa

Para borrar una empresa, haz lo siguiente:

1. Acceda a la página Empresas.
2. Coloque el cursor sobre la empresa que desea borrar y haga clic en en el menú de acciones.
3. Haz clic en Borrar para confirmar la operación.

Administra empresas y desarrolladores mediante la API

En las siguientes secciones, se describe el uso de la API para administrar empresas y desarrolladores.

Crea y actualiza empresas y desarrolladores mediante la API

Para administrar empresas y desarrolladores con la API de administración perimetral de API, consulta las siguientes secciones de la API:

• Cómo crear una empresa
• Crea un desarrollador
  Nota: Cuando crees un desarrollador, pasa atributos personalizados para configurar la información de monetización.
• Agregar o actualizar desarrolladores de la empresa
  Nota: De manera opcional, puedes asignarle un rol al desarrollador, aunque no es obligatorio. Para obtener una lista de las funciones de desarrollador, consulta Cómo recuperar funciones de desarrollador.
• Enumera la configuración de monetización para todos los desarrolladores o para un solo desarrollador
  Nota: Define la información de monetización pasando atributos personalizados cuando crees o actualices un desarrollador. Puedes ver los atributos personalizados de monetización configurados con la API estándar (no monetización) para enumerar todos los desarrolladores o un solo desarrollador.

Administra los roles de desarrollador mediante la API

Puedes crear roles con las APIs de monetización. Esto te permite establecer funciones para tus socios. Por ejemplo, puedes establecer roles de administrador y desarrollador de aplicaciones para un socio. Esos roles se pueden asignar a empleados específicos del socio.

Cómo crear un rol de desarrollador

Para crear una función de desarrollador, envía una solicitud POST a organizations/{org_name}/developer-roles. Cuando realizas la solicitud, debes especificar en el cuerpo de la solicitud el nombre y la descripción de la función y la identificación de la organización. Por ejemplo:

$ 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

Recupera roles de desarrollador

Para recuperar roles de desarrollador, envía una solicitud GET a organizations/{org_id}/developer-roles. Por ejemplo:

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

La respuesta debería ser similar a la siguiente (solo se muestra una parte):

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

Configuración de la función de desarrollador para la API

En la API, se exponen las siguientes opciones de configuración de la función de desarrollador:

Nombre	Descripción	Predeterminada	¿Obligatorio?
name	Es el nombre del rol de desarrollador.	No disponible	Sí
description	Es una descripción del rol de desarrollador.	No disponible	Sí

Cómo recuperar la tasa impositiva de un desarrollador mediante la API

Para obtener la tasa impositiva actual de un desarrollador, envía una solicitud GET a organizations/{org_name}/tax-engine. Cuando realizas la solicitud, debes especificar la identificación del desarrollador como un parámetro de consulta. Por ejemplo:

$ 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

La respuesta debería ser similar a la siguiente:

0.09

Realiza otras tareas específicas del desarrollador con la API

Muchas de las tareas relacionadas con la monetización que puedes realizar para una organización, como la creación de planes de tarifas o condiciones de notificación, también puedes realizar para un desarrollador individual. Por ejemplo, puedes crear una cuenta bancaria para un desarrollador específico o generar un informe de ingresos para un desarrollador específico.

En la siguiente tabla, se enumeran las tareas específicas del desarrollador que puedes realizar con las APIs de monetización. En la tabla, también se muestra dónde puedes encontrar instrucciones detalladas para realizar estas tareas.

Tarea	Dónde encontrar las instrucciones
Consulta los Términos y Condiciones que aceptó un desarrollador	Ver los Términos y Condiciones que aceptó un desarrollador o una empresa mediante la API
Consulta los paquetes de API que aceptó un desarrollador	Cómo ver los paquetes de productos de la API que acepta un desarrollador o una empresa a través de la API
Crea un plan de tarifas para desarrolladores	Administra planes de tarifas
Ver planes de tarifas disponibles para desarrolladores	Explora la página de planes de tarifas
Visualizar los planes de tarifas disponibles para un desarrollador específico que contienen un producto específico	Cómo ver un plan de tarifas aceptado para un desarrollador que contiene un producto de API mediante la API
Ver solo los planes de tarifas aceptados para desarrolladores	Cómo ver todos los planes de tarifas que aceptó un desarrollador mediante la API
Cómo emitir crédito a un desarrollador	Emisión de créditos
Cómo establecer un límite de crédito para un desarrollador	Cómo configurar un límite de crédito con la API
Cómo ver el límite de crédito de un desarrollador	Cómo recuperar un límite de crédito con la API
"Recargar" (agregar un importe al) saldo prepagado de un desarrollador	Administra saldos de cuentas prepagados
Cómo ver el saldo prepagado de un desarrollador	Cómo ver los saldos de cuentas prepagadas de un desarrollador
Cómo configurar una condición de notificación para un desarrollador	Cómo configurar notificaciones con plantillas de notificaciones
Cómo crear y ver las definiciones de informes para un desarrollador	Cómo administrar informes