Estás consultando la documentación de Apigee Edge.
Consulta la
documentación de Apigee X. Información
Registra y administra los desarrolladores de tu app, como se describe en las siguientes secciones (el registro de apps es un proceso independiente, como se describe en Registra apps y administra claves de API).
Introducción
Edge ofrece muchos beneficios que dependen por completo de saber quién llama a tus APIs. Por ejemplo, la seguridad de la API, la administración del tráfico y una buena cantidad de datos de estadísticas dependen de saber quién llama. ¿Y cómo sabe Edge quién llama a tus APIs? Mediante la lectura de información única en cada llamada a la API, como un ID del usuario, una clave de API o un token de OAuth. Esa información única bloquea o desbloquea la funcionalidad que compilas en los proxies de API, lo que te da control total sobre el acceso a la API y el comportamiento.
Por eso, los desarrolladores de apps deben registrarse para usar tus API. Una vez agregadas, los desarrolladores registran sus apps, eligen las API que desean usar y reciben las credenciales de API únicas (claves y secretos del consumidor) necesarias para acceder a tus API.
Cómo registrar desarrolladores de apps
Registra los desarrolladores de apps mediante uno de los siguientes métodos:
- Si tienes una cuenta pagada de Edge, los desarrolladores pueden registrarse por su cuenta a través de un portal para desarrolladores. Para obtener más información, consulta una de las siguientes secciones, en función del tipo de portal para desarrolladores que uses:
- Portal integrado: Crea una cuenta de desarrollador en el portal integrado
- Drupal 9: Registra una cuenta de desarrollador de apps
- Drupal 7: Cómo agregar y administrar cuentas de usuario
- Los administradores pueden registrar a los desarrolladores de apps mediante la API.
- Como administrador del portal para desarrolladores, administra a los desarrolladores directamente en tu portal, como se describe en las siguientes secciones:
- Portal integrado: Administra cuentas de desarrollador para administrar cuentas de desarrollador.
- Drupal 9: Cómo interactúan los desarrolladores de apps con el módulo Apigee Edge
- Drupal 7: Cómo agregar y administrar cuentas de usuario
- Como administrador de la organización, gestiona los desarrolladores que usan la IU o la API de Edge, como se describe en las siguientes secciones.
Recomendaciones a fin de administrar cuentas de desarrollador en portales para desarrolladores
Apigee recomienda que administres las cuentas de desarrollador directamente en tu portal para desarrolladores.
Si usas el portal integrado, esta es la única forma de garantizar que las cuentas de desarrollador del portal integrado y Edge se mantengan sincronizadas.
Si usas el portal para desarrolladores basado en Drupal, administrar las cuentas de desarrollador directamente en el portal para desarrolladores ofrece las siguientes ventajas:
- Cuando agregas a un desarrollador a través de la interfaz de administrador en el portal, puedes configurar la contraseña del desarrollador para el portal y activar un mensaje de correo electrónico automático que se le envía al desarrollador.
Cuando se agrega o modifica un desarrollador con Edge, no se envía ningún correo electrónico al desarrollador, y no se puede establecer su contraseña en el portal. Por lo tanto, el desarrollador debe restablecer su contraseña en el portal antes de que pueda acceder a él.
- Los cambios que se realicen en la cuenta del desarrollador en el portal se enviarán automáticamente a Edge.
Si decides administrar cuentas de desarrollador basadas en Drupal mediante Edge, debes sincronizar los desarrolladores de apps entre el portal y Edge.
Explora la página Desarrolladores
Acceder a la página Desarrolladores y explorarla con la IU de Edge y la IU clásica de Edge.
Conexión de integración
Para acceder a la página Desarrolladores con la IU de Edge, haz lo siguiente:
- Accede a apigee.com/edge.
- Selecciona Publicar > Desarrolladores en la barra de navegación izquierda.
Se mostrará la página para desarrolladores.
Como se destaca en la figura, la página Desarrolladores te permite hacer lo siguiente:
- Agregar un desarrollador
- Visualizar y editar los detalles de los desarrolladores, incluidos los siguientes:
- Exportar datos de publicación
- Borrar un desarrollador
- Buscar en la lista de desarrolladores
Versión clásica de Edge (nube privada)
Para acceder a la página Desarrolladores con la IU clásica de Edge, haz lo siguiente:
- 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 Publish > Developers en la barra de navegación superior.
Se mostrará la página para desarrolladores.
- Ver la lista de desarrolladores
- Agregar un desarrollador
- Ver y editar los detalles del desarrollador, incluidos los atributos personalizados, y activar un desarrollador
- Exportar datos de publicación
- Borrar un desarrollador
- Buscar en la lista de desarrolladores
- Consulta el portal para desarrolladores conectado (solo Drupal 7).
Agrega un desarrollador
Para agregar un desarrollador, haz lo siguiente:
- Accede a la página Desarrolladores.
- Haz clic en + Desarrollador.
- Ingresa los detalles del desarrollador, incluido el nombre, el apellido, el correo electrónico y el nombre de usuario.
- Haz clic en Crear.
Visualiza y edita los detalles de losdesarrolladores
Visualiza y edita los detalles de los desarrolladores. En el caso de las organizaciones con monetización habilitada, puedes editar los atributos personalizados de monetización definidos en Configura los atributos de monetización.
Para ver y editar los detalles del desarrollador, haz lo siguiente:
- Accede a la página Desarrolladores.
- Haz clic en la fila del desarrollador que deseas ver y editar para abrir los detalles.
- En la sección Detalles, se muestra la siguiente información. Edita los detalles del desarrollador, según sea necesario.
Detalle Descripción Detalles Nombre y apellido del desarrollador, nombre de usuario, correo electrónico, estado y duración del registro e ID del desarrollador.
Para editar los detalles del desarrollador, haz clic en cualquiera de los siguientes campos:- Nombre
- Apellido
- Correo electrónico
- Nombre de usuario (Username)
Atributos personalizados Se definen atributos personalizados para el desarrollador. Configura los atributos personalizados, según sea necesario. Para obtener más información, consulta los siguientes vínculos: Aplicaciones Apps que el desarrollador registró. Consulta Registra apps. - Activa o desactiva al desarrollador en el campo Estado.
Para obtener más información, consulta Cómo activar y desactivar un desarrollador.
Con Apigee Edge for Public Cloud, Edge mantiene las siguientes entidades en caché durante un mínimo de 180 segundos después de que se accede a las entidades.
- Tokens de acceso de OAuth. Esto significa que un token revocado puede ocurrir de manera correcta durante un máximo de tres minutos, hasta que venza su límite de caché.
- Entidades del servicio de administración de claves (KMS) (apps, desarrolladores, productos de API).
- Atributos personalizados de entidades de KMS y tokens de OAuth.
Administra atributos personalizados para un desarrollador
Agrega hasta 18 atributos personalizados para cada desarrollador, incluidos los atributos de monetización descritos en Cómo configurar los atributos de monetización.
Sigue estos pasos para administrar los atributos personalizados:
- Accede a la página Desarrolladores.
- Haz clic en la fila del desarrollador para el que deseas administrar atributos personalizados a fin de abrir sus detalles.
- Haz clic en + en la sección Atributos personalizados.
- Ingresa el nombre y el valor del atributo.
- Haz clic en .
- Para borrar un atributo personalizado, coloca el cursor sobre el atributo y haz clic en en el menú de acciones.
Activa y desactiva un desarrollador
Cuando un desarrollador de apps se registra por su cuenta en tu portal, puedes configurar si está activo o no de forma predeterminada.
Cuando un desarrollador está inactivo, aún puede acceder al portal para desarrolladores y crear apps, pero ninguna de las claves de API correspondientes funcionará. Las apps del desarrollador siguen manteniendo su estado aprobado (o cualquier otro), al igual que las claves de API, aunque no son válidas mientras el desarrollador está inactivo.
Para activar o desactivar un desarrollador, haz lo siguiente:
- Accede a la página Desarrolladores.
- Haz clic en la fila del desarrollador que deseas activar o desactivar para abrir sus detalles.
- En la sección Detalles, establece el campo Estado como Activo o Inactivo, según sea necesario.
- Repite los pasos si el desarrollador se encuentra en varias organizaciones.
Exporta datos de publicación
Exporta los siguientes datos de publicación como un archivo de valores separados por comas (CSV):
- Detalles del desarrollador
- Detalles del producto de API, la aplicación y el desarrollador
Para exportar datos de publicación, sigue estos pasos:
- Accede a la página Desarrolladores.
- Haz clic en Exportar CSV….
- Selecciona Desarrolladores o Desarrolladores, apps y productos en el menú desplegable.
Los datos de publicación seleccionados se descargan como un archivo CSV.
Borra un desarrollador
Para borrar un desarrollador, haz lo siguiente:
- Accede a la página Desarrolladores.
- Coloca el cursor sobre la fila del desarrollador que quieres borrar para que se muestre el menú de acciones.
- Haz clic en .
- Haz clic en Borrar para confirmar esta acción.
Sincronización de desarrolladores de apps entre el portal y Edge
Si usas un portal para desarrolladores basado en Drupal a fin de publicar tus APIs, los cambios realizados en los desarrolladores de apps que usan Edge no se propagan en el portal. Debes acceder al portal como administrador y sincronizar el portal con Edge para que esos cambios aparezcan en el portal.
Si deseas sincronizar tu portal para desarrolladores con los desarrolladores de apps definidos en Edge, consulta las siguientes secciones:
- Drupal 9: Sincroniza desarrolladores con Apigee Edge
- Drupal 7: Sincronización de desarrolladores de apps entre el portal y Edge
Agrupa desarrolladores en empresas
Con la monetización, una empresa es un conjunto de desarrolladores que se administran como una sola entidad. Una empresa puede ser cualquier grupo apropiado para tu organización, como unidad de negocios, línea de productos o división. Agrupar a los desarrolladores en empresas es útil cuando necesitas tener varios desarrolladores asociados bajo una sola entidad corporativa. Por ejemplo, es posible que debas configurar empresas diferentes para la facturación. Sin embargo, no es necesario que los desarrolladores de tu organización estén asociados con una empresa. Ten en cuenta que un desarrollador siempre es una entidad única identificada por el elemento de correo electrónico. Si un desarrollador forma parte de una empresa, verás el nombre de la empresa en la página Desarrolladores.
Si quieres obtener más información sobre la administración de empresas y desarrolladores para la monetización, consulta Administra empresas y desarrolladores.
Configura los atributos de monetización
Cuando edites un desarrollador mediante la IU o cuando crees o edites un desarrollador con la API, puedes configurar las propiedades de monetización que se definen en la siguiente tabla. Al principio, debes configurar las propiedades de monetización de la organización cuando edites el perfil de la organización.
Nombre del campo | Nombre del atributo personalizado | Descripción |
---|---|---|
Dirección | MINT_DEVELOPER_ADDRESS |
Dirección del desarrollador, incluidos los siguientes campos: Dirección (líneas 1 y 2), Ciudad, Estado, Código postal y País. |
Perfil de facturación | MINT_BILLING_PROFILE |
Ciclo de facturación de tu organización. Estos son algunos de los valores válidos:
|
Tipo de facturación | MINT_BILLING_TYPE |
Se utiliza el modelo de pago del desarrollador para la facturación. El valor puede ser uno de los siguientes:
Consulta Cómo configurar los tipos de facturación prepagado y pospago con la API. |
Categoría | MINT_DEVELOPER_CATEGORY |
Es la categoría del desarrollador a la que quieres agregar el desarrollador. Una categoría de desarrollador es un grupo de desarrolladores o empresas con características similares. Para obtener más información, consulta Cómo administrar categorías para desarrolladores. |
ID de la empresa | MINT_COMPANY_ID |
ID de la empresa, si corresponde. Para obtener más información, consulta Agrupa a los desarrolladores en empresas. |
Tipo de desarrollador | MINT_DEVELOPER_TYPE |
Apigee no usa esta propiedad. Tipo de desarrollador. Entre los valores válidos, se incluyen |
Es agente | MINT_IS_BROKER |
Marca que especifica si los ingresos se basan en el valor neto. |
Nombre legal | MINT_DEVELOPER_LEGAL_NAME |
Es el nombre legal del desarrollador que se usará en todos los informes. Nota: Este atributo es obligatorio si el desarrollador no está agrupado con una empresa y desea suscribirse a un plan de tarifas publicado. |
Autofacturación | MINT_HAS_SELF_BILLING |
Marca que especifica si se habilitan las facturas de facturación automática. Si se habilita
(true ), la monetización genera una factura de facturación propia en lugar de un resumen de
reparto de ingresos. Una factura de autofacturación es un documento financiero en el que se detalla el importe que se debe
al desarrollador. Actúa como una factura para el Proveedor de API en nombre del desarrollador. |
Núm. de autorización exenta de impuestos | MINT_TAX_EXEMPT_AUTH_NO |
Número de exención de impuestos del Gobierno, si corresponde. |
Tasa impositiva | MINT_APPROX_TAX_RATE |
Tasa impositiva aproximada del desarrollador Especifique un valor decimal con un máximo de 3 caracteres antes del decimal y de 4 caracteres después del decimal. |
Administra desarrolladores mediante la API
Administra a los desarrolladores mediante las API para desarrolladores.
Cuando creas y actualizas un desarrollador mediante la API, puedes configurar los atributos de monetización que se describen en Cómo configurar atributos de monetización según sea necesario.