Administra productos de API

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

Consulta la documentación de Apigee Edge.

Los productos de API agrupan tus API y las ponen a disposición de los desarrolladores de apps para el consumo. Para obtener una descripción general de los productos de API, consulta ¿Qué es un producto de API?

Explora la página Descripción general de los productos

En la página de descripción general Productos, se muestran todos tus productos de API y algunos detalles sobre cada uno. En esta página, puedes crear un nuevo producto de API, borrar un producto o seleccionar uno para ver o editar.

Para acceder a la descripción general de los productos, sigue estos pasos:

La IU de Productos le permite realizar las siguientes tareas comunes:

Estas tareas se describen en las secciones que se encuentran a continuación.

Crea un producto de API

En esta sección, se describe cómo crear un producto de API mediante la IU de Apigee.

Crea un proxy de API mediante la IU de Apigee:

  2. Selecciona Publicar > Productos de API. Apigee muestra la página de descripción general Productos.
  3. Haz clic en Crear. Aparecerá la página de configuración del producto.
  4. Configura el producto de API. Las partes de la página de configuración del producto incluyen lo siguiente:
    • Detalles del producto: Información básica sobre el producto de 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 compatibles con este producto de API. Los tipos de operaciones de GraphQL compatibles incluyen consultas y mutaciones. Puedes especificar un tipo, el otro o ambos. Al igual que con 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 de gRPC y los métodos de gRPC compatibles con este producto de API. Al igual que con los proxies 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.

    Cada una de estas partes principales se describe en las siguientes secciones.

  5. Cuando termine, haga clic en Guardar. Apigee crea el nuevo producto de API. Ahora puedes adjuntar el producto a una app de desarrollador. Consulta Controla el acceso a tus API mediante el registro de las apps. Para ver ejemplos adicionales, consulta Protege una API mediante la solicitud de claves de API y Protege una API con OAuth.

Detalles del producto

En la sección Product details, ingresa la información básica sobre tu 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 API. Este valor se usa en las llamadas a la API de Apigee que hacen referencia al producto de API. El valor del campo Name puede incluir caracteres alfanuméricos, espacios y lo siguiente: _ - . # $ %

Por ejemplo, My API Product o my-product.
Display name Obligatorio

Define el nombre que se usa en la IU de Apigee para el producto de API. Puedes editar el nombre visible del producto de API en cualquier momento.

El Display name puede incluir caracteres especiales.

Por ejemplo, <My> API Product!!!.
Description Opcional

Es una string que puede ayudarte a recordar el propósito o la función del producto de API. La descripción puede incluir caracteres especiales.

Por ejemplo, The one where I let dev apps read but not write to the "/accounts" endpoints.
Environment Opcional

Identifica los entornos a los que el producto de API permite el acceso. Si no se especifican entornos, el producto de API permite todos los entornos.

Los entornos que seleccionas en este campo restringen el acceso a los proxies de API según el lugar en el que se implementen. Por ejemplo, si el proxy de API A se implementa en los entornos de test y prod, pero el producto de API solo tiene seleccionado el entorno de test, una llamada a la API de la app para desarrolladores correspondiente solo permite el acceso al proxy de API A implementado en el entorno de test. Para obtener más información sobre los entornos, consulta Acerca de los entornos y los grupos de entornos.
Access Requeridos El nivel de acceso otorgado a los usuarios de este producto de API. Para obtener detalles, consulta Niveles de acceso.
Automatically approve access requests Opcional (seleccionada de forma predeterminada)

Habilita la aprobación automática de las solicitudes de clave que recibe este producto de API desde cualquier app. Para requerir la aprobación de manual de claves, inhabilita esta opción.

La opción está seleccionada de forma predeterminada, lo que significa que este producto de API aprueba de forma automática las solicitudes de clave.

Si seleccionas la aprobación manual de claves, debes aprobar las solicitudes de clave que provengan de cualquier app que utilice este producto de API. Para aprobar claves de forma manual, haz lo siguiente:

Para obtener más información, consulta Cómo registrar apps y administrar claves de API.
Quota Opcional

Define los límites en la cantidad de solicitudes permitidas para este producto de API. Este valor se aplica a la suma de todas las solicitudes de operaciones de este producto de API.

Este valor se sustituye por límites de cuota más específicos establecidos en las operaciones que defines en el producto de API.

Ingresar un valor de cuota no aplica automáticamente las restricciones en la cantidad de llamadas que se pueden realizar mediante el producto de API. También debes agregar la política de cuotas a los proxies de API a los que hace referencia el producto de API.

