Registra apps y administra las claves de API

Estás viendo la documentación de Apigee Edge.
Ve a la documentación de Apigee X. info

Registra apps y administra claves de API, como se describe en las siguientes secciones.

Introducción

El registro de aplicaciones proporciona el mecanismo principal para controlar quién puede acceder a tus APIs.

Como proveedor de API, creas uno o más productos de API para agrupar tus APIs, como se explica en Administra productos de API. Cuando se registra una app, el desarrollador de la app selecciona qué productos de API usar y Edge proporciona una única clave de API que puede usar 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.

Como proveedor de la API, también puedes optar por tener más control sobre el proceso de registro de la app y registrarla en Edge, como se describe en las siguientes secciones. Por ejemplo, te recomendamos registrar apps para tus equipos de desarrollo interno o en nombre de un desarrollador sin acceso a tu portal.

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

Accede a la página Apps y explora su contenido, como se describe a continuación.

Edge

Para acceder a la página Apps con la IU de Edge, haz lo siguiente:

  1. Accede a apigee.com/edge.
  2. Selecciona Publicar > Apps en la barra de navegación izquierda.

Se mostrará la página Apps.

Como se destaca en la figura, la página Apps te permite hacer lo siguiente:

Edge clásico (nube privada)

Para acceder a la página Apps con la IU de Edge clásica, haz lo siguiente:

  1. 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.
  2. Selecciona Publicar > Apps para desarrolladores en la barra de navegación superior.

Se mostrará la página Apps para desarrolladores.

Registra una app

Puedes registrar una aplicación con uno de estos métodos:

  • 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.
  • Puedes registrar una app en Edge, 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 lo siguiente:

Para registrar una app en Edge, sigue estos pasos:

  1. Accede a la página Apps.
  2. Haga clic en + Aplicación.
  3. Especifica los Detalles de la app:
    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 administración. Sí
    Nombre visible Es el nombre visible de la app que aparece en la IU de administración de Edge y en el portal para desarrolladores. No
    Empresa/Programador

    Nota: Apigee hybrid no admite apps empresariales. Este campo no se aplica.

    Selecciona Empresa o Desarrollador y selecciona el nombre de una empresa o desarrollador en el menú desplegable.
    Nota: Por motivos de rendimiento, no todos los desarrolladores o empresas se muestran en el menú desplegable. Comienza a escribir el nombre de la empresa, el nombre del desarrollador o el correo electrónico en el cuadro de búsqueda. Consulta también Registra desarrolladores de apps.

    		 Sí
    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. No
    Notas Notas descriptivas de la app No
  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 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:
    1. Haz clic en Agregar producto.
    2. Selecciona uno o más productos de API de la lista.
    3. Haz clic en Agregar.
    4. Establece el Estado en Aprobado o Revocado para cada producto de API.
    5. Repite estos pasos para agregar más productos de API.
  5. Especifica los Atributos personalizados:
    1. En la sección Atributos personalizados, haz clic en .
    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.
  6. Haga 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 y edita una app

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

  1. Accede a la página Apps.
  2. Haz clic en la fila de la app que deseas ver y editar.
    Se muestran los detalles de la app.
  3. Para editar una aplicación, haz clic en Editar.
  4. Realiza una o más de las siguientes tareas:
  5. Haz clic en Guardar.

Administrar credenciales

Cuando editas una app, puedes administrar sus credenciales en la sección Credenciales, como se muestra en la siguiente figura:

Como se muestra en la figura anterior, en la sección Credenciales, puedes realizar las siguientes tareas con la IU:

Para usar la API a fin de administrar las credenciales, consulta las siguientes secciones:

Visualiza una clave de API y un secreto

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

  1. Accede a la página 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 Mostrar 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. Edge 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 APIs 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. Accede a la página 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 aprobar o revocar una clave de API para todos los productos de API asociados con una clave de API, selecciona Aprobada o Revocada con la clave de la API.
    • Para aprobar o revocar una clave de API para un producto de API específico, selecciona Aprobada o Revocada en la columna Estado del producto de API.
  5. Haga clic en Save.

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 app

Agrega un producto de API a una aplicación:

  1. Accede a la página 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 a fin de generar una credencial nueva, selecciona una experiencia y agrega el producto de API a la clave de API.
    • Para agregar un producto de API a una clave de API existente, en la sección Credenciales, haz clic en Agregar producto y selecciona el producto de la API de la lista desplegable.
  5. Haga clic en Save.

Quita un producto de API de una app

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

  1. Accede a la página Apps.
  2. Haz clic en la fila de la app que deseas ver y editar.
  3. Haz clic en Editar.
  4. Haz clic en junto al producto de la API.
  5. Haz clic en Guardar.

Puedes volver a agregar un producto 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. Accede a la página Apps.
  2. Haz clic en la fila de la app que deseas ver y editar.
  3. Haz clic en Editar.
  4. En la sección Credenciales, haz clic en .
  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. Haga clic en Save.

Aprueba o revoca una app

.

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 Edge. 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. Accede a la página 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. Haga clic en Save.

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. Accede a la página 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 Edge para la nube pública, la eliminación de la app para desarrolladores y los artefactos asociados se produce 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

Si deseas registrar y administrar apps mediante la API, consulta Registra apps para desarrolladores. Consulta también las siguientes secciones en la documentación de referencia de la API:

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