Aplikasi desktop yang memanggil API web: Memanggil API web

Setelah memiliki token, Anda dapat memanggil API web yang dilindungi. Anda biasanya memanggil API hilir dari pengontrol atau halaman aplikasi web Anda.

Memanggil API web yang dilindungi

Memanggil API web yang dilindungi tergantung pada bahasa dan kerangka kerja pilihan Anda:

Inti ASP.NET

Saat menggunakan Microsoft.Identity.Web, Anda memiliki tiga opsi penggunaan untuk memanggil API:

• Opsi 1: Panggil Microsoft Graph dengan Microsoft Graph SDK
• Opsi 2: Panggil API web hilir dengan kelas pembantu
• Opsi 3: Panggil API web hilir tanpa kelas pembantu

Opsi 1: Panggil Microsoft Graph dengan SDK

Dalam skenario ini, Anda memanggil Microsoft Graph dengan menambahkan paket NuGet Microsoft.Identity.Web.GraphServiceClient dan termasuk .AddMicrosoftGraph() dalam Startup.cs seperti yang ditentukan dalam konfigurasi Kode. Anda kemudian dapat langsung menyuntikkan ke GraphServiceClient pengontrol atau konstruktor halaman Anda untuk menggunakannya dalam tindakan. Contoh halaman Razor berikut ini menampilkan foto pengguna yang masuk.

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

Untuk sampel lengkap, lihat aplikasi web ASP.NET Core yang memanggil Microsoft Graph.

Opsi 2: Panggil API web hilir dengan kelas pembantu

Anda ingin memanggil API web selain Microsoft Graph. Dalam hal ini, Anda menambahkan AddDownstreamApi Startup.cs seperti yang ditentukan dalam konfigurasi Kode, dan Anda dapat langsung menyuntikkan IDownstreamApi layanan di pengontrol atau konstruktor halaman Anda dan menggunakannya dalam tindakan:

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

Metode CallWebApiForUserAsync ini juga memiliki pengambilalihan generik dengan jenis kuat yang memungkinkan Anda untuk langsung menerima objek. Misalnya, metode berikut menerima instans Todo, yang merupakan representasi JSON dengan jenis sangat kuat yang dikembalikan oleh 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);
    }

Untuk sampel lengkap, lihat aplikasi web ASP.NET Core yang memanggil API

Opsi 3: Panggil API web hilir tanpa kelas pembantu

Jika Anda telah memutuskan untuk mendapatkan token secara manual menggunakan layanan IAuthorizationHeaderProvider, Anda sekarang perlu menggunakan token. Dalam hal ini, kode berikut melanjutkan kode contoh yang ditampilkan di Aplikasi web yang memanggil API web: Memperoleh token untuk aplikasi. Kode dipanggil dalam tindakan pengontrol aplikasi web.

Setelah Anda mendapatkan token, gunakan sebagai token pembawa untuk memanggil API hilir, dalam hal ini 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();
}

Catatan

Anda dapat menggunakan prinsip yang sama untuk memanggil API web apa pun.

Sebagian besar API web Azure menyediakan SDK yang menyederhanakan pemanggilan API seperti halnya untuk Microsoft Graph.

ASP.NET

Saat menggunakan Microsoft.Identity.Web, Anda memiliki tiga opsi penggunaan untuk memanggil API:

• Opsi 1: Panggil Microsoft Graph dengan Microsoft Graph SDK
• Opsi 2: Panggil API web hilir dengan kelas pembantu
• Opsi 3: Panggil API web hilir tanpa kelas pembantu

Opsi 1: Memanggil Microsoft Graph dengan SDK dari aplikasi OWIN

Anda ingin memanggil Microsoft Graph. Dalam skenario ini, Anda telah menambahkan AddMicrosoftGraph Startup.cs seperti yang ditentukan dalam Konfigurasi kode, dan Anda bisa mendapatkan GraphServiceClient di pengontrol atau konstruktor halaman untuk digunakan dalam tindakan dengan menggunakan GetGraphServiceClient() metode ekstensi pada pengontrol. Contoh berikut menampilkan foto pengguna yang masuk.

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

Untuk sampel lengkap, lihat ASP.NET aplikasi Web OWIN yang memanggil Microsoft Graph

Opsi 2: Memanggil API web hilir dengan kelas pembantu dari aplikasi OWIN

Anda ingin memanggil API web selain Microsoft Graph. Dalam hal ini, Anda telah menambahkan AddDownstreamApi Startup.cs seperti yang ditentukan dalam Konfigurasi kode, dan Anda bisa mendapatkan IDownstreamApi layanan di pengontrol Anda dengan memanggil GetDownstreamApi metode ekstensi pada pengontrol:

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

Metode CallApiForUserAsync ini juga memiliki pengambilalihan generik dengan jenis kuat yang memungkinkan Anda untuk langsung menerima objek. Misalnya, metode berikut menerima instans Todo, yang merupakan representasi JSON dengan jenis sangat kuat yang dikembalikan oleh 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);
    }

Opsi 3: Memanggil API web hilir tanpa kelas pembantu dari aplikasi OWIN

Anda telah memutuskan untuk memperoleh header otorisasi menggunakan IAuthorizationHeaderProvider layanan , dan Anda sekarang perlu menggunakannya di HttpClient atau HttpRequest Anda. Dalam hal ini, kode berikut melanjutkan kode contoh yang ditampilkan di Aplikasi web yang memanggil API web: Memperoleh token untuk aplikasi. Kode dipanggil dalam tindakan pengontrol aplikasi 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

Setelah berhasil mengambil token, kode menggunakan paket axios untuk mengkueri titik akhir API dan mengambil hasil 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

Setelah berhasil mengambil token, kode menggunakan paket permintaan untuk mengkueri titik akhir API dan mengambil hasil 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)

Langkah berikutnya

• Pelajari selengkapnya dengan membangun aplikasi web ASP.NET Core yang memasukkan pengguna dalam seri tutorial multi-bagian berikut

• Menjelajahi sampel aplikasi web platform identitas Microsoft