Para obtener más información, consulta Cuotas.
Allowed OAuth scope Opcional Si usas OAuth con el producto de API, ingresa una lista separada por comas de permisos de OAuth que deseas que el producto de API permita (como Lectura o cualquier otro permiso que las apps envíen con sus llamadas a la API). Para obtener más información, consulta Permisos de OAuth.

Operations

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 tener acceso a las rutas de recursos en un producto de API y a cuántas llamadas de ese tipo se pueden realizar (con cuota).

Para configurar los detalles de la operación, haz clic en + ADD AN OPERATION en la sección Operaciones. Aparecerá la vista Operación.

Campo ¿Es obligatorio? Descripción
API proxy Obligatorio

Selecciona el proxy de API para asociarlo a esta operación.
Path Obligatorio

Ingresa la ruta de recursos para la operación.

Puedes usar la ruta de la operación para permitir o rechazar solicitudes a URI específicos. Por ejemplo, si estableces la fuente de la operación como el proxy de API music con una ruta base de /music, el producto de API permitirá las llamadas a todas las rutas secundarias de /music. Sin embargo, si deseas que el producto de API permita acceder solo a la ruta del recurso venues, que tiene un URI /music/venues, agrega /venues como la ruta de la operación. Puedes hacerlo para todas las operaciones o para operaciones específicas.

En este caso, se permiten las llamadas a /music/venues?name=paramount, pero se bloquean las llamadas a /music/artists?name=Jack%Johnson.

Ten en cuenta que existen reglas especiales para los comodines en las rutas de recursos, como se describe en Configura rutas de recursos.
Methods Opcional

Selecciona uno o más métodos de solicitud HTTP en la lista desplegable. (A veces, estos métodos se conocen como verbos HTTP). Apigee permite solicitudes al proxy de API que solo coincidan con los métodos que selecciones.

La configuración predeterminada es sin selección, lo que permite solicitudes con cualquier método HTTP.

Si no seleccionas al menos un método, Apigee inserta ALL como el valor de este campo cuando guardas la operación.

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 para esta operación. Si quieres obtener más detalles sobre cómo se cuentan las cuotas, consulta Información sobre los contadores de cuotas.
Custom attributes Opcional Consulte Atributos personalizados.

Operaciones de GraphQL

Para configurar los detalles de la operación de GraphQL, haz clic en + ADD AN OPERATION en la sección Operaciones de Graphql. Aparecerá la vista Operación. Consulta también Usa GraphQL.

Campo ¿Es obligatorio? Descripción
API proxy Obligatorio

Selecciona el proxy de API para asociarlo a esta operación.
Operation name Obligatorio

Especifica un nombre para la operación
Operation type Opcional

Selecciona uno o más tipos de operaciones de GraphQL en la lista desplegable. Apigee permite las solicitudes al proxy de API que solo coinciden con los tipos de operaciones que seleccionas.

La opción predeterminada es no selección, lo que permite solicitudes con cualquier tipo de operación.

Si no seleccionas al menos un método, Apigee inserta ALL como el valor de este campo cuando guardas la operación.

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 para esta operación. Esta cuota anula la cuota establecida en el producto de API. Consulta Cuota.
Custom attributes Opcional Consulte Atributos personalizados.

Operaciones de gRPC

Para configurar los detalles de la operación de gRPC, haz clic en + AÑADIR UNA OPERACIÓN en la sección Operaciones de gRPC. Aparecerá la vista Operación. Consulta también Crea proxies de API de gRPC.

Campo ¿Es obligatorio? Descripción
API proxy Obligatorio

Selecciona el proxy de API para asociarlo a esta operación.
Service name Requeridos

Especifica un nombre para la operación.

Para la versión actual, no hay opción para proporcionar el nombre del servidor de destino. (El nombre del servicio y el servidor de destino son los mismos).

gRPC methods in service Opcional

Ingresa los métodos de gRPC disponibles con una lista separada por comas para varios métodos.

Quota Opcional Especifica los límites de cuota para estas operaciones. Esta cuota anula la cuota establecida en el producto de API. Consulta Cuota.
Custom attributes Opcional Consulte Atributos personalizados.

Atributos personalizados

Los atributos personalizados son pares clave-valor que se pueden usar de muchas maneras, incluso para ayudar a controlar la ejecución del proxy de API.

En total, un producto de API puede tener hasta 18 atributos personalizados, incluidos los establecidos en las operaciones.

