Android

Scenarios

To use Android to call an API through App authentication, obtain the Android SDK, create a 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

1. Log in to the DataArts Studio console.
2. Click DataArts DataService.
3. In the navigation pane, choose DataArts DataService Exclusive > SDKs.
4. On the SDKs page, download the SDK package.
5. Verify integrity of the SDK package. In Windows, open the CLI and run the following command to generate the SHA-256 value of the downloaded SDK package. In the command, D:\java-sdk.zip is an example local path and name of the SDK package. Replace it with the actual value.

   certutil -hashfile D:\java-sdk.zip SHA256

   The following is an example command output:

   SHA-256 hash value of D:\java-sdk.zip
   becff4310645f3734344897ffdcabb1853d4b7d93b59a6ea187c5ae40543b36b
   CertUtil: -hashfile command executed.
   becff4310645f3734344897ffdcabb1853d4b7d93b59a6ea187c5ae40543b36b

   Compare the SHA-256 value of the downloaded SDK package with that provided in the following table. If they are the same, no tampering or packet loss occurred during the package download.

   Language	SHA-256 Value of the SDK Package
   Java	becff4310645f3734344897ffdcabb1853d4b7d93b59a6ea187c5ae40543b36b
   Go	bcf8cf19a21226e247195f2e584c8414da39b8d05840fb02948e1375d9bbb7e6
   Python	c3da3b5814f828d6217963e856563d558d938b3da28993a8a13c8a7ebff5b95d
   C#	a880b47e63ab35bfe216592e340a8135b866aef8f756ef7738fff3287885f33a
   JavaScript	53261387f5fcf46e61d0bef5e890bea97952717f327c356412c3128389e848d6
   PHP	29bf711144e77a4adaea1257cd6dedd2220e57b729a8fd000c51e68ccb42ad4b
   C++	f604c6386c62cccb7c358007778037d5b15480987dc2860eef1b7bad37cb21d7
   C	7086012c2d0569d5938830926b19fbea0d46682a983e04e52924978e8720c2f8
   Android	89962b186707828b06b0c9f50c010b2f4cefd6a8e7ca9bdefb616bbbf6e739c8

Obtain the ApiGateway-android-sdk.zip package. The following table shows the files decompressed from the package.

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 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
   • commons-logging-1.2.jar
   • joda-time-2.9.9.jar

2. Add dependencies of the okhttp library to the build.gradle file.
   Add implementation 'com.squareup.okhttp3:okhttp:3.11.0' in the dependencies field of the build.gradle file.

   1 2 3 4 5

   dependencies { ... ... implementation 'com.squareup.okhttp3:okhttp:3.11.0' }

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 14 15 16 17 18 19 20

   Request request = new Request(); try { // Coded or plaintext AK and SK in code pose significant security risks. You are advised to encrypt and store them in configuration files or environment variables and decrypt them when needed. // In this example, the AK and SK stored in the environment variables are used for identity authentication. Before running this example, configure environment variables SDK_AK and SDK_SK in the local environment. String ak = System.getenv("SDK_AK"); String sk = System.getenv("SDK_SK"); request.setKey(ak); request.setSecret(sk); request.setMethod("POST"); request.setUrl("https://{apig-endpoint}/app1"); request.addQueryStringParam("name", "value"); request.addHeader("Content-Type", "text/plain"); request.addHeader("name", "value"); request.setBody("demo"); } catch (Exception e) { e.printStackTrace(); return; }

4. Sign the request and add the x-Authorization header to the request. The value of the x-Authorization header is the same as that of the Authorization header. The okhttp3.Request object is then generated to access the API.

   1 2 3 4 5

   okhttp3.Request signedRequest = Client.signOkhttp(request); String authorization = signedRequest.header("Authorization"); signedRequest = signedRequest.newBuilder().addHeader("x-Authorization",authorization).build(); OkHttpClient client = new OkHttpClient.Builder().build(); Response response = client.newCall(signedRequest).execute();