更新时间:2024-08-06 GMT+08:00

Android

操作场景

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

前提条件

获取SDK

请登录API网关控制台,参考《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
    • commons-logging-1.2.jar
    • joda-time-2.10.jar

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

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

  3. 创建request,输入AppKey和AppSecret,并指定域名、方法名、请求uri和body。

    1. 本示例以AK和SK保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量CLOUD_SDK_AK和CLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。
      1. 打开终端,输入以下命令打开环境变量配置文件。

        vi ~/.bashrc

      2. 设置环境变量,保存文件并退出编辑器。
        export CLOUD_SDK_AK="已获取AK值" 
        export CLOUD_SDK_SK="已获取SK值" 
      3. 输入以下命令使配置文件生效。

        source ~/.bashrc

    2. 创建request,填入已设置的环境变量,并指定域名、方法名、请求uri和body。
      Request request = new Request();
      try {
              request.setKey(System.getenv("CLOUD_SDK_AK"));   
              request.setSecret(System.getenv("CLOUD_SDK_SK"));
      	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。

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