Parte 2: Genera y prueba una clave de API

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Se refactorizó y se redireccionó a Protege una API mediante la solicitud de claves de API.

Un desarrollador compila una app que realiza solicitudes a tus APIs para acceder a tus servicios de backend. Para controlar el acceso a tus APIs, puedes solicitar que el desarrollador pase una clave de API en cada solicitud. Si falta la clave o no es válida, la solicitud falla.

La publicación es el proceso de hacer que tus APIs estén disponibles para los desarrolladores de apps para consumo. Las APIs de publicación se pueden definir de manera general con las siguientes tareas:

1. Crea los productos de API en Apigee Edge que agrupan tus APIs.
2. Registra a los desarrolladores de apps en Edge. Solo un desarrollador de apps registrado puede registrar una app.
3. Los desarrolladores registran apps en Edge para acceder a los productos de API. En respuesta, el desarrollador recibe una clave de API. Ahora que el desarrollador tiene una clave de API, puede realizar solicitudes a tus APIs.

Para obtener más información, consulta Introducción a la publicación.

En la siguiente tabla, se definen algunos de los términos que se usan para registrar apps y generar claves:

Requisitos previos para este instructivo

En este instructivo, se supone que completaste el primer instructivo, en el que creas un proxy de API para acceder a la API de Yahoo Weather. Si aún no completaste el primer instructivo, consulta Protege una API mediante la solicitud de claves de API.

Paso 1: Crea un producto de API

1. En la IU de administración, haz clic en la pestaña Publicar y, luego, en Productos.
2. Haz clic en (+) Producto.
3. Ingresa o selecciona lo siguiente en los campos del diálogo Agregar producto:

   Campo	Valor
   Nombre	Producto de API gratuito
   Nombre visible	Producto de API gratuito
   Descripción	Producto de API gratuito
   Entorno	prueba
   Acceso	Solo para uso interno
   Tipo de aprobación de claves	Automático (la clave de API se aprueba automáticamente después de generarse)
   Quota	10 solicitudes por 1 hora (limita la cantidad de solicitudes a 10 por hora)
   Permisos de OAuth permitidos	dejarlo vacío

   El diálogo completado debería verse de la siguiente manera:

   

4. En la sección Recursos, elige lo siguiente:
   • Proxy de API: weatherapikey
   • Revisión: 1
   • Ruta del recurso: /forecastrss**
     
     La ruta del recurso especifica los URI de recursos a los que el producto permite que acceda una app. En este ejemplo, una app solo puede acceder al /forecastrss recurso en el weatherapikey proxy a través de este producto de API. Está prohibido intentar usar este producto de API para acceder a cualquier otro recurso en el weatherapiproxy proxy o en cualquier otro proxy.
     
     Se permiten caracteres comodín para la ruta del recurso. El comodín "/**" indica que se incluyen todos los sub-URI, lo que significa un recurso en el formulario /forecastrss/foo/bar. El comodín "/" indica que solo se incluyen los URI de un nivel inferior. Consulta Crear productos de API productos para obtener más información.
     
     Ten en cuenta que la lista desplegable Ruta del recurso muestra todos los flujos condicionales definidos en el proxy de API especificado. El flujo condicional de un proxy de API define la lógica o los pasos de procesamiento asociados con una ruta de recursos. Un producto de API controla el acceso a esas rutas de recursos.
     
5. Haz clic en Importar recurso. Se agrega la ruta del recurso y el weatherapikey proxy de API se agrega automáticamente a la sección Proxies de API para el producto.
6. Haz clic en Guardar. Tu producto nuevo aparece en la página Productos.

Obtenga más información:

• Crear productos de API

Paso 2: Registra un desarrollador

Para generar una clave de API, registra una app y la asocias con un producto de API. Sin embargo, no puedes registrar una app sin registrar primero al desarrollador de la app.

