Aplikacja internetowa, która wywołuje interfejsy API sieci Web: wywoływanie interfejsu API sieci Web

Dotyczy: Dzierżawcy siły roboczej Biały okrąg z szarym symbolem X. dzierżawcy zewnętrzni (White circle with a gray X symbol.dowiedz się więcej)

Teraz, gdy masz token, możesz wywołać chroniony internetowy interfejs API. Zazwyczaj wywołujesz podrzędny interfejs API z kontrolera lub stron aplikacji webowej.

Wywołaj chroniony internetowy interfejs API

Wywoływanie chronionego internetowego interfejsu API zależy od wybranego języka i platformy:

ASP.NET Rdzeń

W przypadku korzystania z aplikacji Microsoft.Identity.Web dostępne są trzy opcje użycia do wywoływania interfejsu API:

• Opcja 1. Wywoływanie programu Microsoft Graph przy użyciu zestawu Microsoft Graph SDK
• Opcja 2. Wywoływanie podrzędnego internetowego interfejsu API za pomocą klasy pomocniczej
• Opcja 3. Wywoływanie podrzędnego internetowego interfejsu API bez klasy pomocniczej

Opcja 1. Wywoływanie programu Microsoft Graph za pomocą zestawu SDK

W tym scenariuszu wywołujesz Microsoft Graph, dodając pakiet NuGet Microsoft.Identity.Web.GraphServiceClient i uwzględniając .AddMicrosoftGraph() w Startup.cs, zgodnie z sekcją Konfiguracja kodu. Następnie możesz bezpośrednio wstrzyknąć element GraphServiceClient do swojego kontrolera lub konstruktora strony, aby wykorzystać go w działaniach. Poniższa przykładowa strona Razor wyświetla zdjęcie zalogowanego użytkownika.

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

Aby uzyskać pełny przykład, zobacz aplikację internetową ASP.NET Core, która wywołuje Microsoft Graph.

Opcja 2. Wywoływanie podrzędnego internetowego interfejsu API za pomocą klasy pomocniczej

Chcesz wywołać internetowy interfejs API inny niż Microsoft Graph. Można w takim przypadku dodać AddDownstreamApi w Startup.cs, jak określono w Konfiguracji kodu, i można bezpośrednio wstrzyknąć usługę IDownstreamApi w kontrolerze lub konstruktorze strony i użyć jej w akcjach:

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

Dodatkowo, komponent CallWebApiForUserAsync posiada silnie typizowane generyczne przesłonięcia, które umożliwiają bezpośrednie pobieranie obiektu. Na przykład następująca metoda odbiera instancję Todo, która jest silnie typizowaną reprezentacją kodu JSON zwracanego przez API sieciowe.

    // 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);
    }

Aby zobaczyć pełny przykład, zajrzyj do aplikacji internetowej ASP.NET Core, która wywołuje interfejs API.

Opcja 3. Wywoływanie podrzędnego internetowego interfejsu API bez klasy pomocniczej

Zdecydowałeś się ręcznie uzyskać token przy użyciu usługi IAuthorizationHeaderProvider, a teraz musisz użyć tego tokenu. W takim przypadku poniższy kod kontynuuje przykładowy kod pokazany w aplikacji internetowej, która wywołuje internetowe interfejsy API: Uzyskiwanie tokenu dla aplikacji. Kod jest wywoływany w akcjach kontrolerów aplikacji internetowej.

Po uzyskaniu tokenu użyj go jako tokenu elementu nośnego, aby wywołać podrzędny interfejs API, w tym przypadku program 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();
}

Uwaga

Tę samą zasadę można użyć do wywoływania dowolnego internetowego interfejsu API.

Większość internetowych interfejsów API platformy Azure udostępnia zestaw SDK, który upraszcza wywoływanie interfejsu API, tak jak w przypadku programu Microsoft Graph.

ASP.NET

W przypadku korzystania z aplikacji Microsoft.Identity.Web dostępne są trzy opcje użycia do wywoływania interfejsu API:

• Opcja 1. Wywoływanie programu Microsoft Graph przy użyciu zestawu Microsoft Graph SDK
• Opcja 2. Wywoływanie podrzędnego internetowego interfejsu API za pomocą klasy pomocniczej
• Opcja 3. Wywoływanie podrzędnego internetowego interfejsu API bez klasy pomocniczej

Opcja 1. Wywoływanie programu Microsoft Graph za pomocą zestawu SDK z poziomu aplikacji OWIN

Chcesz wywołać program Microsoft Graph. W tym scenariuszu dodano AddMicrosoftGraph w Startup.cs, zgodnie z określoną w Konfiguracją kodu, i można wykorzystać GraphServiceClient w konstruktorze kontrolera lub strony do akcji, stosując metodę rozszerzenia GetGraphServiceClient() na kontrolerze. Poniższy przykład przedstawia zdjęcie zalogowanego użytkownika.

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

Aby zobaczyć pełny przykład, zajrzyj do aplikacji sieciowej OWIN ASP.NET, która wywołuje Microsoft Graph.

Opcja 2. Wywoływanie podrzędnego internetowego interfejsu API przy użyciu klasy pomocniczej z aplikacji OWIN

Chcesz wywołać internetowy interfejs API inny niż Microsoft Graph. W takim przypadku dodałeś AddDownstreamApi w Startup.cs, zgodnie z określeniami w konfiguracji kodu, i możesz uzyskać IDownstreamApi usługę w swoim kontrolerze, wywołując metodę rozszerzenia GetDownstreamApi na kontrolerze.

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

Dodatkowo, komponent CallApiForUserAsync posiada silnie typizowane generyczne przesłonięcia, które umożliwiają bezpośrednie pobieranie obiektu. Na przykład następująca metoda odbiera instancję Todo, która jest silnie typizowaną reprezentacją kodu JSON zwracanego przez API sieciowe.

    // 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);
    }

Opcja 3: Wywołanie podrzędnego interfejsu API sieciowego bez klasy pomocnika z aplikacji OWIN

Zdecydowałeś się uzyskać nagłówek autoryzacji za pomocą usługi IAuthorizationHeaderProvider, a teraz musisz użyć go w obiekcie HttpClient lub HttpRequest. W takim przypadku poniższy kod kontynuuje przykładowy kod pokazany w aplikacji internetowej, która wywołuje internetowe interfejsy API: Uzyskiwanie tokenu dla aplikacji. Kod jest wywoływany w akcjach kontrolerów aplikacji internetowej.

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();
}

Jawa

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

Po pomyślnym pobraniu tokenu kod używa pakietu axios do wykonywania zapytań dotyczących punktu końcowego interfejsu API i pobierania wyniku 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);
    }
}

Pyton

Po pomyślnym pobraniu tokenu kod używa pakietu requests do wykonywania zapytań dotyczących punktu końcowego interfejsu API i pobierania wyniku 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)

Następne kroki

• Dowiedz się więcej, tworząc aplikację webową ASP.NET Core, która pozwala logować się użytkownikom w poniższej wieloczęściowej serii samouczków

• Odkryj przykłady aplikacji internetowych na platformie tożsamości Microsoft