Esta página se aplica a Apigee y Apigee Hybrid.
Consulta la documentación de
Apigee Edge.
Los productos de API agrupan tus APIs y las ponen a disposición de los desarrolladores de aplicaciones para que las consuman. Para obtener una visión general de los productos de API, consulta ¿Qué es un producto de API?
Consultar la página de descripción general de los productos de API
La página de resumen Productos muestra todos sus productos de API y algunos detalles sobre cada uno de ellos. En esta página puedes crear un producto de API, eliminar un producto o seleccionar uno para verlo o editarlo.
Para acceder a la página de resumen Productos en la consola de Apigee en Cloud, sigue estos pasos:
La interfaz de usuario de Productos te permite realizar las siguientes tareas habituales:
- Añadir un producto de API
- Editar un producto de API
- Buscar en la lista de productos de API
- Eliminar un producto de API
Estas tareas se describen en las siguientes secciones.
Crear un producto de API
En esta sección se describe cómo crear un producto de API con las interfaces de usuario de Apigee.
Para crear un producto de API con la interfaz de usuario de Apigee, sigue estos pasos:
Vaya a la página de resumen Productos:
- Haz clic en + Crear. Se mostrará la página de configuración del producto.
- Configura el producto de API. La página de configuración del producto incluye las siguientes partes:
- Detalles del producto: información básica sobre el producto de la API, como su nombre, nivel de acceso (privado, público o interno) y permisos de OAuth.
- Operaciones: grupos de proxies de API, rutas de recursos y métodos HTTP compatibles con este producto de API. También puedes definir límites de cuota para cada operación.
- Operaciones de GraphQL: grupos de proxies de API, rutas de recursos y tipos de operaciones de GraphQL admitidos por este producto de API. Entre los tipos de operaciones de GraphQL admitidos se incluyen las consultas y las mutaciones. Puedes especificar un tipo u otro, o ambos. Al igual que en los proxies de API basados en REST, puedes definir límites de cuota en cada operación.
- Operaciones de gRPC: especifica los proxies de API gRPC y los métodos gRPC admitidos por este producto de API. Al igual que en los servidores proxy de API basados en REST, puedes definir límites de cuota en las operaciones.
- Atributos personalizados: pares clave/valor que te ayudan a controlar la ejecución del proxy de API.
En las siguientes secciones se describe cada una de estas partes principales.
- Cuando hayas terminado, haz clic en Guardar. Apigee crea el nuevo producto de API. Ahora puedes asociar el producto a una aplicación de desarrollador. Consulta Controlar el acceso a las APIs registrando aplicaciones. Para ver más ejemplos, consulta Proteger una API solicitando claves de API y Proteger una API con OAuth.
Detalles del producto
En la sección Detalles del producto, introduzca información básica sobre su nuevo producto de API. En la siguiente tabla se describen los campos de esta sección:
| Campo | ¿Es obligatorio? | Descripción |
|---|---|---|
Name |
Obligatorio |
Define el nombre interno del producto de la API. Este valor se usa en las llamadas a la API de Apigee que hacen referencia al producto de API. El valor del campo Por ejemplo, |
Display name |
Obligatorio |
Define el nombre que se usa en la interfaz de usuario de Apigee para el producto de API. Puedes editar el nombre visible del producto de API en cualquier momento. El Por ejemplo, |
Description |
Opcional |
Una cadena que te ayude a recordar el propósito o la función del producto de la API. La descripción puede incluir caracteres especiales. Por ejemplo, |
Space |
Opcional |
Si tu organización tiene habilitado Apigee Spaces, puedes asociar el producto de API a un espacio seleccionado de la lista de opciones disponibles. Para obtener más información, consulta el artículo Introducción a los espacios de Apigee. |
Environment |
Opcional |
Identifica a qué entornos permite acceder el producto de API. Si no se especifica ningún entorno, el producto de API permitirá todos los entornos. Los entornos que selecciones en este campo restringen el acceso a los proxies de API en función de dónde se hayan desplegado. Por ejemplo, si el proxy de API A se despliega en los entornos |
Access |
Obligatorio | El nivel de acceso concedido a los usuarios de este producto de API. Para obtener más información, consulta Niveles de acceso. |
Automatically approve access requests |
Opcional (se selecciona de forma predeterminada) |
Habilita la aprobación automática de las solicitudes de claves que se reciban para este producto de API desde cualquier aplicación. Para requerir la aprobación manual de las claves, inhabilita esta opción. La opción predeterminada está seleccionada, lo que significa que este producto de API aprueba automáticamente las solicitudes de claves. Si seleccionas la aprobación manual de claves, debes aprobar las solicitudes de claves que recibas de cualquier aplicación que use este producto de API. Para aprobar las llaves manualmente, sigue estos pasos:
Para obtener más información, consulta Registrar aplicaciones y gestionar claves de API. |
Quota |
Opcional |
Define los límites del número de solicitudes permitidas para este producto de API. Este valor se aplica a la suma de las solicitudes de todas las operaciones de este producto de API. Este valor se sustituye por límites de cuota más específicos definidos en las operaciones que definas en el producto de API. Si introduces un valor de cuota, no se aplicarán automáticamente restricciones al número de llamadas que se pueden hacer a través del producto de API. También debe añadir la política de cuota a los proxies de API a los que haga referencia el producto de API. Para obtener más información, consulta la sección Cuotas. |
Allowed OAuth scope |
Opcional | Si usas OAuth con el producto de API, introduce una lista de permisos de OAuth separados por comas que quieras que permita el producto de API (como Read u otros permisos que envíen las aplicaciones con sus llamadas a la API). Para obtener más información, consulta Permisos de OAuth. |
Operaciones
Especifica las operaciones permitidas en un proxy de API basado en HTTP, incluidas las rutas de recursos, los métodos HTTP y las cuotas. Las operaciones te permiten controlar qué métodos REST y qué rutas de recursos de un producto de API están disponibles, así como cuántas llamadas se pueden hacer (con cuota).
Para configurar los detalles de la operación, haga clic en + AÑADIR UNA OPERACIÓN en la sección Operaciones. Se muestra la vista Operación.
| Campo | ¿Es obligatorio? | Descripción |
|---|---|---|
API proxy |
Obligatorio |
Seleccione el proxy de API que quiera asociar a esta operación. |
Path |
Obligatorio |
Introduce la ruta del recurso de la operación. Puede usar la ruta de la operación para permitir o denegar solicitudes a URIs específicos. Por ejemplo, si asignas como origen de la operación el proxy de la API En este caso, se permiten las llamadas a Ten en cuenta que hay reglas especiales para los comodines en las rutas de recursos, tal como se describe en el artículo Configurar rutas de recursos. |
Methods |
Opcional |
Seleccione uno o varios métodos de solicitud HTTP en la lista desplegable. (Estos métodos se conocen a veces como verbos HTTP). Apigee permite solicitudes al proxy de API que solo coincidan con los métodos que selecciones. El valor predeterminado es "Sin selección", lo que permite solicitudes con cualquier método HTTP. Si no selecciona al menos un método, Apigee insertará Para obtener información sobre la funcionalidad de los métodos de solicitud HTTP, consulta Métodos de solicitud HTTP. |
Quota |
Opcional | Especifica los límites de cuota de esta operación. Para obtener más información sobre cómo se contabilizan las cuotas, consulta Información sobre los contadores de cuotas. |
Custom attributes |
Opcional | Consulta Atributos personalizados. |
Operaciones de GraphQL
Para configurar los detalles de la operación GraphQL, haga clic en + AÑADIR UNA OPERACIÓN en la sección Operaciones GraphQL. Se muestra la vista Operación. Consulta también Usar GraphQL.
| Campo | ¿Es obligatorio? | Descripción |
|---|---|---|
API proxy |
Obligatorio |
Seleccione el proxy de API que quiera asociar a esta operación. |
Operation name |
Obligatorio |
Especifica un nombre para la operación |
Operation type |
Opcional |
Seleccione uno o varios tipos de operación de GraphQL en la lista desplegable. Apigee permite solicitudes al proxy de API que solo coincidan con los tipos de operación que selecciones. El valor predeterminado es ninguna selección, lo que permite solicitudes con cualquier tipo de operación. Si no selecciona al menos un tipo, Apigee insertará Para obtener información sobre la funcionalidad de los tipos de operaciones de GraphQL, consulta Consultas y mutaciones. |
Quota |
Opcional | Especifica los límites de cuota de esta operación. Esta cuota sustituye a la cuota definida en el producto de API. Consulta Quota. |
Custom attributes |
Opcional | Consulta Atributos personalizados. |
Operaciones de gRPC
Para configurar los detalles de la operación gRPC, haga clic en + AÑADIR UNA OPERACIÓN en la sección Operaciones gRPC. Se muestra la vista Operación. Consulta también Crear proxies de APIs gRPC.
| Campo | ¿Es obligatorio? | Descripción |
|---|---|---|
API proxy |
Obligatorio |
Seleccione el proxy de API que quiera asociar a esta operación. |
Service name |
Obligatorio |
Especifique un nombre para la operación. En la versión actual, no se puede proporcionar el nombre del servidor de destino. El nombre del servicio y el servidor de destino son los mismos. |
gRPC methods in service |
Opcional |
Introduce los métodos gRPC disponibles. Si hay varios, sepáralos con comas. |
Quota |
Opcional | Especifica los límites de cuota de estas operaciones. Esta cuota sustituye a la cuota definida en el producto de API. Consulta Quota. |
Custom attributes |
Opcional | Consulta Atributos personalizados. |
Atributos personalizados
Los atributos personalizados son pares clave-valor que se pueden usar de muchas formas, como para controlar la ejecución de proxies de API.
En total, un producto de API puede tener hasta 18 atributos personalizados, incluidos los que se definen en las operaciones.
Por ejemplo, puede crear un atributo personalizado llamado deprecated con el valor true o false. En el flujo de tu proxy de API, puedes consultar el valor del atributo deprecated del producto de API. Si su valor es true, puede generar un error con la política RaiseFault porque quiere que esa operación se comporte como si estuviera obsoleta y ya no se admitiera.
Cuota
Puede definir los ajustes de cuota del producto de API o por ámbito de operación. Hay tres campos que debe especificar al definir una cuota:
- Número máximo de solicitudes que se permiten desde una aplicación de desarrollador durante el periodo especificado. Este campo se corresponde con el elemento
<Allow>de una política de cuota. - Intervalo de tiempo de restablecimiento de la cuota. Este campo se corresponde con el elemento
<Interval>de una política de cuota. - La unidad del periodo de restablecimiento (o unidad de tiempo), como día, semana o mes. Este campo se corresponde con el elemento
<TimeUnit>de una política de cuota.
En este ejemplo se establece un límite de 1000 solicitudes al producto de API al día añadiendo lo siguiente:
- 1000 para el número máximo de solicitudes.
- 1 para el intervalo de tiempo de restablecimiento.
- Día para la unidad del periodo de restablecimiento.
Cuando defines una cuota para una operación, debes introducir valores en los tres campos de la sección Quota.
Puedes definir una cuota distinta para cada operación. Si una operación especifica varios métodos HTTP, la cuota se aplica a todos los métodos de esa operación. Para permitir cuotas distintas para cada método, define varias operaciones con un solo método en cada operación.
Si define estos valores tanto en la política de cuota como en el producto de API (en la interfaz de usuario, tal como se describe aquí, o con la API Products), los ajustes de la interfaz de usuario o de la API del producto de API tendrán prioridad.
Configurar rutas de recursos
Ten en cuenta las siguientes reglas para las rutas de recursos:
/: indica que se admiten la ruta base y todas las subrutas de la ruta base./**: indica que se admiten todas las subrutas de la ruta base (pero no la ruta base)./*: indica que solo se admiten URIs que estén un nivel por debajo de la ruta base.- Las rutas de recursos especificadas en el producto de API o en sus operaciones se aplican a todos los servidores proxy de API añadidos al producto de API.
- Las rutas de recursos más inclusivas y menos específicas tienen prioridad sobre las que son más específicas. Por ejemplo, si añade
/y/**, el recurso/tiene prioridad y se ignora el recurso/**.
En la siguiente tabla se muestra el comportamiento predeterminado de un producto de API para diferentes rutas de recursos. En este ejemplo, el proxy de API tiene una ruta base de
/v1/weatherapikey. La ruta del 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 |
|||||
/v1/weatherapikey/ |
|||||
/v1/weatherapikey/1 |
|||||
/v1/weatherapikey/1/ |
|||||
/v1/weatherapikey/1/2 |
|||||
/v1/weatherapikey/1/2/ |
|||||
/v1/weatherapikey/1/2/3/ |
|||||
/v1/weatherapikey/1/a/2/3/ |
Una ruta de recurso de / 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 subruta, como /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, etc.
Para obtener más información, consulta Interpretar la configuración de un producto de API.
Editar un producto de API
Para editar un producto de API, sigue estos pasos:
Vaya a la página de resumen Productos:
- Haga clic en la fila del producto de API que quiera editar. Apigee muestra los detalles del producto de API.
- Haz clic en EDITAR.
-
Edita la configuración del producto de API según sea necesario.
No puedes editar un recurso de API que ya tengas. En su lugar, debe eliminar el recurso de la API y añadir una nueva versión con los valores corregidos si quiere cambiarlo.
Puedes eliminar un recurso si no funciona correctamente o si requiere más desarrollo. Cuando se elimina, ese recurso deja de formar parte del producto de API actual. Las aplicaciones que usen el producto de API ya no podrán acceder al recurso eliminado. Los recursos eliminados se quitan de un producto de API, pero no se eliminan del sistema, por lo que otros productos de API pueden seguir usándolos.
- (Opcional) Si Apigee Monetization está habilitado, crea un plan de tarifas para el producto de API haciendo clic en Añadir plan de tarifas o
(interfaz de usuario clásica). -
Haz clic en Guardar.
Los cambios se aplicarán en un breve periodo de tiempo (aproximadamente cinco minutos).
Eliminar un producto de API
Para eliminar un producto de API, primero debes dar de baja o desasociar todas las aplicaciones de desarrollador asociadas al producto. Para ello, puedes eliminar las aplicaciones o revocar las claves de API de las aplicaciones.
Para eliminar un producto de API, sigue estos pasos:
Vaya a la página de resumen Productos:
- Abre el menú Acciones en la fila del producto de API que quieras eliminar y selecciona Eliminar.
- Después de confirmar la operación de eliminación, esta se hará efectiva en un breve periodo de tiempo (aproximadamente cinco minutos).