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.
Conexión de integración
Para acceder a la página Empresas con la IU de Edge, sigue estos pasos:
- Accede a apigee.com/edge.
- Selecciona Publicar > Monetización > Empresas en la barra de navegación izquierda.
Se mostrará la página Empresas.
Como se muestra en la figura, la página Companies te permite hacer lo siguiente:
- Ver información resumida de todas las empresas, incluido el nombre de la empresa, el ID de registro, la cantidad de aplicaciones y claves de API registradas, el tipo de facturación, la cantidad de desarrolladores asignados a la empresa y el estado
- Cómo agregar una empresa
- Cómo activar o desactivar una empresa
- Cómo editar una empresa
- Cómo borrar una empresa
- Buscar en la lista de empresas
Versión clásica de Edge (nube privada)
Para acceder a la página Empresas con la IU clásica de Edge, sigue estos pasos:
- 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. - Seleccione Publicar > Empresas en la barra de navegación superior.
Se mostrará la página Empresas.
- Consulta la lista actual de empresas
- Administrar una empresa Específicamente, agrega, activa, edita y borra una empresa.
- Consulta el portal para desarrolladores conectado (solo Drupal 7).
Agregar una empresa
Para agregar una empresa, haz lo siguiente:
- Acceda a la página Empresas.
- Haga clic en + Empresa.
- 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
oPOSTPAID
de forma predeterminada. Para obtener más información, consulta Cómo configurar tipos de facturación prepagada y pospago con la API. - Agrega uno o más desarrolladores a la empresa.
- En la sección Desarrolladores, ingresa una string en el campo Add Developer para mostrar la lista de desarrolladores que coinciden con la string.
- Selecciona un desarrollador de la lista desplegable.
- Repite el proceso para agregar más desarrolladores a la empresa.
- Agrega uno o más atributos personalizados.
- En la sección Atributos personalizados, haz clic en + Nuevo.
- Ingresa el nombre y el valor del atributo personalizado.
- Repite el proceso para agregar atributos personalizados adicionales a la empresa.
- Haz clic en Crear empresa.
Activar y desactivar una empresa
Para activar y desactivar una empresa, sigue estos pasos:
- Accede a la página Empresa.
- 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:
- Accede a la página Empresa.
- Coloque el cursor sobre la empresa que desea editar y haga clic en en el menú de acciones.
- Actualiza los detalles de la empresa según sea necesario.
- Haz clic en Actualizar empresa para guardar los cambios.
Eliminación de una empresa
Para borrar una empresa, haz lo siguiente:
- Acceda a la página Empresas.
- Coloque el cursor sobre la empresa que desea borrar y haga clic en en el menú de acciones.
- 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 | |
Crea un plan de tarifas para desarrolladores | |
Ver planes de tarifas disponibles para desarrolladores | |
Visualizar los planes de tarifas disponibles para un desarrollador específico que contienen un producto específico | |
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 | |
Cómo establecer un límite de crédito para un desarrollador | |
Cómo ver el límite de crédito de un desarrollador | |
"Recargar" (agregar un importe al) saldo prepagado de un desarrollador | |
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 |