Aplicación web que llama a las API web: Llamada a una API de web

Ahora que dispone de un token, puede llamar a una API web protegida. Normalmente, se llama a una API de nivel inferior desde el controlador o las páginas de la aplicación web.

Llamada a una API web protegida

La llamada a una API web protegida depende del lenguaje y el marco elegidos:

ASP.NET Core

Cuando se usa Microsoft.Identity.Web, hay tres opciones de uso para llamar a una API:

• Opción 1: Llamada a Microsoft Graph con el SDK de Microsoft Graph
• Opción 2: Llamada a una API web de nivel inferior con la clase auxiliar
• Opción 3: Llamada a una API web de nivel inferior sin la clase auxiliar

Opción 1: Llamada a Microsoft Graph con el SDK

En este escenario, llamará a Microsoft Graph agregando el paquete NuGet Microsoft.Identity.Web.GraphServiceClient e incluyendo .AddMicrosoftGraph() en Startup.cs tal como se especifica en Configuración de código. A continuación, puede insertar directamente GraphServiceClient en el controlador o constructor de página para usarlo en las acciones. En la siguiente página de Razor de ejemplo se muestra la foto del usuario que inició sesión.

[Authorize]
[AuthorizeForScopes(Scopes = new[] { "user.read" })]
public class IndexModel : PageModel
{
 private readonly GraphServiceClient _graphServiceClient;

 public IndexModel(GraphServiceClient graphServiceClient)
 {
    _graphServiceClient = graphServiceClient;
 }

 public async Task OnGet()
 {
  var user = await _graphServiceClient.Me.GetAsync();
  try
  {
   using (var photoStream = await _graphServiceClient.Me.Photo.Content.GetAsync())
   {
    byte[] photoByte = ((MemoryStream)photoStream).ToArray();
    ViewData["photo"] = Convert.ToBase64String(photoByte);
   }
   ViewData["name"] = user.DisplayName;
  }
  catch (Exception)
  {
   ViewData["photo"] = null;
  }
 }
}

Para obtener un ejemplo completo, consulte la aplicación web de ASP.NET Core que llama a Microsoft Graph.

Opción 2: Llamada a una API web de nivel inferior con la clase auxiliar

Desea llamar a una API web que no es Microsoft Graph. En ese caso, ha agregado AddDownstreamApi en el archivo Startup.cs tal y como se especifica en Configuración del código y puede insertar directamente el servicio IDownstreamApi en el controlador o en el constructor de la página y usarlo en las acciones:

[Authorize]
[AuthorizeForScopes(ScopeKeySection = "TodoList:Scopes")]
public class TodoListController : Controller
{
  private IDownstreamApi _downstreamApi;
  private const string ServiceName = "TodoList";

  public TodoListController(IDownstreamApi downstreamApi)
  {
    _downstreamApi = downstreamApi;
  }

  public async Task<ActionResult> Details(int id)
  {
    var value = await _downstreamApi.CallApiForUserAsync(
      ServiceName,
      options =>
      {
        options.RelativePath = $"me";
      });
      return View(value);
  }
}

CallWebApiForUserAsync también tiene invalidaciones genéricas fuertemente tipadas que permiten recibir directamente un objeto. Por ejemplo, el método siguiente recibe una instancia de Todo, que es una representación fuertemente tipada del código JSON devuelto por la API web.

    // GET: TodoList/Details/5
    public async Task<ActionResult> Details(int id)
    {
        var value = await _downstreamApi.CallApiForUserAsync<object, Todo>(
            ServiceName,
            null,
            options =>
            {
                options.HttpMethod = HttpMethod.Get;
                options.RelativePath = $"api/todolist/{id}";
            });
        return View(value);
    }

Para obtener un ejemplo completo, consulte la aplicación web de ASP.NET Core que llama a una API

Opción 3: Llamada a una API web de nivel inferior sin la clase auxiliar

