Controlar el acceso a tus API mediante el registro de aplicaciones

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

En esta sección, se describe cómo registrar apps y administrar claves de API.

Descripción general

La forma principal de controlar quién puede acceder a tus API es a través del registro de aplicaciones.

Como proveedor de API, creas uno o más productos de API que agrupan tus API en niveles de servicio. Los productos de API te permiten limitar el tráfico y los niveles de acceso en niveles muy detallados. Cuando creas un producto de API, puedes configurar el nivel de acceso como Público, Privado o Interno. Para obtener más información, consulta Nivel de acceso.

Cuando se registra una app, el desarrollador de la app selecciona qué productos de API usar y Apigee proporciona una única clave de API que usa el desarrollador para acceder a esos productos de API. El desarrollador de la app pasa la clave de API en cada llamada a los proxies de API que se encuentran en los productos de API. Puedes revocar la clave de API de una app en cualquier momento para evitar que un desarrollador de apps acceda a todos o a un subconjunto de productos de API a los que hace referencia esa aplicación.

Normalmente, los desarrolladores de aplicaciones se registran para usar tus productos de API con el portal para desarrolladores. Los pasos para compilar tu portal y publicar tus productos de API se describen en Compila tu portal.

Si deseas tener más control sobre el proceso de registro de las apps, registra las apps con Apigee en la consola de Cloud o la API de Apigee. Por ejemplo, te recomendamos registrar apps para tus equipos de desarrollo interno o un desarrollador que no pueda acceder a tu portal.

Debes ser administrador de la organización o tener una función asignada con los permisos adecuados para registrar apps y administrar claves de API.

En las siguientes secciones, se describe cómo registrar apps y administrar claves de API con la IU y la API.

Explora la página Apps

Para registrar apps y administrar las claves de API en la IU de Apigee, usa la vista Apps.

Ve a la página Apps en la consola de Apigee en Cloud:

Ve a Apps.

La vista Apps te permite hacer lo siguiente:

• Registrar una app
• Ver y editar una aplicación
• Administrar credenciales
• Cómo aprobar o revocar una app
• Borra una aplicación
• Buscar la lista de aplicaciones por nombre, desarrollador, ID de la aplicación, clave de API del consumidor o todo el contenido.

Registra una app

Advertencia: Asegúrate siempre de que tu app incluya al menos un producto de API en el que se especifique al menos un proxy de API o una ruta de acceso de recursos. Si el producto de API no incluye un proxy de API o una ruta de acceso de recursos, la clave de la app se puede usar para llamar a cualquier proxy de API en tu organización de Apigee. En la mayoría de los casos, no es recomendable crear una clave skeleton, una clave que puede abrir cualquier puerta en tu casa.

Puedes registrar una app de las siguientes maneras:

• Un desarrollador de apps: Un desarrollador de apps puede registrar la app a través de tu portal, como se describe en Cómo interactúan los desarrolladores de apps con tu portal.
• Por parte de un administrador: Puedes registrar una app en Apigee, como se describe a continuación. Dependerá de ti determinar la manera de proporcionar la clave al desarrollador de la app.

Las aplicaciones registradas se agregan a los siguientes entornos:

• Lista de apps registradas en Apigee. Consulta Visualiza y edita detalles de desarrollador.
• La página Apps en el portal de desarrolladores.

Para registrar una aplicación en Apigee, sigue estos pasos:

1. Ve a la página Apps:

   Ve a Apps.

2. Haz clic en Crear.
3. Especifica los Detalles de la app, tal como se describe en la siguiente tabla:

   Campo	Descripción	¿Es obligatorio?
   Nombre	Nombre de la app. No puedes cambiarlo una vez que se crea la aplicación. Este nombre se usa en las llamadas a la API de Apigee.	Obligatorio
   Nombre visible	El nombre visible de la app que aparece en la IU de Apigee y en el portal para desarrolladores.	Opcional
   Desarrollador	Selecciona un nombre del desarrollador en el menú desplegable. Nota: Por motivos de rendimiento, no todos los desarrolladores se muestran en el menú desplegable. Comienza a escribir el nombre del desarrollador o el correo electrónico en el cuadro de búsqueda y los valores desplegables se definirán de forma automática para coincidir con el texto que escribes. Consulta también Registra desarrolladores de apps.	Obligatorio
   URL de devolución de llamada	Por lo general, se especifica la URL de una app que se designa para recibir un código de autorización en nombre de la app cliente. Este valor no es obligatorio para todos los productos de API.	Opcional
   Notas	Notas descriptivas de la app	Opcional

4. Especifica las Credenciales, incluidos el vencimiento y el estado de la clave de API y los productos de API asociados. En la sección Credenciales, haz clic en Agregar credencial y, luego, ingresa la siguiente información:

   Campo	Descripción
   Caducidad	Configura una fecha o hora de vencimiento o la clave de API para que nunca expire, y haz clic en Aceptar.
   Productos	Asocia uno o más productos de API con la clave de API: Haz clic en Agregar productos. Selecciona uno o más productos de API de la lista. Nota: Se debe seleccionar al menos un producto de API. Haz clic en Aceptar. Haz clic en Agregar.

