文档首页> API网关 APIG> 开发指南（巴黎区域）> 使用APP认证调用API> Android
更新时间：2022-02-21 GMT+08:00
查看PDF

Android

操作场景

使用Android语言调用APP认证的API时，您需要先获取SDK，然后新建工程，最后参考API调用示例调用API。

准备环境

  • 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息，具体参见认证前准备。
  • 获取并安装Android Studio，如果未安装，请至Android Studio官方网站下载。

获取SDK

请登录API网关控制台，参考《用户指南》的“SDK”章节，进入SDK页面并下载SDK。

获取“ApiGateway-android-sdk.zip”压缩包，解压后目录结构如下：

名称

说明

app\

安卓工程代码

gradle\

gradle相关文件

build.gradle

gradle配置文件

gradle.properties

settings.gradle

gradlew

gradle wrapper执行脚本

gradlew.bat

打开工程

  1. 打开Android Studio，选择“File > Open”。

    在弹出的对话框中选择解压后的SDK路径。

  2. 打开工程后，目录结构如下。

    图1 工程目录结构

调用API示例

  1. 在Android工程中的“app/libs”目录下，加入SDK所需jar包。其中jar包必须包括：

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

  2. 在“build.gradle”文件中加入okhttp库的依赖。

    在“build.gradle”文件中的“dependencies”下加入“implementation 'com.squareup.okhttp3:okhttp:3.14.2'”。 
    1
2
3
4
5
    		 
    dependencies {    
    ...
    ...
    implementation 'com.squareup.okhttp3:okhttp:3.14.3'
}

  3. 创建request，输入AppKey和AppSecret，并指定域名、方法名、请求uri和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. 对请求进行签名，生成okhttp3.Request对象来访问API。

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