Por ejemplo, puedes crear un atributo personalizado llamado deprecated con un valor de true o false. En el flujo de proxy de API, puedes verificar el valor del atributo deprecated del producto de API. Si su valor es true, puedes generar un error con la política RaiseFault porque deseas que la operación se comporte como si estuviera obsoleta y ya no se admitiera.

Cuota

Define la configuración de cuota en el proxy de API o en el alcance de las operaciones. Si defines una cuota, hay tres campos en Quota que debes especificar:

  1. En el primer campo, se especifica la cantidad máxima de solicitudes que se permiten de una app para desarrolladores al proxy de API durante el período especificado.

    Este campo corresponde al elemento <Allow> de una política de cuotas.

  2. En el segundo campo, se especifica la frecuencia (o intervalo) de restablecimiento de la cuota.

    Este campo corresponde al elemento <Interval> de una política de cuotas.

  3. En el tercer campo, se especifica el tipo (o unidad de tiempo) del período de restablecimiento, como día, semana o mes.

    Este campo corresponde al elemento <TimeUnit> de una política de cuotas.

En el siguiente ejemplo, se establece un límite de 1,000 solicitudes GET, HEAD y TRACE al proxy de API al día (todas las demás solicitudes HTTP se ignoran):

Agrega una cuota nueva a una operación

En el siguiente ejemplo, se establece un límite de 42 solicitudes cada 3 minutos, sin importar el método HTTP, al recurso /mypath:

Agrega una cuota nueva a una operación

Cuando defines una cuota para una operación, debes ingresar valores para los tres campos en la sección Quota.

No puedes definir cuotas diferentes para varios métodos HTTP en la misma operación. Para ello, deberás crear varios productos de API y definir las cuotas específicas de cada método en cada uno.

Si configuras estos valores en la política de cuotas y en el producto de API (en la IU, como se describe aquí, o con la API de los productos de API), la configuración de la IU o API del producto de API tiene prioridad.

Configura rutas de recursos

Ten en cuenta las siguientes reglas para las rutas de recursos:

  • /: indica que se admiten la ruta base y todas las rutas secundarias de la ruta base.
  • /**: indica que se admiten todas las rutas secundarias de la ruta base, pero no la ruta base.
  • /*: indica que solo se admiten los URI de un nivel inferior a la ruta base.
  • Las rutas de recursos especificadas en el producto de API o en sus operaciones se aplican a todos los proxies de API agregados a este producto.
  • Las rutas de recursos más inclusivas y menos específicas tienen prioridad sobre las que son más específicas. Por ejemplo, si agregas / y /**, la ruta de recurso / tendrá prioridad y se ignorará la ruta de 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 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
/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/

De forma predeterminada, una ruta de recurso de / en un producto de API admite la ruta base y todas las rutas secundarias. 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.

Con los productos de API, puedes cambiar esta configuración predeterminada para que una ruta de recurso / corresponda solo a la ruta base del proxy de API. Esto significa que el producto de API no permitirá el acceso a un URI que tenga algo después de /. Si haces este cambio, en la tabla anterior solo se permitirán las primeras dos filas de “Allowed for /”

Para obtener más información, consulta Cómo interpretar la configuración del producto de API

Edita un producto de API

Para editar un producto de API, sigue estos pasos:

  2. Selecciona Publicar > Productos de API.
  3. Haz clic en la fila del producto de API que quieres editar. Apigee muestra los detalles sobre el producto de API.
  4. Haz clic en EDITAR.

  5. Edita la configuración del producto de API, según sea necesario.

    No puedes editar un recurso de API existente. En su lugar, si deseas cambiarlo, debes borrar el recurso de API y agregar una versión nueva con los valores corregidos.

    Puedes borrar un recurso si falla o necesita más desarrollo. Cuando se borra, ese recurso ya no forma parte del producto de API actual. Las apps que usan el producto de API ya no pueden acceder al recurso borrado. Los recursos borrados se quitan de un producto de API, pero no se borran del sistema, de modo que otros productos de API puedan seguir usándolo.

  6. Si la monetización de Apigee está habilitada, crea un plan de tarifas para el producto de API mediante un clic en Agregar (opcional).

  7. Haz clic en Guardar.

    Los cambios se aplican en un período corto (alrededor de cinco minutos).

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:

  2. Selecciona Publicar > Productos de API.
  3. Abre el menú Acciones en la fila del producto que deseas borrar y selecciona Borrar.
  4. Después de confirmar la operación de eliminación, esta se aplica en un período corto (alrededor de cinco minutos).