5. Establece el Estado en Aprobado o Revocado para cada producto de API. Si agregaste un producto de API a la credencial que requiere aprobación manual, se mostrará Pending approval status. De lo contrario, se mostrará Approved. En este paso, puedes cambiar el estado de aprobación.
   1. En la lista de Productos de la sección Credenciales, selecciona uno o más productos de la lista.
   2. Haz clic en Aprobar o Revocar.
6. Especifica los Atributos personalizados:
   1. En la sección Atributos personalizados, haz clic en Agregar atributo.
   2. Ingresa el nombre y el valor.
   3. Haz clic en Agregar o Agregar e iniciar otra. La cantidad máxima de atributos personalizados que puedes agregar es 18.
7. Haz clic en Crear.

Si los productos de API que asociaste con la app requieren aprobación manual para sus claves de API, apruébalos, como se describe en Aprueba o revoca claves de API.

Visualiza las apps registradas para un desarrollador

Si quieres ver las apps registradas de un desarrollador específico, usa uno de los siguientes métodos:

• Visualiza todas las aplicaciones registradas, selecciona Desarrollador en el menú desplegable de búsqueda e ingresa el nombre del desarrollador en el campo de búsqueda.
• Visualiza todos los desarrolladores de la app registrados y haz clic en la fila asociada con el desarrollador.

Visualiza y edita una app

Nota: Antes de editar atributos personalizados, asegúrate de que no haya dependencias de sistema en la configuración del atributo existente.

Apigee mantiene las siguientes entidades en caché durante un mínimo de 180 segundos después de acceder a las entidades.

• Tokens de acceso de OAuth. Esto significa que el elemento ExpiresIn de la política OAuth v2 no podrá hacer expirar un token de acceso en menos de 180 segundos.
• Entidades del servicio de administración de claves (KMS) (apps, desarrolladores, productos de API).
• Atributos personalizados de entidades de KMS y tokens de OAuth.

Para ver y editar una aplicación, haz lo siguiente:

1. Ve a la página Apps:

   Ve a Apps.

2. Haz clic en cualquier lugar de la fila de la app que quieras ver y editar. Apigee muestra los detalles de la app.
   Nota: Las apps que forman parte de AppGroups también se muestran en la lista de resultados. Puedes ver los detalles de las apps y borrar las apps de AppGroups, pero no crearlas ni editarlas en esta vista. Si deseas obtener instrucciones para administrar AppGroups y sus apps, consulta Usa AppGroups para organizar la propiedad de las apps.
3. Para editar una app, haz clic en Editar.
4. Realiza una o más de las siguientes tareas:
   • Modifica los detalles de la app, como el nombre, la URL de devolución de llamada o las notas.
   • Administra las credenciales y los productos asociados.
   • Agrega o borra los atributos personalizados. La cantidad máxima de atributos personalizados que puedes agregar es de 18.
   • Aprueba o revoca la aplicación
5. Haz clic en Guardar.

Administrar credenciales

Cuando editas una app, puedes administrar sus credenciales en la sección Credenciales, en la que puedes realizar las siguientes tareas con la IU:

• Visualiza una clave de API y un secreto
• Aprueba o revoca una clave de API para todos los productos de API asociados o solo un producto de API
• Administra productos de API en una app
• Generar nuevas credenciales

Si quieres usar la API para administrar credenciales, consulta Importa claves y Secrets de consumidor existentes.

Nota: Cuando creas un producto de API, también puedes establecer su nivel de acceso a Solo para uso interno o Privado. Los productos de la API marcados como Solo para uso interno o privado no se muestran a los desarrolladores en el portal para desarrolladores. Para acceder a estos productos, agrégalos manualmente a la app de un desarrollador desde la API de Apigee.

Visualiza una clave de API y un secreto

Para visualizar una clave de API y un secreto, haz lo siguiente:

1. Ve a la página Apps:

   Ve a Apps.

2. Haz clic en la fila de la app para la que deseas ver la clave de API y el secreto.
3. En la sección Credenciales, haz clic en el asociado con el secreto o la clave de API que quieres ver.

Aprueba o revoca una clave de API

Por lo general, las llamadas a la API a proxies de API requieren una clave de API. Apigee permite las llamadas solo si la clave de API está aprobada, es válida y cumple con las condiciones definidas por el producto de API que contiene la API.

Puedes configurar un producto de API para la aprobación automática de claves de API, como se describe en Administra productos de API. Sin embargo, si el producto de API requiere la aprobación manual de las claves de API, debes aprobar la clave de forma manual.

Puedes revocar una clave de API para todo o un único producto de API. En este caso, la clave y el secreto de API no son válidos y no se puede usar para acceder a las API en los productos de API asociados. Puedes volver a aprobar una clave de API en cualquier momento.

