Administrar productos de API

Estás viendo la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Más información

Administra los productos de API con la IU de administración de Apigee Edge, como se describe en esta sección. Si deseas administrar el producto de API mediante la API, consulta Usa la API de Edge Management para publicar APIs.

Para obtener una descripción general de los productos de API, consulta ¿Qué es un producto de API?

Explora la página de productos de API

Accede a la página de productos de API, como se describe a continuación.

Agrega un producto de API

Agrega un producto de API con la IU, como se describe a continuación. Para usar la API de Edge, consulta Configura productos de API con la API.

Para agregar un producto de API con la IU de Edge, haz lo siguiente:

1. Accede a la página de productos de la API, como se describió antes en esta sección.
2. Haz clic en +API Product.
3. Ingrese los detalles del producto para su producto de API.
   

   Campo	Descripción
   Nombre	Nombre interno del producto de API. No puedes editar el nombre después de crear el producto de API. No especifiques caracteres especiales en el nombre.
   Nombre visible	Nombre visible del producto de API. El nombre visible se usa en la IU y puedes editarlo en cualquier momento. Si no se especifica, se usará el valor Nombre. Este campo se completa automáticamente con el valor Nombre. Puedes editar o borrar tu contenido. El nombre visible puede incluir caracteres especiales.
   Descripción	Descripción del producto de API.
   Entorno	Entornos a los que el producto de API permitirá el acceso Por ejemplo, test o prod.
   Acceso	Nivel de acceso. Para obtener más detalles, consulta Nivel de acceso.
   Aprueba de manera automática las solicitudes de acceso	Habilita la aprobación automática de las solicitudes de claves para este producto de API desde cualquier app. Para que se requiera la aprobación manual de las claves, inhabilita esta opción. Consulta Registrar apps y administrar claves de API (IU) y Claves de app para desarrolladores (API).
   Cuota	Límite de cuota al que quieres hacer referencia en las políticas de cuotas. Cuando se ingresa un valor de cuota, no se aplican restricciones de forma automática a la cantidad de llamadas que se pueden realizar a través del producto. Los proxies de API a los que hace referencia el producto deben incluir la política de cuotas para aplicar la cuota. Para obtener más información, consulta Cuotas.
   Permisos de OAuth permitidos	Si usas OAuth con el producto de API, los permisos de OAuth que desees que el producto de API permita (como lectura o cualquier otro alcance que las apps enviarán con sus llamadas a la API) Especifica varios alcances en una lista separada por comas. Consulta Alcances de OAuth.