Ha decidido adquirir un token manualmente mediante el servicio IAuthorizationHeaderProvider y ahora debe usar el token. En ese caso, el código siguiente continúa el código de ejemplo que se muestra en Aplicación web que llama a las API web: Adquisición de un token para la aplicación. Se llama al código en las acciones de los controladores de la aplicación web.

Una vez que haya adquirido el token, úselo como token de portador para llamar a la API de nivel inferior, que en este caso es Microsoft Graph.

public async Task<IActionResult> Profile()
{
  // Acquire the access token.
  string[] scopes = new string[]{"user.read"};
  string authorizationHeader = await IAuthorizationHeaderProvider.GetAuthorizationHeaderForUserAsync(scopes);

  // Use the access token to call a protected web API.
  HttpClient httpClient = new HttpClient();
  client.DefaultRequestHeaders.Add("Authorization", authorizationHeader);

  var response = await httpClient.GetAsync($"{webOptions.GraphApiUrl}/beta/me");

  if (response.StatusCode == HttpStatusCode.OK)
  {
    var content = await response.Content.ReadAsStringAsync();

    dynamic me = JsonConvert.DeserializeObject(content);
    ViewData["Me"] = me;
  }

  return View();
}

Nota:

Puede usar el mismo principio para llamar a cualquier API web.

La mayoría de las API web de Azure proporcionan un SDK que simplifica la llamada a la API, como en el caso de Microsoft Graph.

ASP.NET

Cuando se usa Microsoft.Identity.Web, hay tres opciones de uso para llamar a una API:

• Opción 1: Llamada a Microsoft Graph con el SDK de Microsoft Graph
• Opción 2: Llamada a una API web de nivel inferior con la clase auxiliar
• Opción 3: Llamada a una API web de nivel inferior sin la clase auxiliar

Opción 1: llamar a Microsoft Graph con el SDK desde la aplicación OWIN

Desea llamar a Microsoft Graph. En este escenario, ha agregado AddMicrosoftGraph en el archivo Startup.cs tal y como se especifica en Configuración del código y puede obtener el elemento GraphServiceClient en el controlador o en el constructor de la página para su uso en las acciones mediante el método de extensión GetGraphServiceClient() en el controlador. En el siguiente ejemplo, se muestra la foto del usuario que inició sesión.

[Authorize]
[AuthorizeForScopes(Scopes = new[] { "user.read" })]
public class HomeController : Controller
{

 public async Task GetIndex()
 {
  var graphServiceClient = this.GetGraphServiceClient();
  var user = await graphServiceClient.Me.GetAsync();
  try
  {
   using (var photoStream = await graphServiceClient.Me.Photo.Content.GetAsync())
   {
    byte[] photoByte = ((MemoryStream)photoStream).ToArray();
    ViewData["photo"] = Convert.ToBase64String(photoByte);
   }
   ViewData["name"] = user.DisplayName;
  }
  catch (Exception)
  {
   ViewData["photo"] = null;
  }
 }
}

Para obtener un ejemplo completo, consulte la aplicación web OWIN de ASP.NET que llama a Microsoft Graph

Opción 2: llamar a una API web de nivel inferior con la clase auxiliar desde la aplicación OWIN

Desea llamar a una API web que no es Microsoft Graph. En ese caso, ha agregado AddDownstreamApi en Startup.cs, tal y como se especifica en Configuración de código, y puede obtener el servicio IDownstreamApi en el controlador llamando al método de extensión GetDownstreamApi en el controlador:

[Authorize]
public class TodoListController : Controller
{ 
  public async Task<ActionResult> Details(int id)
  {
    var downstreamApi = this.GetDownstreamApi();
    var value = await downstreamApi.CallApiForUserAsync(
      ServiceName,
      options =>
      {
        options.RelativePath = $"me";
      });
      return View(value);
  }
}

