チュートリアル: Android アプリで保護された Web API を呼び出す

2025-04-16

適用対象: 白いチェックマーク記号が付いた緑の円。従業員テナント外部テナント (詳細はこちら)

これは、Microsoft Entra External ID を使用して保護された Web API を呼び出す方法について説明するチュートリアルシリーズの 3 番目のチュートリアルです。

このチュートリアルでは、次の操作を行います。

保護された Web API を呼び出す

前提条件

Workforce テナントの構成
外部テナントの構成

チュートリアル: Microsoft ID プラットフォームを使用して Android アプリにサインインを追加する

app>src>main>java>com.example(アプリ名) 内で。次の Android フラグメントを作成します。
- MSGraphRequestWrapper (英語)

MSGraphRequestWrapper.java を開き、コードを次のコードスニペットに置き換えて、MSAL によって提供されたトークンを使用して Microsoft Graph API を呼び出します。

 package com.azuresamples.msalandroidapp;

 import android.content.Context;
 import android.util.Log;

 import androidx.annotation.NonNull;

 import com.android.volley.DefaultRetryPolicy;
 import com.android.volley.Request;
 import com.android.volley.RequestQueue;
 import com.android.volley.Response;
 import com.android.volley.toolbox.JsonObjectRequest;
 import com.android.volley.toolbox.Volley;

 import org.json.JSONObject;

 import java.util.HashMap;
 import java.util.Map;

 public class MSGraphRequestWrapper {
     private static final String TAG = MSGraphRequestWrapper.class.getSimpleName();

     // See: https://docs.microsoft.com/en-us/graph/deployments#microsoft-graph-and-graph-explorer-service-root-endpoints
     public static final String MS_GRAPH_ROOT_ENDPOINT = "https://graph.microsoft.com/";

     /**
      * Use Volley to make an HTTP request with
      * 1) a given MSGraph resource URL
      * 2) an access token
      * to obtain MSGraph data.
      **/
     public static void callGraphAPIUsingVolley(@NonNull final Context context,
                                                @NonNull final String graphResourceUrl,
                                                @NonNull final String accessToken,
                                                @NonNull final Response.Listener<JSONObject> responseListener,
                                                @NonNull final Response.ErrorListener errorListener) {
         Log.d(TAG, "Starting volley request to graph");

         /* Make sure we have a token to send to graph */
         if (accessToken == null || accessToken.length() == 0) {
             return;
         }

         RequestQueue queue = Volley.newRequestQueue(context);
         JSONObject parameters = new JSONObject();

         try {
             parameters.put("key", "value");
         } catch (Exception e) {
             Log.d(TAG, "Failed to put parameters: " + e.toString());
         }

         JsonObjectRequest request = new JsonObjectRequest(Request.Method.GET, graphResourceUrl,
                 parameters, responseListener, errorListener) {
             @Override
             public Map<String, String> getHeaders() {
                 Map<String, String> headers = new HashMap<>();
                 headers.put("Authorization", "Bearer " + accessToken);
                 return headers;
             }
         };

         Log.d(TAG, "Adding HTTP GET to Queue, Request: " + request.toString());

         request.setRetryPolicy(new DefaultRetryPolicy(
                 3000,
                 DefaultRetryPolicy.DEFAULT_MAX_RETRIES,
                 DefaultRetryPolicy.DEFAULT_BACKOFF_MULT));
         queue.add(request);
     }
 }

Android アプリケーションから Web API を呼び出して外部データまたはサービスにアクセスするには、まず、 MainActivity クラスにコンパニオンオブジェクトを作成します。コンパニオンオブジェクトには、次のコードを含める必要があります。
```
companion object {
    private const val WEB_API_BASE_URL = "" // Developers should set the respective URL of their web API here
    private const val scopes = "" // Developers should append the respective scopes of their web API.
}
```
コンパニオンオブジェクトは、開発者が Web API の URL を設定する WEB_API_BASE_URL と、開発者が Web API のそれぞれのscopesを追加するscopesという 2 つのプライベート定数を定義します。
Web API にアクセスするプロセスを処理するには、次のコードを使用します。
```
private fun accessWebApi() {
    CoroutineScope(Dispatchers.Main).launch {
        binding.txtLog.text = ""
        try {
            if (WEB_API_BASE_URL.isBlank()) {
                Toast.makeText(this@MainActivity, getString(R.string.message_web_base_url), Toast.LENGTH_LONG).show()
                return@launch
            }
            val apiResponse = withContext(Dispatchers.IO) {
                ApiClient.performGetApiRequest(WEB_API_BASE_URL, accessToken)
            }
            binding.txtLog.text = getString(R.string.log_web_api_response)  + apiResponse.toString()
        } catch (exception: Exception) {
            Log.d(TAG, "Exception while accessing web API: $exception")

            binding.txtLog.text = getString(R.string.exception_web_api) + exception
        }
    }
}
```
このコードは、メインディスパッチャーでコルーチンを起動します。まず、テキストログをクリアします。次に、Web API のベース URL が空白かどうかを確認します。その場合は、トーストメッセージが表示され、返されます。次に、バックグラウンドスレッドで指定されたアクセストークンを使用して、Web API に対する GET 要求を実行します。

API 応答を受信すると、応答コンテンツでテキストログが更新されます。このプロセス中に例外が発生した場合は、例外がログに記録され、対応するエラーメッセージでテキストログが更新されます。

コールバックを指定するコードでは、 performGetApiRequest()という関数を使用します。関数には次のコードが必要です。
```
object ApiClient {
    private val client = OkHttpClient()

    fun performGetApiRequest(WEB_API_BASE_URL: String, accessToken: String?): Response {
        val fullUrl = "$WEB_API_BASE_URL/api/todolist"

        val requestBuilder = Request.Builder()
                .url(fullUrl)
                .addHeader("Authorization", "Bearer $accessToken")
                .get()

        val request = requestBuilder.build()

        client.newCall(request).execute().use { response -> return response }
    }
}
```
このコードにより、Web API への GET 要求の作成が容易になります。 main メソッドは performGetApiRequest()であり、Web API のベース URL とアクセストークンをパラメーターとして受け取ります。このメソッド内では、ベース URL に /api/todolist を追加して完全な URL を構築します。次に、アクセストークンを含む承認ヘッダーを含む、適切なヘッダーを含む HTTP 要求を構築します。

最後に、OkHttp の newCall() メソッドを使用して同期的に要求を実行し、応答を返します。 ApiClient オブジェクトは、HTTP 要求を処理するOkHttpClientのインスタンスを保持します。 OkHttpClientを使用するには、依存関係implementation 'com.squareup.okhttp3:okhttp:4.9.0'を Android Gradle ファイルに追加する必要があります。

必ず import ステートメントを含めます。 Android Studio では、自動的に import ステートメントが含められます。

アプリをテストする

アプリをビルドし、テストデバイスまたはエミュレーターに展開します。サインインして Microsoft Entra ID のトークンを取得できる必要があります。

次の方法で共有

チュートリアル: Android アプリで保護された Web API を呼び出す

前提条件

保護された Web API を呼び出す

アプリをテストする

関連コンテンツ

フィードバック

その他のリソース