OAuth 2.0: Configura un proxy de API nuevo

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

Consulta la documentación de Apigee Edge.

El tipo de otorgamiento de credenciales de cliente define un procedimiento para emitir tokens de acceso a cambio de las credenciales de la app. Estas credenciales de la app son el par de clave y secreto del consumidor que Apigee emite para cada app que se registra en una organización. Para obtener más información, consulta Implementa el tipo de otorgamiento de código de autorización.

Agrega OAuth 2.0 a un proxy de API nuevo

Puedes agregar la verificación de OAuth a una API cuando creas un nuevo proxy de API en la IU de Apigee.

Para agregar 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 los 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 Google Cloud nombre del proyecto.
  3. En el panel Proxies de API, haz clic en + Crear.
  4. En el panel Crear un proxy, en Plantilla de proxy, selecciona Proxy inverso (más común).
  5. Configura el proxy de la siguiente manera:
    Nombre Valor
    Proxy name helloworld_oauth2
    Base Path

    /hellooauth2

    La ruta de acceso base del proyecto es parte de la URL que se usa para realizar solicitudes al proxy de API.
    Descripción hello world protected by OAuth v2.0
    (API existente) de destino

    https://mocktarget.apigee.net/ip

    Esto define la URL de destino que Apigee invoca en una solicitud al proxy de API. Este objetivo solo devuelve una respuesta simple: Hello, Guest!.
  6. Haz clic en Siguiente.
  7. Implementa (opcional):
    • Entornos de implementación: Opcional. Usa las casillas de verificación para seleccionar uno o más entornos en los que implementar tu proxy. Si prefieres no implementar el proxy en este punto, deja vacío el campo Entornos de implementación. Siempre puedes implementar el proxy más adelante.
    • Cuenta de servicio: (opcional) Conecta una cuenta de servicio a tu implementación para permitir que tu proxy acceda a los servicios de Google Cloud, como se especifica en el rol y los permisos de la cuenta de servicio.
  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, haz clic en Agregar política.
  11. En el panel Crear política, en Seguridad, selecciona Verificar clave de API.
  12. En el panel Verificar clave de API, completa los campos obligatorios en las secciones Nombre y Nombre visible con los siguientes valores:
    • Nombre: Ingresa un nombre para la política. Por ejemplo: VerifyAPIKey.
    • Nombre visible: Ingresa el nombre de la política para usarlo en la IU. Por ejemplo, Verify API Key
  13. Haz clic en Crear.
  14. Haz clic en para agregar otra política.
  15. En el panel Crear política, en Mediación, selecciona Asignar mensaje.
  16. En el panel Asignar mensaje, completa los campos obligatorios en las secciones Nombre y Nombre visible con los siguientes valores:
    • Nombre: Ingresa un nombre para la política. Por ejemplo: AssignMessage.
    • Nombre visible: Ingresa el nombre de la política para usarlo en la IU. Por ejemplo, Assign Message
  17. Haz clic en Crear.

  18. Actualiza el contenido de la política Assign Message de la siguiente manera:

    
<?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. Agrega las políticas VerifyApiKey y Remove Header Authorization.
    1. En el menú Proxy endpoints, haz clic en Preflow.
    2. En el panel Solicitud del editor visual, haz clic en Agregar paso de política.
    3. En el panel Agregar paso de la política, selecciona Verificar clave de API.
    4. Haz clic en Agregar.
    5. En el panel Solicitud del editor visual, haz clic en Agregar paso de política.
    6. En el panel Agregar paso de la política, selecciona Remove Header Authorization.
    7. Haz clic en Agregar.
  20. Haz clic en Guardar.

IU clásica

  1. Accede a la IU de Apigee.
  2. Selecciona Desarrollar > Proxies de API en la barra de navegación izquierda.
  3. Haz clic en + Proxy.
  4. Usa el asistente de creación de proxy para crear un proxy inverso. Consulta Compila un proxy de API simple.
  5. En la página Políticas comunes del asistente, haz clic en el botón de selección junto a OAuth v2.0.
1 proxy de API recién creado, uno para verificar los tokens de acceso y otro para quitar el token de acceso una vez que se haya verificado.

Ten en cuenta que la casilla de verificación Publicar API de productos se puede seleccionar y se selecciona de forma automática. Marca esta opción si quieres generar automáticamente un producto cuando compiles el proxy de API nuevo. El producto generado automáticamente se creará con una asociación al nuevo proxy de API. Si tienes un producto existente con el que quieres asociar esta API nueva, asegúrate de borrar esta casilla de verificación para no crear un producto innecesario. Para obtener información sobre productos, consulta ¿Qué es un producto de API?