Estás viendo la documentación de Apigee Edge.
Ve a la
Documentación de Apigee X. información
Si quieres tener más control sobre las empresas y los desarrolladores que participan en tu campaña programa de APIs de Google, por ejemplo, si quieres crear empresas y desarrolladores internos para con fines de prueba, puedes crear empresas y desarrolladores manualmente con la IU de administración y la API.
Una consideración principal que determina si debe crear empresas y desarrolladores manualmente es si los desarrolladores necesitarán o no credenciales para acceder a la IU de administración, enviar credenciales en las 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 API o IU de Edge, primero deben tener sus Cuenta de administrador de Apigee.
- Si solo necesitas crear desarrolladores de prueba que no necesiten credenciales (por ejemplo, si si quieres realizar llamadas a la API con desarrolladores de pruebas ficticios), no se requiere ninguna cuenta de Apigee como en los productos necesarios.
Administra desarrolladores de apps con la IU
Crear, administrar y activar 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 mediante la IU
Crear, administrar y activar empresas, como se describe en las siguientes secciones
Explora la página Companies
Accede a la página Empresas como se describe a continuación.
Edge
Para acceder a la página Companies con la IU de Edge, sigue estos pasos:
- Accede a apigee.com/edge.
- Selecciona Publicar > Monetización > Companies en la barra de navegación de la izquierda
Se muestra la página Empresas.
Como se destaca en la figura, la página Empresas te permite hacer lo siguiente:
- Ver la información resumida de todas las empresas, incluido el nombre, el ID de registro, la cantidad de claves de API y apps registradas, el tipo de facturación, la cantidad de desarrolladores asignados a la empresa y el estado
- Cómo agregar una empresa
- Activa o desactiva una empresa
- Edita una empresa
- Cómo borrar una empresa
- Buscar en la lista de empresas
Classic Edge (nube privada)
Para acceder a la página Companies 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. - Selecciona Publicar > Empresas en la barra de navegación superior.
Se muestra 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)
Cómo agregar una empresa
Para agregar una empresa, sigue estos pasos:
- Accede a la página Empresas.
- Haga clic en + Empresa.
- Ingresa los detalles de la empresa.
Los siguientes son los campos obligatorios:
- Nombre de la empresa
- Administrador (el usuario que es la empresa principal) administrador)
- Tipo de facturación
Según la configuración de facturación de monetización, es posible que el tipo de facturación predeterminado sea el siguiente:
PREPAID
oPOSTPAID
. Para obtener más información, consulta Cómo configurar los tipos de facturación prepagados y pospago con la API. - Agregar uno o más desarrolladores a la empresa
- En la sección Developers, 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, siga estos pasos:
- Accede a la página de la empresa.
- Coloca el cursor sobre la empresa que deseas activar y habilita en el menú de acciones.
Desactive el botón para desactivar la empresa.
Editar una empresa
Para editar una empresa, sigue estos pasos:
- Accede a la página de la empresa.
- Coloca el cursor sobre la empresa que deseas editar y haz 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.
Borra una empresa
Para borrar una empresa, sigue estos pasos:
- Accede a la página Empresas.
- Coloca el cursor sobre la empresa que deseas borrar y haz clic en en el menú de acciones.
- Haz clic en Borrar para confirmar esta operación.
Administra empresas y desarrolladores con la API
En las siguientes secciones, se describe el uso de la API para administrar empresas y desarrolladores.
Crear y actualizar 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:
- Crea una empresa
- Crea un desarrollador
Nota: Configura la información de monetización cuando crees un desarrollador pasando atributos personalizados. - Agregar o
informa a los desarrolladores de la empresa
Nota: De manera opcional, puedes asignar un rol al desarrollador, aunque no es obligatorio. Para obtener una lista de roles de desarrollador, consulta Recupera roles 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 creando o actualizar un desarrollador. Puedes ver los atributos personalizados de monetización establecidos con la API estándar (sin monetización) todos los desarrolladores o un solo desarrollador.
Administra los roles de desarrollador con la API
Puedes crear roles con las APIs de monetización. Esto te permite establecer roles para tus socios. Por ejemplo, puedes establecer roles de administrador y desarrollador de aplicaciones para un socio. Luego, esos roles se pueden asignar a empleados específicos de los socios.
Crea un rol de desarrollador
Para crear un rol 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 del rol, y la identificación del rol
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
Recuperando 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" : { ... } }
Parámetros de configuración del rol de desarrollador para la API
Las siguientes opciones de configuración de función de desarrollador se exponen a la API:
Nombre | Descripción | Predeterminada | ¿Obligatorio? |
---|---|---|---|
name |
El nombre de la función de desarrollador. |
N/A | Sí |
description |
Una descripción de la función de desarrollador. |
N/A | Sí |
Cómo recuperar la tasa impositiva de un desarrollador mediante la API
Para obtener la tasa impositiva actual para 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 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
Realización de 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 creando planes de tarifas o condiciones de notificación, también puedes realizar desarrollador. Por ejemplo, puedes crear una cuenta bancaria para un desarrollador específico o generar una Informe de ingresos de un desarrollador específico.
En la siguiente tabla, se enumeran las tareas específicas del desarrollador que puedes realizar con de monetización. La tabla también indica dónde puedes encontrar instrucciones detalladas sobre el rendimiento estas tareas.
Tarea | Dónde están las instrucciones |
---|---|
Consulta los términos y condiciones que acepta un desarrollador |
Cómo ver los términos y condiciones que acepta un desarrollador o una empresa mediante la API |
Ver los paquetes de API que acepta un desarrollador |
Cómo ver paquetes de productos de API que acepta un desarrollador o una empresa a través de la API |
Crea un plan de tarifas para desarrolladores | |
Ver planes de tarifas disponibles para un desarrollador | |
Ver los planes de tarifas disponibles para un desarrollador específico que contenga una producto | |
Ver solo los planes de tarifas para desarrolladores aceptados |
Consulta todos los planes de tarifas que acepta 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 | |
Consulta el límite de crédito de desarrollador | |
"Agregar dinero" (agregar un importe) al saldo prepagado de un desarrollador | |
Cómo ver el saldo prepagado de un desarrollador |
Cómo ver los saldos prepagados de las cuentas de un desarrollador |
Cómo configurar una condición de notificación para un desarrollador |
Configura las notificaciones con plantillas de notificaciones |
Crea y visualiza definiciones de informes para un desarrollador |