1. En la IU de administración, haz clic en la pestaña Publicar y, luego, Desarrolladores.
2. Haz clic en (+) Desarrollador.
3. En el diálogo Nuevo desarrollador, ingresa los siguientes valores:
   • Nombre: Jane
   • Apellido: Tutorial
   • Dirección de correo electrónico: janetutorial@example.com
   • Nombre de usuario: jtutorial
4. Haz clic en Guardar. El nuevo desarrollador aparece en la lista de desarrolladores en la página Desarrolladores.

Obtenga más información:

• Administra desarrolladores de apps

Paso 3: Registra la app

Ahora que tienes un producto de API y un desarrollador, puedes registrar una app con el producto de API. El registro de la app genera la clave de API para los productos de API asociados con la app. Luego, puedes distribuir la clave a los desarrolladores de apps para que puedan acceder a las funciones de los productos de API desde la app.

1. En la IU de la plataforma de API, haz clic en la pestaña Publicar y, luego, en Apps para desarrolladores.
2. Haz clic en (+) App para desarrolladores.
3. En el diálogo Agregar una app, ingresa los siguientes valores:
   • Nombre visible: App de clave de API de Weather
   • Desarrollador: Jane Tutorial (janetutorial@example.com)
   • Callback URL: dejar en blanco
4. Asocia la app con un producto:
   1. En la sección Productos, haz clic en + Producto.
   2. Selecciona Producto de API gratuito.
   3. Haz clic en el ícono de marca de verificación para aceptar los cambios.
5. Haz clic en Guardar. La app nueva aparece en la lista de apps en la página Apps para desarrolladores.
6. Selecciona App de clave de API de Weather en la lista de apps. Se abrirá la página de detalles de la app.
7. Como seleccionaste Tipo de aprobación de claves: Automático cuando creaste el producto de API, la clave de API se aprueba automáticamente y puedes verla de inmediato. (Si hubieras seleccionado Tipo de aprobación: Manual, deberías hacer clic en Aprobar en la columna Acciones para el producto de API gratuito para aprobar la clave de API.)
8. En la sección Productos, junto a la entrada del producto de API gratuito, haz clic en Mostrar en las columnas Clave de consumidor y Secreto de consumidor para mostrar las claves generadas.
   

   La clave de consumidor es otro nombre para la clave de API y es la única clave que necesita una app para acceder al recurso de pronóstico a través de tu proxy de API . Se necesita el secreto de consumidor (junto con la clave de consumidor) para proteger una API a través de OAuth 2.0. Consulta, por ejemplo, OAuth 2.0: Configura un proxy de API nuevo.

Obtenga más información:

• Registra apps y administra claves de API.

Paso 4: Usa la clave de API en una solicitud

Para asegurarte de que la política VerifyAPIKey funcione correctamente, debes probarla haciendo una llamada al proxy de API con una clave de API válida. Puedes solicitar el proxy de API en un navegador, desde la página Trace del proxy de API, desde la consola de Apigee o con cURL. La URL para solicitar tiene el siguiente formato:

http://{org-name}-test.apigee.net/v1/weatherapikey/forecastrss?w=12797282&apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

Sustituye el nombre de la organización de Apigee por {org-name} y el valor apikey correcto.

Busca el siguiente contenido en la respuesta:

<rss xmlns:yweather="http://xml.weather.yahoo.com/ns/rss/1.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" version="2.0"> 
<channel> <title>Yahoo! Weather - Palo Alto, CA</title> 
<link>http://us.rd.yahoo.com/dailynews/rss/weather/Palo_Alto__CA/*http://weather.yahoo.com/forecast/USCA1093_f.html</link> 
<description>Yahoo! Weather for Palo Alto, CA</description> <language>en-us</language>

Si omites la clave de API de la solicitud o especificas un valor de clave no válido, recibirás una respuesta de error con el siguiente formato:

{"fault":{"faultstring":"Failed to resolve API Key variable null","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

Paso 5: ¿Adónde quieres ir después?

Ahora que realizaste una solicitud a la API con un parámetro de consulta para pasar la clave de API, modifica la API para pasar la clave como un encabezado.