Ejercicio: Llamada a una API con una clave de suscripción

  • 5 minutos

Una clave de suscripción es una manera de restringir el acceso a una API.

En el ejemplo de la empresa de zapatos, NorthWind Shoes va a trabajar con un proveedor y quiere que este pueda acceder directamente a la API de inventario. El acceso de los asociados se debe restringir mediante una clave de suscripción en todas las llamadas a la API.

Aquí, obtiene la clave de suscripción de la API. A continuación, prueba el acceso a la API con y sin la clave de suscripción.

Obtención de la clave de suscripción

Los asociados reciben su clave como parte de un proceso de incorporación. En este ejercicio, agrega una suscripción específicamente para NorthWindShoes API. Una vez que tenga una clave, siga el proceso estándar para usar la clave en las llamadas API.

  1. En el menú de Azure Portal, o bien en la página Inicio, seleccione Todos los recursos y, luego, seleccione la instancia de API Management.

  2. En el panel de menús de la izquierda, en API, seleccione Suscripciones.

  3. Seleccione + Suscripción y escriba los valores siguientes para cada opción. Seleccione Crear.

    Configuración Value
    Nombre NorthWind
    Nombre para mostrar NorthWind subscription
    Ámbito Seleccione API y, después, NorthWindShoes Products en la lista desplegable.

  4. Seleccione el menú contextual (...) en la suscripción integrada de Northwind y, luego, seleccione Mostrar u ocultar claves.

  5. Seleccione el botón Haga clic para copiar en CLAVE PRINCIPAL.

  6. Guarde esta clave en alguna parte, como el Bloc de notas.

Uso de la clave de suscripción en la llamada API

El siguiente paso consiste en usar la clave de suscripción para probar el acceso del desarrollador a la API publicada.

  1. Ejecute el comando siguiente en Cloud Shell para acceder a la operación Products de la API, y reemplace <apim gateway> por el nombre de la puerta de enlace.

    curl https://<apim gateway>.azure-api.net/api/Products

    Recibe un mensaje 401, Acceso denegado debido a que falta la clave de suscripción.

  2. Ahora repita la solicitud curl, esta vez incluyendo la clave de suscripción.

  3. Ejecute el comando siguiente en Cloud Shell y reemplace <primary key> por la clave que ha guardado antes y <apim gateway> por el nombre de la puerta de enlace.

    curl --header "Ocp-Apim-Subscription-Key: <primary key>" https://<apim gateway>.azure-api.net/api/Products

    Ahora podrá acceder a la API y ver una lista de productos que se devuelven a la consola.