4. Agrega los recursos de API que están disponibles en el producto de API, incluidos los proxies de API y las rutas de recursos.

   Por ejemplo, si agregas un proxy de API "music" al producto con una ruta base de /music, el producto de la API permite llamadas a /music. Sin embargo, si quieres que el producto de API permita el acceso solo a la ruta del recurso venues, que tiene un URI de /music/venues, agrega la ruta de acceso del recurso /venues al producto. En este caso, se permiten las llamadas a /music/venues?name=paramount, pero se bloquearán las llamadas a /music/artists?name=Jack%Johnson.

   Configura una ruta de acceso a un recurso específico o establece la ruta base y todas las subrutas posibles especificando la ruta de acceso al recurso como /. La ruta del recurso puede incluir comodines /** y /*. El comodín de asterisco doble indica que se admiten todas las subrutas de la ruta base (pero no la ruta base). Un solo asterisco indica que solo se admiten los URI que se encuentren un nivel por debajo de la ruta base. Consulta Cómo configurar el comportamiento de la ruta de acceso del recurso "/", "/*" y "/**", como se describe más adelante en esta sección.

   Para agregar recursos de API, haz lo siguiente:

   1. Haz clic en Agregar un proxy o Agregar una ruta de acceso en la sección de recursos de la API.
   2. Elija si desea agregar un proxy de API, una ruta de acceso o ambos, proxy de API y ruta de acceso.

      

   3. Agrega uno o más proxies de API y rutas de recursos.

      Ten en cuenta lo siguiente:

      • Las rutas de acceso a recursos que definas se aplicarán a todos los proxies de API que se agreguen al producto de API.
      • Las rutas de recursos más inclusivas y menos específicas prevalecen sobre aquellas más específicas. Por ejemplo, si agregas / y /**, la ruta de acceso del recurso / tiene prioridad; se ignorará la ruta del recurso /**.

      Por ejemplo:

      

   4. Haz clic en Add o Add and Start another (para especificar recursos de API adicionales).
5. (Opcional) Usa la sección Destinos de servicio remoto de Apigee para vincular el producto a uno o más destinos de servicio remoto. A menos que uses el adaptador de Envoy de Apigee, puedes ignorar esta configuración. Para obtener más información, consulta la guía de operaciones del adaptador de Envoy de Apigee.

6. (Opcional) Use la sección Atributos personalizados para agregar hasta 18 atributos personalizados a un producto de API.

   Los atributos personalizados son pares clave-valor que se pueden usar de muchas maneras, incluida la ayuda a controlar la ejecución del proxy de la API. Por ejemplo, puedes crear un atributo personalizado llamado deprecated con un valor de verdadero o falso. En el flujo de proxy de tu API, puedes verificar el valor del atributo deprecated del producto de API (por ejemplo, mediante la variable verifyapikey.{policy_name}.apiproduct.deprecated que está disponible automáticamente después de crear el atributo personalizado). Si su valor es verdadero (obsoleto), puedes generar un error con la política Generar fallas.

7. Haz clic en Guardar.

Configura el comportamiento de una ruta de acceso a recursos de “/”, “/*” y “/**”

En la siguiente tabla, se describe el comportamiento predeterminado de un producto de API según las diferentes rutas de acceso de recursos. En este ejemplo, el proxy de API tiene una ruta base de /v1/weatherapikey. La ruta de recurso del producto de API se aplica al sufijo de la ruta después de la ruta base.

URI de solicitud	Permitido para /	Permitido para /*	Permitido para /**	Permitido para /*/2/**	Permitido para /*/2/*
/v1/weatherapikey	S	N	N	N	N
/v1/weatherapikey/	Sí	N	N	N	N
/v1/weatherapikey/1	Sí	Sí	Sí	N	N
/v1/weatherapikey/1/	Sí	Sí	Sí	N	N
/v1/weatherapikey/1/2	Sí	N	Sí	N	N
/v1/weatherapikey/1/2/	S	N	S	Sí	N
/v1/weatherapikey/1/2/3/	S	N	S	Sí	Sí
/v1/weatherapikey/1/a/2/3/	Sí	N	Sí	N	N

De forma predeterminada, una ruta de acceso a un recurso / en un producto de API admite la ruta base y todas las subrutas. Por ejemplo, si la ruta base del proxy de API es /v1/weatherapikey, el producto de API admite solicitudes a /v1/weatherapikey y a cualquier ruta secundaria, como /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, etcétera.

Puedes cambiar este valor predeterminado para que una ruta de acceso al recurso de / corresponda solo a la ruta de acceso base del proxy de API, lo que significa que el producto de API no permitirá el acceso a un URI que tenga algo después de /. Si realizas este cambio, en la tabla anterior, solo las dos primeras filas en "Permitido para /" contendrán "Y".

Para cambiar el valor predeterminado, un administrador del sistema debe establecer el valor de la propiedad features.isSingleForwardSlashBlockingEnabled de tu organización en true. Los clientes de Cloud pueden enviar esa solicitud al equipo de asistencia de Apigee Edge.

Edita un producto de API

Para editar un producto de API, sigue estos pasos:

1. Accede a la página de productos de la API, como se describió antes en esta sección.
2. Haz clic en la fila del producto de API que quieres editar.
3. Haz clic en Editar en la página del producto de API.
4. Edita los campos según sea necesario.

   Puedes borrar los recursos que agregaste a un producto de API. Te recomendamos hacerlo si un recurso no funciona correctamente o requiere más desarrollo. Cuando se borra, ese recurso deja de formar parte del producto de API. Cualquier app que use el producto de API ya no podrá acceder al recurso borrado. Los recursos borrados se quitan del producto, pero no se borran del sistema, de modo que otros productos puedan seguir usándolos.

5. Haz clic en Guardar.

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 completarse con éxito durante un máximo de tres minutos, hasta que venza el 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.

Borra un producto de API

Antes de que puedas borrar un producto de API, debes anular el registro de las apps de desarrollador asociadas con ese producto o anular su asociación. Para ello, borra las apps o revoca las claves de API de la app.

Para borrar un producto de API, sigue estos pasos:

1. Accede a la página de productos de la API, como se describió antes en esta sección.
2. Coloca el cursor sobre el producto de API en la lista.
3. Haga clic en .
4. Haz clic en Borrar para confirmar la operación de eliminación.