Para aprobar o revocar una clave de API, sigue estos pasos:

1. Ve a la página Apps:

   Ve a Apps.

2. Haz clic en la fila de la app que deseas ver y editar.
3. Haz clic en Editar.
4. Para aprobar o revocar una clave de API, selecciona Aprobada o Revocada en la sección Estado de la credencial.
5. Haz clic en Guardar.

Administra productos de API en una app

Administra los productos de API en tu app mediante las siguientes tareas:

• Agrega un producto de API a una aplicación
• Quita un producto de API de una app

Agrega un producto de API a una app

Agrega un producto de API a una aplicación:

1. Ve a la página Apps:

   Ve a Apps.

2. Haz clic en la fila de la app que deseas ver y editar.
3. Haz clic en Editar.
4. Realiza una de las siguientes tareas:
   • Para agregar un producto de API a una clave de API nueva, haz clic en Agregar credencial para generar una credencial nueva, selecciona un vencimiento y agrega el producto de API a la clave de API.
   • Para agregar uno o más productos de API a una clave de API existente, en la sección Credenciales, haz clic en Agregar productos y selecciona uno o más productos de API de la lista desplegable.
5. Haz clic en Guardar.

Cómo revocar o quitar un producto de API de una credencial de app

Si deseas mantener activa una clave de API, pero no puedes usarla por un producto de API, puedes revocarla o quitarla de la credencial asociada.

1. Ve a la página Apps:

   Ve a Apps.

2. Haz clic en la fila de la app que deseas ver y editar.
3. Haz clic en Editar.
4. Selecciona el producto (o los productos) de API que deseas revocar o quitar de la credencial.
5. Haz clic en Revogar o Quitar.
6. Haz clic en Guardar.

Puedes volver a aprobar un producto de API revocado o volver a agregar un producto de API que se quitó.

Genera credenciales nuevas

Puedes generar credenciales nuevas para una app. Por ejemplo, si usas la rotación de claves de API, puedes generar claves nuevas cuyo vencimiento se superponga con las claves que quedarán fuera de rotación cuando caduquen. También puedes generar una clave o un secreto nuevos si la seguridad de la clave o el secreto original está en riesgo. Si generas una clave nueva, cualquier clave de API existente seguirá funcionando hasta que venzan o las revoques explícitamente.

Para generar una clave de API nueva, haz lo siguiente:

1. Ve a la página Apps:

   Ve a Apps.

2. Haz clic en la fila de la app que deseas ver y editar.
3. Haz clic en Edit.
4. En la sección Credentials, haz clic en Add credential.
5. Especifica el vencimiento, agrega los productos de la API y establece su estado.
6. De manera opcional, puedes revocar cualquiera de las otras claves de API, según sea necesario.
7. Haz clic en Guardar.

Aprueba o revoca una app

Nota: Puedes aprobar o revocar las apps asociadas con un usuario en particular, como se describe en Administra usuarios del portal

.

Aprueba o revoca una aplicación, como se describe a continuación. Cuando revocas una app, las claves de API aprobadas ya no se pueden usar en llamadas a la API para Apigee. Cuando vuelvas a aprobar una app, puedes usar todas las claves de API aprobadas y válidas para realizar llamadas a la API.

Si la app está registrada en otras organizaciones, debes revocarla en cada una de ellas. Es posible que los procesadores de los mensajes demoren unos minutos en reconocerlos.

Para aprobar o revocar una aplicación, haz lo siguiente:

1. Ve a la página Apps:

   Ve a Apps.

2. Haz clic en la fila de la app que deseas ver y editar.
3. Haz clic en Editar.
4. Selecciona Aprobar o Revocar en el campo Estado de la app para aprobar o revocar la app, respectivamente.
5. Haz clic en Guardar.

Borra una app

Cuando borras una app, todas las claves de cliente asociadas a ellas no son válidas. El uso de una clave no válida en una solicitud hace que la solicitud falle.

Si crees que podrías restablecer una app de desarrollador en el futuro, una alternativa para la eliminación es revocar una app.

Para borrar una app, sigue estos pasos:

1. Ve a la página Apps:

   Ve a Apps.

2. Coloca el cursor en la fila de la app que deseas borrar.
3. Haz clic en en la columna de acciones.

Nota: Con Apigee, la eliminación de la app para desarrolladores y los artefactos asociados se producen de forma asíncrona. La app de desarrollador se borra de inmediato, pero los recursos asociados con ella, como las claves de aplicación o los tokens de acceso, pueden tardar desde unos pocos segundos hasta unos minutos para borrarse de manera automática.

Registra apps y administra claves de API con la API

Para registrar y administrar apps con la API de Apigee, usa las siguientes API:

• API de Apps
• API de Apps para desarrolladores
• API de clave de app para desarrolladores

Consulta también Importa claves y secretos de consumidor existentes.