Руководство по вызову защищенного веб-API в приложении Android

2025-04-16

применяется к: зеленый круг с символом белой флажки. арендаторы рабочей силы внешние клиенты (подробнее)

Это третье руководство в серии учебников, которое поможет вам вызвать защищенный веб-API с помощью внешнего идентификатора Microsoft Entra.

Изучив это руководство, вы:

Вызов защищенного веб-API

Учебник: Добавление возможности входа в приложение на Android с использованием платформы удостоверения Microsoft

Вызов защищенного веб-API

конфигурация арендатора персонала
конфигурации внешнего клиента

В приложении >src>main>java>com.example(ваше имя приложения). Создайте следующие фрагменты Android:
- MSGraphRequestWrapper

Откройте MSGraphRequestWrapper.java и замените код следующим фрагментом кода, чтобы вызвать API Microsoft Graph с помощью маркера, предоставленного MSAL:

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

Чтобы вызвать веб-API из приложения Android для доступа к внешним данным или службам, начните с создания объекта-компаньона в классе 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_BASE_URL, где разработчики задают URL-адрес веб-API и scopes, где разработчики добавляют соответствующие scopes веб-API.
Для обработки процесса доступа к веб-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
        }
    }
}
```
Код запускает корутину в главном диспетчере. Начинается очистка текстового журнала. Затем он проверяет, является ли базовый URL-адрес веб-API пустым; если это так, отображается сообщение типа 'toast' и возвращается. Затем он выполняет запрос GET к веб-API с помощью предоставленного токена доступа в фоновом потоке.

Получив ответ 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 }
    }
}
```
Код упрощает выполнение GET запросов к веб-API. Основным методом является performGetApiRequest(), который принимает базовый URL-адрес веб-API и маркер доступа в качестве параметров. В этом методе он создает полный URL-адрес, добавляя /api/todolist к базовому URL-адресу. Затем он создает HTTP-запрос с соответствующими заголовками, включая заголовок авторизации с маркером доступа.

Наконец, он выполняет запрос синхронно с помощью метода newCall() OkHttp и возвращает ответ. Объект ApiClient поддерживает экземпляр OkHttpClient для обработки HTTP-запросов. Чтобы использовать OkHttpClient, необходимо добавить зависимость implementation 'com.squareup.okhttp3:okhttp:4.9.0' в файл Android Gradle.

Убедитесь, что вы включили инструкции импорта. Android Studio должна включать автоматические инструкции импорта.

Тестирование приложения

Создайте и разверните приложение на тестовом устройстве или эмуляторе. Вы должны иметь возможность войти в систему и получить токены для Microsoft Entra ID.

сценарий : мобильное приложение, которое вызывает веб-API
Пример кода для сложных сценариев

Поделиться через

Руководство по вызову защищенного веб-API в приложении Android

Необходимые условия

Вызов защищенного веб-API

Тестирование приложения

Связанное содержимое

Обратная связь

Дополнительные ресурсы