Video: Mira este breve video para obtener una introducción sobre cómo proteger tu API.
Qué aprenderás
En este instructivo se explica lo siguiente:
Cómo crear un proxy de API que requiera una clave de API.
Cómo crear un producto de API, un desarrollador y una app para desarrolladores.
Cómo llamar a tu API con una clave de API.
Es importante proteger tu API del acceso no autorizado. Una forma de hacerlo es con las claves de API.
Cuando una app realiza una solicitud a un proxy de API configurado para verificar una clave de API, la app debe proporcionar una clave válida. En el entorno de ejecución, la política Verificar clave de la API verifica que la clave de API proporcionada tenga las siguientes características:
Es válida.
No se revocó.
Coincide con la clave de API del producto de API que expone los recursos solicitados
Si la clave es válida, se permite la solicitud. Si la clave no es válida, la solicitud generará una falla en la autorización.
Selecciona tu organización mediante el menú desplegable que se encuentra en la esquina superior izquierda de la IU.
Haz clic en Desarrollar > Proxies de API para mostrar la lista de proxies de API.
Haz clic en Crear nuevo.
En el asistente para compilar un proxy, selecciona Proxy inverso (más común).
Configura el proxy de la siguiente manera:
En este campo haz lo siguiente
Sigue estas recomendaciones
Proxy name
Ingresa: helloworld_apikey
Ruta de acceso base del proyecto
Cambia a: /helloapikey
La ruta de acceso base del proyecto es parte de la URL que se usa para realizar solicitudes al proxy de API.
Descripción
Ingresa: hello world protected by API key
(API existente) de destino
Ingresa: http://mocktarget.apigee.net
Esto define la URL de destino que Apigee invoca en una solicitud al proxy de API. Este objetivo solo muestra una respuesta simple: Hello, Guest!.
Haz clic en Siguiente.
En la página Políticas comunes, selecciona Clave de API.
Con esta opción, se agregan automáticamente dos políticas a tu proxy de API y se crea un producto de API necesario para generar la clave de API.
Haz clic en Siguiente.
En la página Resumen, asegúrate de que esté seleccionado un entorno de implementación y haz clic en Crear e implementar.
Haz clic en Editar proxy para mostrar la página de descripción general del proxy de API.
Visualiza las políticas
En el editor de proxy de API haga clic en la pestaña Desarrollar. Verás que se agregaron dos políticas al flujo de solicitudes del proxy de API:
Verificar clave de API: verifica la llamada a la API para garantizar que esté presente una clave de API válida (enviada como parámetro de consulta).
Quitar la clave de API del parámetro de consulta: una política de asignación de mensaje que quita la clave de API después de que se verifica, de modo que no se pase y exponga de forma innecesaria.
Haz clic en el ícono de la política de verificación de la clave de API en la vista de flujo y observa la configuración de XML de la política en la vista de código inferior. El elemento <APIKey> indica a la política dónde debe buscar la clave de API cuando se realiza la llamada. De forma predeterminada, busca la clave como un parámetro de búsqueda llamado apikey en la solicitud HTTP:
<APIKey ref="request.queryparam.apikey" />
El nombre apikey es arbitrario y puede ser cualquier propiedad que contenga la clave de API.
Intenta llamar a la API
En este paso, realizarás una llamada a la API exitosa directamente al servicio de destino y, luego, realizarás una llamada no exitosa al proxy de la API para ver cómo lo protegen las políticas.
Listo
En un navegador web, ve a la siguiente dirección. Este es el servicio de destino al que el proxy de API está configurado para reenviar la solicitud, pero deberás acceder a él directamente por el momento:
http://mocktarget.apigee.net
Deberías obtener la respuesta correcta: Hello, Guest!
Sin la política Verificar clave de API, esta llamada te dará la misma respuesta que la llamada anterior. Pero, en este caso, deberías obtener la siguiente respuesta de error:
{"fault":{"faultstring":"Failed to resolve API Key variable request.queryparam.apikey","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}
Esto significa que, de manera correcta, no mostró una clave de API válida (como parámetro de consulta).
En los próximos pasos, obtendrás la clave de API necesaria.
Agrega un producto de API
Para agregar un producto de API mediante la IU de Apigee, sigue estos pasos:
Selecciona Publicar > Productos de API.
Haz clic en +Crear.
Ingresa los detalles del producto para el producto de API.
Campo
Descripción
Nombre
Nombre interno del producto de API. No especifiques caracteres especiales en el nombre. Nota: No puedes editar el nombre una vez que se crea el producto de API.
Nombre visible
Nombre visible del producto de API. El nombre visible se usa en la IU y se puede editar 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
Selecciona Público.
Aprueba de manera automática las solicitudes de acceso
Habilita la aprobación automática de solicitudes clave para este producto de API desde cualquier aplicación.
Cuota
Ignora este instructivo.
Permisos de OAuth permitidos
Ignora este instructivo.
En la sección Operaciones, haz clic en AGREGAR UNA OPERACIÓN.
En el campo Proxy de API, selecciona el proxy de API que acabas de crear.
En el campo Ruta, ingresa “/”. Ignora los otros campos.
Haz clic en Guardar para guardar la operación.
Haz clic en Save para guardar el producto de API.
Agrega un desarrollador y una app a tu organización
A continuación, simularemos el flujo de trabajo de un desarrollador que se registra para usar tus API. Un desarrollador tendrá una o más apps que llaman a tus API y cada app obtiene una clave de API única.
Esto te permite, como proveedor de API, tener un control más detallado sobre el acceso a tus API y, así, obtener informes más detallados sobre el tráfico de API por app.
Cree un desarrollador
Para crear un desarrollador, haz lo siguiente:
Selecciona Publicar > Desarrolladores en el menú. Nota: Si todavía estás en la pantalla de desarrollo, haz clic en "<", de DEVELOP, para mostrar el menú y selecciona Publicar > Desarrolladores.
Haz clic en + Desarrollador.
En la ventana Nuevo desarrollador, ingrese lo siguiente:
En este campo haz lo siguiente
intro
Nombre
Keyser
Apellido
Soze
Nombre de usuario
keyser
Correo electrónico
keyser@example.com
Haz clic en Crear.
Registra una aplicación
Para registrar una app de desarrollador, sigue estos pasos:
Selecciona Publicar > Apps.
Haga clic en + Aplicación.
En la ventana Nueva aplicación de desarrollador, ingrese lo siguiente:
En este campo haz lo siguiente
Sigue estas recomendaciones
Nombre y Nombre visible
Ingresa: keyser_app
Desarrollador
Selecciona: Keyser Soze (keyser@example.com)
URL de devolución de llamada y Notas
Déjelo en blanco
En la sección Credenciales, selecciona Nunca.
Las credenciales para esta app no expirarán nunca.
Haz clic en Agregar producto.
Seleccione el producto que acabas de crear.
Haz clic en Crear.
Obtenga la clave de API
Para obtener la clave de API, sigue estos pasos:
En la página Apps (Publicar > Aplicaciones), haz clic en keyser_app.
En la página keyser_app, haz clic en Mostrar junto a Clave en la sección Credenciales. Ten en cuenta que la clave está asociada al producto que creaste.
Selecciona y copia la clave. La necesitarás en el próximo paso.
Llama a la API con una clave
Ahora que tienes una clave de API, puede usarla para llamar al proxy de API. Pega la clave de API como se muestra, como un parámetro de búsqueda. Asegúrate de que no haya espacios adicionales en el parámetro de búsqueda.
Práctica recomendada: Pasa la clave en el encabezado HTTP
En este paso, modificarás el proxy para buscar la clave de API en un encabezado llamado x-apikey.
Edita el proxy de la API. Selecciona Desarrollar > Proxies de API > helloworld_apikey y ve a la vista Desarrollar.
Selecciona la política Verificar clave de API y modifica el XML de la política para que le indique que busque en header en lugar de queryparam:
<APIKey ref="request.header.x-apikey"/>
Guarda el proxy de API y usa Implementar para implementarlo.
Realiza la siguiente llamada a la API con cURL para pasar la clave de API como un encabezado llamado x-apikey. No olvides sustituir el nombre de su organización.
Ten en cuenta que, para completar por completo el cambio, también deberás configurar la política Asignar mensaje a fin de quitar el encabezado, en lugar del parámetro de búsqueda. Por ejemplo:
La protección de API a menudo implica seguridad adicional, como OAuth, un protocolo abierto que intercambia credenciales (como nombre de usuario y contraseña) por tokens de acceso. Los tokens de acceso son strings aleatorias largas que se pueden pasar mediante una canalización de mensajes, incluido de una app a otra, sin comprometer las credenciales originales.
Para obtener una descripción general de los temas relacionados con la seguridad, consulta Protege un proxy.
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-09-04 (UTC)"],[[["\u003cp\u003eThis guide demonstrates how to secure APIs in Apigee and Apigee hybrid using API keys to prevent unauthorized access.\u003c/p\u003e\n"],["\u003cp\u003eThe tutorial walks through the process of creating an API proxy, configuring it to require API keys, and setting up policies to verify and remove the API key.\u003c/p\u003e\n"],["\u003cp\u003eIt explains how to create API products, developers, and developer apps, which are needed to generate API keys for accessing the protected API proxy.\u003c/p\u003e\n"],["\u003cp\u003eThe document illustrates how to test the API proxy by making calls with and without a valid API key, showcasing the security enforcement.\u003c/p\u003e\n"],["\u003cp\u003eIt highlights the best practice of passing API keys in the HTTP header (x-apikey) instead of as a query parameter for enhanced security, and details the required modifications to the API proxy.\u003c/p\u003e\n"]]],[],null,["# Secure an API by requiring API keys\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n| **Note:** This video was recorded with a previous version of the Apigee UI; however, the concepts are still valid.\n\n\n**Video:** Check out this short video for an introduction on securing your API. \n**What you'll learn**\n\nThis tutorial explains how to:\n\n- Create an API proxy that requires an API key.\n- Create an API product, a developer, and a developer app.\n- Call your API with an API key. \nIt's important to protect your API from unauthorized access. One way to do that is with\nAPI keys.\n\nWhen an app makes a request to an API proxy that is configured to verify an API\nkey, the app must supply a valid key. At runtime, the\nVerify API Key policy checks that the supplied API key:\n\n- Is valid\n- Hasn't been revoked\n- Matches the API key for the API product that exposes the requested resources\n\nIf the key is valid, the request is allowed. If the key is invalid, the request results in\nan authorization failure. \n\nCreate the API proxy\n--------------------\n\n1. Go to the [Apigee UI](https://apigee.google.com) and sign in.\n2. Select your organization using the drop-down menu in the upper left corner of the UI.\n3. Click **Develop \\\u003e API Proxies** to display the API\n proxies list.\n\n4. Click **Create New** . \n5. In the Build a Proxy wizard, select **Reverse proxy (most common)**.\n6. Configure the proxy as follows: \n\n7. Click **Next**.\n8. On the **Common policies** page, select **API Key**. This option automatically adds two policies to your API proxy and creates an API product needed for generating the API key.\n9. Click **Next**.\n10. On the Summary page, make sure a deployment environment is selected, and click **Create and deploy**.\n11. Click **Edit proxy** to display the Overview page for the API proxy. \n\nView the policies\n-----------------\n\n1. In the API proxy editor, click the **Develop** tab. You'll see that two policies have been added to the request flow of the API proxy:\n - **Verify API Key** -- Checks the API call to make sure a valid API key is present (sent as a query parameter).\n - **Remove Query Param apikey** -- An Assign Message policy that removes the API key after it's checked, so that it doesn't get passed around and exposed unnecessarily.\n2. Click the Verify API Key policy icon in the flow view, and look at the policy's XML\n configuration in the lower code view. The `\u003cAPIKey\u003e` element tells the\n policy where it should look for the API key when the call is made. By default, it looks\n for the key as a query parameter called `apikey` in the HTTP request:\n\n ```text\n \u003cAPIKey ref=\"request.queryparam.apikey\" /\u003e\n ```\n\n The name `apikey` is arbitrary and can be any property that contains the\nAPI key. \n\nTry to call the API\n-------------------\n\nIn this step, you'll make a successful API call directly to the target service, then\nyou'll make an unsuccessful call to the API proxy to see how it's being protected by the\npolicies.\n\n1. **Success**\n\n In a web browser, go to the following address. This is the target service that the API\n proxy is configured to forward the request to, but you'll hit it directly for now: \n\n ```text\n http://mocktarget.apigee.net\n ```\n\n You should get this successful response: `Hello, Guest!`\n2. **Failure**\n\n Now try to call your API proxy: \n\n ```\n curl -v -k https://YOUR_ENV_GROUP_HOSTNAME/helloapikey\n ```\n\n where \u003cvar translate=\"no\"\u003eYOUR ENV_GROUP_HOSTNAME\u003c/var\u003e is the environment group hostname. See\n [Find the environment group hostname](/apigee/docs/api-platform/get-started/test-proxy#find-the-environment-group-hostname).\n | **Note:** If you have trouble calling the proxy, you may need to add the `Host` header, as described in [Deploy a sample proxy](/apigee/docs/api-platform/get-started/deploy-sample).\n\n Without the Verify API Key policy, this call would give you the same response as the\n previous call. But in this case, you should get the following error response: \n\n ```gdscript\n {\"fault\":{\"faultstring\":\"Failed to resolve API Key variable request.queryparam.apikey\",\"detail\":{\"errorcode\":\"steps.oauth.v2.FailedToResolveAPIKey\"}}}\n ```\n\n which means, correctly, that you didn't pass a valid API key (as a query\n parameter).\n\nIn the next steps, you'll get the required API key. \n\nAdding an API product\n---------------------\n\nTo add an API product using the Apigee UI:\n\n1. Select **Publish \\\u003e API Products**.\n2. Click **+Create**.\n3. Enter the Product Details for your API product. \n\n4. In the **Operations** section, click **ADD AN OPERATION**.\n5. In the API Proxy field, select the API proxy you just created.\n6. In the Path field, enter \"/\". Ignore the other fields.\n7. Click **Save** to save the Operation.\n8. Click **Save** to save the API product. \n\nAdd a developer and app to your\norganization\n--------------------------------------------\n\nNext, we're going to simulate the workflow of a developer signing up to use your APIs. A\ndeveloper will have one or more apps that call your APIs, and each app gets a unique API key.\nThis gives you, the API provider, more granular control over access to your APIs and more\ngranular reporting on API traffic by app.\n\n### Create a developer\n\nTo create a developer:\n\n1. Select **Publish \\\u003e Developers** in the menu. \n **Note** : If you are still in the Develop screen, click on the **\"\\\u003c\"** by **DEVELOP** to display the menu and select **Publish \\\u003e Developers**\n2. Click **+ Developer**.\n3. Enter the following in the New Developer window: \n\n4. Click **Create**.\n\n### Register an app\n\nTo register a developer app:\n\n1. Select **Publish \\\u003e Apps**.\n2. Click **+ App**.\n3. Enter the following in the New Developer App window: \n\n4. In the Credentials section, select **Never**. The credentials for this app will never expire.\n5. Click **Add product**.\n6. Select the product you just created.\n7. Click **Create**.\n\n### Get the API key\n\nTo get the API key:\n\n1. On the Apps page (Publish \\\u003e Apps), click **keyser_app**.\n2. On the **keyser_app** page, click **Show** next to **Key** in the **Credentials** section. Notice that the key is associated with the product you created. \n3. Select and copy the key. You'll use it in the next step. \n\nCall the API with a key\n-----------------------\n\nNow that you have an API key, you can use it to call the API proxy. Paste the API key as\nshown, as a query parameter. Make sure there are no extra\nspaces in the query parameter. \n\n```\ncurl -v -k https://YOUR_ENV_GROUP_HOSTNAME/helloapikey?apikey=your_api_key\n```\n\nNow when you call the API proxy, you should get this response: `Hello,\nGuest!`\n\nCongratulations! You've created an API proxy and protected it by requiring that a valid\nAPI key be included in the call.\n\nNote that in general it's not good practice to pass an API key as a query parameter. You\nshould consider [passing it in the HTTP\nheader instead](#extracreditpassingthekeyinthehttpheader). \n\nBest practice: Passing the key in the HTTP\nheader\n-------------------------------------------------\n\n| **Note:** It's a good practice to pass the API key in a header rather than in a query parameter. Query parameters appear in the browser history and network logs, which could present a security risk. Headers do not appear in the browser history and network logs.\n\nIn this step, you will modify the proxy to look for the API key in a header called `x-apikey`.\n\n1. Edit the API proxy. Select **Develop \\\u003e API Proxies \\\u003e\n helloworld_apikey** , and go to the **Develop** view.\n2. Select the **Verify API Key** policy, and modify the policy XML to tell\n the policy to look in the `header` rather than in the\n `queryparam`:\n\n ```text\n \u003cAPIKey ref=\"request.header.x-apikey\"/\u003e\n ```\n3. **Save** the API proxy and use **Deploy** to deploy it.\n4. Make the following API call using cURL to pass the API key as a header called\n `x-apikey`. Don't forget to substitute your organization name.\n\n ```scdoc\n curl -v -H \"x-apikey: {api_key_goes_here}\" http://YOUR_ENV_GROUP_HOSTNAME/helloapikey\n ```\n\nNote that to fully complete the change, you'd also need to configure the Assign Message\npolicy to remove the header instead of the query parameter. For example: \n\n```\n\u003cRemove\u003e\n \u003cHeaders\u003e\n \u003cHeader name=\"x-apikey\"/\u003e\n \u003c/Headers\u003e\n\u003c/Remove\u003e\n```\n| **Note:** You could also pass the API key as a form parameter. If you did, the Verify API Key policy would be configured like this: \n|\n| ```scdoc\n| \u003cAPIKey ref=\"request.formparam.{api_key_goes_here}\"/\u003e\n``` \n\nRelated topics\n--------------\n\nHere are some topics related to API products and keys:\n\n- [Managing API products](/apigee/docs/api-platform/publish/create-api-products)\n- [API keys](/apigee/docs/api-platform/security/api-keys)\n- [Registering app\n developers](/apigee/docs/api-platform/publish/adding-developers-your-api-product)\n- [Register apps and\n manage API keys](/apigee/docs/api-platform/publish/creating-apps-surface-your-api)\n- [Verify API Key\n policy](/apigee/docs/api-platform/reference/policies/verify-api-key-policy)\n\nAPI protection often involves additional security such as [OAuth](/apigee/docs/api-platform/security/oauth/oauth-home), an\nopen protocol that exchanges credentials (like username and password) for\naccess tokens. Access tokens are long, random strings that can be passed through a message\npipeline, including from app to app, without compromising the original credentials.\n\nFor an overview of security-related topics, see\n[Securing a proxy](https://cloud.google.com/apigee/docs/api-platform/security/api-security)."]]
