OAuth 2.0: configurar un nuevo proxy de APIs

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

Consulta la documentación de Apigee Edge.

El tipo de autorización de credenciales de cliente define un procedimiento para emitir tokens de acceso a cambio de credenciales de aplicación. Estas credenciales de aplicación son el par de clave y secreto de consumidor que Apigee emite para cada aplicación registrada en una organización. Para obtener más información, consulta el artículo Implementar el tipo de concesión de código de autorización.

Añadir OAuth 2.0 a un nuevo proxy de API

Puedes añadir la verificación de OAuth a una API cuando crees un proxy de API en la interfaz de usuario de Apigee.

Para añadir la verificación de OAuth a una API, sigue estos pasos:

Apigee en la consola de Cloud

  1. En la Google Cloud consola, ve a la página Desarrollo de proxy > Proxies de API.

    Ir a proxies de API

  2. Selecciona tu organización en el selector de proyectos del panel Google Cloud . El nombre de la organización es el mismo que el de tu Google Cloud proyecto.
  3. En el panel Proxies de APIs, haz clic en + Crear.
  4. En el panel Crear un proxy, en Plantilla de proxy, selecciona Proxy inverso (el más habitual).
  5. Configura el proxy con lo siguiente:
    Nombre Valor
    Nombre del proxy helloworld_oauth2
    Ruta base

    /hellooauth2

    La ruta base del proyecto forma parte de la URL que se usa para enviar solicitudes al proxy de la API.
    Descripción hello world protected by OAuth v2.0
    Destino (API actual)

    https://mocktarget.apigee.net/ip

    Define la URL de destino que invoca Apigee en una solicitud al proxy de API. Este destino solo devuelve una respuesta sencilla: Hello, Guest!.
  6. Haz clic en Siguiente.
  7. Implementar (opcional):
    • Entornos de implementación: opcional. Utilice las casillas de verificación para seleccionar uno o varios entornos en los que implementar su proxy. Si prefieres no implementar el proxy en este momento, deja el campo Entornos de implementación vacío. Puedes implementar el proxy más adelante.
    • Cuenta de servicio: opcional. Asocia una cuenta de servicio a tu implementación para que tu proxy pueda acceder a los servicios, tal como se especifica en el rol y los permisos de la cuenta de servicio. Google Cloud
  8. Haz clic en Crear.
  9. En el panel Resumen del proxy del proxy helloworld_apikey, haz clic en la pestaña Desarrollar.
  10. En el menú Políticas, haga clic en Añadir política.
  11. En el panel Crear política, en Seguridad, selecciona Verificar clave de API.
  12. En el panel Verificar clave de API, rellena los campos obligatorios de las secciones Nombre y Nombre visible con los siguientes valores:
    • Nombre: introduce un nombre de política. Por ejemplo, VerifyAPIKey.
    • Nombre visible: introduce el nombre de la política que se usará en la interfaz de usuario. Por ejemplo, Verify API Key.
  13. Haz clic en Crear.
  14. Haz clic en para añadir otra política.
  15. En el panel Crear política, en Mediación, selecciona Asignar mensaje.
  16. En el panel Asignar mensaje, rellene los campos obligatorios de las secciones Nombre y Nombre visible con los siguientes valores:
    • Nombre: introduce un nombre de política. Por ejemplo, AssignMessage.
    • Nombre visible: introduce el nombre de la política que se usará en la interfaz de usuario. Por ejemplo, Assign Message.
  17. Haz clic en Crear.

  18. Actualiza el contenido de la política Asignar mensaje con lo siguiente:

    
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="remove-header-authorization">
    <DisplayName>Remove Header Authorization</DisplayName>
    <Remove>
        <Headers>
            <Header name="Authorization"/>
        </Headers>
    </Remove>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>
  19. Añade las políticas VerifyApiKey y Remove Header Authorization.
    1. En el menú Proxy endpoints (Endpoints de proxy), haz clic en Preflow (Preflow).
    2. En el panel Solicitud del editor visual, haz clic en Añadir paso de política.
    3. En el panel del paso Añadir política, selecciona Verificar clave de API.
    4. Haz clic en Añadir.
    5. En el panel Solicitud del editor visual, haz clic en Añadir paso de política.
    6. En el panel de pasos para añadir una política, selecciona Eliminar autorización de encabezado.
    7. Haz clic en Añadir.
  20. Haz clic en Guardar.

Interfaz clásica

  1. Inicia sesión en la interfaz de Apigee.
  2. En la barra de navegación de la izquierda, selecciona Desarrollar > Proxies de API.
  3. Haz clic en + Proxy.
  4. Usa el asistente Crear proxy para crear un proxy inverso. Consulta Crear un proxy de API sencillo.
  5. En la página Common policies (Políticas comunes) del asistente, selecciona el botón de radio situado junto a OAuth v2.0.
1 proxy de API recién creado, uno para verificar los tokens de acceso y otro para eliminar el token de acceso después de que se haya verificado.

Ten en cuenta que la casilla Publicar API Producto se puede seleccionar y se selecciona automáticamente. Marca esta casilla si quieres generar automáticamente un producto al compilar el nuevo proxy de API. El producto generado automáticamente se creará con una asociación al nuevo proxy de API. Si ya tienes un producto al que quieres asociar esta nueva API, asegúrate de desmarcar esta casilla para no crear un producto innecesario. Para obtener información sobre los productos, consulta el artículo ¿Qué es un producto de API?