CallApiForUserAsync también tiene invalidaciones genéricas fuertemente tipadas que permiten recibir directamente un objeto. Por ejemplo, el método siguiente recibe una instancia de Todo, que es una representación fuertemente tipada del código JSON devuelto por la API web.

    // GET: TodoList/Details/5
    public async Task<ActionResult> Details(int id)
    {
        var downstreamApi = this.GetDownstreamApi();
        var value = await downstreamApi.CallApiForUserAsync<object, Todo>(
            ServiceName,
            null,
            options =>
            {
                options.HttpMethod = HttpMethod.Get;
                options.RelativePath = $"api/todolist/{id}";
            });
        return View(value);
    }

Opción 3: llamar a una API web de nivel inferior sin la clase auxiliar desde la aplicación OWIN

Ha decidido adquirir un encabezado de autorización mediante el servicio IAuthorizationHeaderProvider y ahora deberá usarlo en HttpClient o HttpRequest. En ese caso, el código siguiente continúa el código de ejemplo que se muestra en Aplicación web que llama a las API web: Adquisición de un token para la aplicación. Se llama al código en las acciones de los controladores de la aplicación web.

public async Task<IActionResult> Profile()
{
  // Acquire the access token.
  string[] scopes = new string[]{"user.read"};
  var IAuthorizationHeaderProvider = this.GetAuthorizationHeaderProvider();
  string authorizationHeader = await IAuthorizationHeaderProvider.GetAuthorizationHeaderForUserAsync(scopes);

  // Use the access token to call a protected web API.
  HttpClient httpClient = new HttpClient();
  client.DefaultRequestHeaders.Add("Authorization", authorizationHeader);

  var response = await httpClient.GetAsync($"{webOptions.GraphApiUrl}/beta/me");

  if (response.StatusCode == HttpStatusCode.OK)
  {
    var content = await response.Content.ReadAsStringAsync();

    dynamic me = JsonConvert.DeserializeObject(content);
    ViewData["Me"] = me;
  }

  return View();
}

Java

private String getUserInfoFromGraph(String accessToken) throws Exception {
    // Microsoft Graph user endpoint
    URL url = new URL("https://graph.microsoft.com/v1.0/me");

    HttpURLConnection conn = (HttpURLConnection) url.openConnection();

    // Set the appropriate header fields in the request header.
    conn.setRequestProperty("Authorization", "Bearer " + accessToken);
    conn.setRequestProperty("Accept", "application/json");

    String response = HttpClientHelper.getResponseStringFromConn(conn);

    int responseCode = conn.getResponseCode();
    if(responseCode != HttpURLConnection.HTTP_OK) {
        throw new IOException(response);
    }

    JSONObject responseObject = HttpClientHelper.processResponse(responseCode, response);
    return responseObject.toString();
}

Node.js

Después de recuperar correctamente un token, el código usa el paquete axios para consultar el punto de conexión de la API y recuperar un resultado JSON.

/**
 * Attaches a given access token to a MS Graph API call
 * @param endpoint: REST API endpoint to call
 * @param accessToken: raw access token string
 */
async function fetch(endpoint, accessToken) {
    const options = {
        headers: {
            Authorization: `Bearer ${accessToken}`
        }
    };

    console.log(`request made to ${endpoint} at: ` + new Date().toString());

    try {
        const response = await axios.get(endpoint, options);
        return await response.data;
    } catch (error) {
        throw new Error(error);
    }
}

Python

Después de recuperar correctamente un token, el código usa el paquete de solicitudes para consultar el punto de conexión de la API y recuperar un resultado JSON.

@app.route("/call_downstream_api")
def call_downstream_api():
    token = auth.get_token_for_user(app_config.SCOPE)
    if "error" in token:
        return redirect(url_for("login"))
    # Use access token to call downstream api
    api_result = requests.get(
        app_config.ENDPOINT,
        headers={'Authorization': 'Bearer ' + token['access_token']},
        timeout=30,
    ).json()
    return render_template('display.html', result=api_result)

Pasos siguientes

• Para más información, cree una aplicación web de ASP.NET Core que inicie sesión a los usuarios en las siguientes series de tutoriales de varias partes

• Exploración de ejemplos de aplicaciones web de la plataforma de identidad de Microsoft