Help Center/ API Gateway/ Developer Guide (Paris Region)/ Calling APIs Through App Authentication/ Android
Updated on 2022-02-21 GMT+08:00
View PDF
Share

Android

Scenarios

To use Android to call an API through App authentication, obtain the Android SDK, create a new project, and then call the API by referring to the API calling example.

Preparing the Environment

  • You have obtained the domain name, request URL, and request method of the API to be called, and the AppKey and AppSecret of the app for calling the API. For more information, see Preparation.
  • You have installed Android Studio. If not, download Android Studio from the official Android Studio website and install it.

Obtaining the SDK

Log in to the API Gateway console, and download the SDK on the SDKs page by referring to section "SDKs" in the User Guide.

The following table shows the files decompressed from the package.

Name

Description

app\

Android project code

gradle\

Gradle files

build.gradle

Gradle configuration files

gradle.properties

settings.gradle

gradlew

Gradle Wrapper scripts

gradlew.bat

Opening a Project

  1. Start the Android Studio and choose File > Open.

    Select the directory where the SDK is decompressed.

  2. View the directory structure of the project shown in the following figure.

    Figure 1 Project directory structure

API Calling Example

  1. Add required JAR files to the app/libs directory of the Android project. The following JAR files must be included:

    • java-sdk-core-x.x.x.jar
    • joda-time-2.10.jar

  2. Add dependencies of the okhttp library to the build.gradle file.

    Add implementation 'com.squareup.okhttp3:okhttp:3.14.2' in the dependencies field of the build.gradle file. 
    1
2
3
4
5
    		 
    dependencies {    
    ...
    ...
    implementation 'com.squareup.okhttp3:okhttp:3.14.3'
}

  3. Create a request, enter an AppKey and AppSecret, and specify the domain name, method, request URI, and body. 

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    		 
    Request request = new Request();
try {
	request.setKey("4f5f626b-073f-402f-a1e0-e52171c6100c");
	request.setSecrect("******");
	request.setMethod("POST");
	request.setUrl("https://c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com/app1");
	request.addQueryStringParam("name", "value");
	request.addHeader("Content-Type", "text/plain");
	request.setBody("demo");
} catch (Exception e) {
	e.printStackTrace();
	return;
}

  4. Sign the request to generate an okhttp3.Request object for API access. 

    1
2
3
    		 
    okhttp3.Request signedRequest = Client.signOkhttp(request);
OkHttpClient client = new OkHttpClient.Builder().build();
Response response = client.newCall(signedRequest).execute();