Eine Web-API, die Web-APIs aufruft: Aufrufen einer API

Sobald Sie über ein Token verfügen, können Sie eine geschützte Web-API aufrufen. In der Regel rufen Sie die Downstream-APIs über den Controller oder die Seiten Ihrer Web-API auf.

Controllercode

ASP.NET Core

Wenn Sie Microsoft.Identity.Web verwenden, gibt es drei Verwendungsszenarien:

• Option 1: Aufrufen von Microsoft Graph mit dem SDK
• Option 2: Aufrufen einer Downstream-Web-API mit der Hilfsklasse
• Option 3: Aufrufen einer Downstream-Web-API ohne die Hilfsklasse

Option 1: Aufrufen von Microsoft Graph mit dem SDK

In diesem Szenario haben Sie das NuGet-Paket Microsoft.Identity.Web.GraphServiceClient und .AddMicrosoftGraph() in der Datei Startup.cs (wie unter Codekonfiguration angegeben) hinzugefügt, und Sie können den GraphServiceClient direkt in den Controller oder Seitenkonstruktor zur Verwendung in den Aktionen einfügen. Auf der folgenden Razor-Beispielseite wird das Foto des angemeldeten Benutzers angezeigt.

 [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;
         }
     }
 }

Option 2: Aufrufen einer Downstream-Web-API mit der Hilfsklasse

In diesem Szenario haben Sie .AddDownstreamApi() in der Datei Startup.cs (wie unter Codekonfiguration angegeben) hinzugefügt, und Sie können einen IDownstreamWebApi-Dienst direkt in den Controller oder Seitenkonstruktor einfügen und in den Aktionen verwenden:

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

     public TodoListController(IDownstreamWebApi downstreamWebApi)
     {
         _downstreamWebApi = downstreamWebApi;
     }

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

Die CallApiForUserAsync-Methode verfügt auch über stark typisierte generische Überschreibungen, mit denen Sie ein Objekt direkt empfangen können. Beispielsweise wurde mit der folgenden Methode eine Todo-Instanz empfangen, die eine stark typisierte Darstellung der von der Web-API zurückgegebenen JSON ist.

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

Option 3: Aufrufen einer Downstream-Web-API ohne die Hilfsklasse

Wenn Sie einen Autorisierungsheader mithilfe der IAuthorizationHeaderProvider-Schnittstelle abrufen möchten, setzt der folgende Code den Beispielcode fort, der unter Eine Web-API, die Web-APIs aufruft: Abrufen eines Tokens für die App gezeigt ist. Der Code wird in den Aktionen der API-Controller aufgerufen. Er ruft eine nachgelagerte API namens todolist auf.

Nachdem Sie das Token abgerufen haben, können Sie es als Bearertoken zum Aufrufen der nachgelagerten API verwenden.

private async Task CallTodoListService(string accessToken)
{
  // After the token has been returned by Microsoft.Identity.Web, add it to the HTTP authorization header before making the call to access the todolist service.
  authorizationHeader = await authorizationHeaderProvider.GetAuthorizationHeaderForUserAsync(scopes);
  _httpClient.DefaultRequestHeaders["Authorization"] = authorizationHeader;

  // Call the todolist service.
  HttpResponseMessage response = await _httpClient.GetAsync(TodoListBaseAddress + "/api/todolist");
  // ...
}

ASP.NET

Bei Verwendung von Microsoft.Identity.Web stehen Ihnen drei Optionen zum Aufrufen einer API zur Verfügung:

• Option 1: Aufrufen von Microsoft Graph mit dem Microsoft Graph SDK
• Option 2: Aufrufen einer Downstream-Web-API mit der Hilfsklasse
• Option 3: Aufrufen einer Downstream-Web-API ohne die Hilfsklasse

Option 1: Aufrufen von Microsoft Graph mit dem SDK von der OWIN-App

Sie möchten Microsoft Graph aufrufen. In diesem Szenario haben Sie AddMicrosoftGraph in der Datei Startup.cs hinzugefügt (wie unter Codekonfiguration angegeben), und Sie können GraphServiceClient in den Controller oder Seitenkonstruktor zur Verwendung in den Aktionen einfügen, indem Sie die GetGraphServiceClient()-Erweiterungsmethode im Controller verwenden. Im folgenden Beispiel wird das Foto des angemeldeten Benutzers angezeigt.

[Authorize]
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;
  }
 }
}

Option 2: Aufrufen einer Downstream-Web-API mit der Hilfsklasse von der OWIN-App

Sie möchten eine andere Web-API als Microsoft Graph aufrufen. In diesem Fall haben Sie AddDownstreamApi in der Datei Startup.cs hinzugefügt (wie unter Codekonfiguration angegeben), und Sie können den IDownstreamApi-Dienst in Ihrem Controller abrufen, indem Sie die GetDownstreamApi-Erweiterungsmethode im Controller aufrufen:

[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 verfügt auch über stark typisierte generische Überschreibungen, mit denen Sie ein Objekt direkt empfangen können. Beispielsweise wird mit der folgenden Methode eine Todo-Instanz empfangen, die eine stark typisierte Darstellung der von der Web-API zurückgegebenen JSON ist.

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

Option 3: Aufrufen einer Downstream-Web-API ohne Hilfsklasse von der OWIN-App

Sie haben sich entschieden, einen Autorisierungsheader mit dem IAuthorizationHeaderProvider-Dienst abzurufen, und müssen ihn nun in HttpClient oder HttpRequest verwenden. In diesem Fall setzt der folgende Code den Beispielcode fort, den Sie hier finden: Web-API, die Web-APIs aufruft: Abrufen eines Tokens für die App. Der Code wird in den Aktionen der Web-API-Controller aufgerufen.

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

Der folgende Code setzt den Beispielcode fort, den Sie hier finden: Eine Web-API, die Web-APIs aufruft: Abrufen eines Tokens für die App. Der Code wird in den Aktionen der API-Controller aufgerufen. Er ruft die Downstream-API von Microsoft Graph auf.

Nachdem Sie das Token abgerufen haben, können Sie es als Bearertoken zum Aufrufen der nachgelagerten API verwenden.

private String callMicrosoftGraphMeEndpoint(String accessToken){
    RestTemplate restTemplate = new RestTemplate();

    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_JSON);

    headers.set("Authorization", "Bearer " + accessToken);

    HttpEntity<String> entity = new HttpEntity<>(null, headers);

    String result = restTemplate.exchange("https://graph.microsoft.com/v1.0/me", HttpMethod.GET,
            entity, String.class).getBody();

    return result;
}

Python

Ein Beispiel zur Veranschaulichung dieses Flows mit MSAL Python ist unter ms-identity-python-on-behalf-of verfügbar.

Nächste Schritte

• Erfahren Sie mehr, indem Sie in der folgenden mehrteiligen Tutorial-Serie eine ASP.NET Core Web-App für die Benutzeranmeldung erstellen.

• Erkunden von Beispielen für Web-APIs der Microsoft Identitätsplattform