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

Android

操作场景

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

准备环境

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

获取SDK

  1. 登录DataArts Studio控制台。
  2. 单击“数据服务”模块。
  3. 单击左侧菜单“专享版 > SDK”。
  4. 单击SDK使用引导区域里对应语言的SDK,下载SDK包到本地。
  5. 进行SDK包完整性校验。Windows操作系统下,打开本地命令提示符框,输入如下命令,在本地生成已下载SDK包的SHA256值,其中,“D:\java-sdk.zip”为SDK包的本地存放路径和SDK包名,请根据实际情况修改。

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

    命令执行结果示例,如下所示:

    SHA256 的 D:\java-sdk.zip 哈希:
    3a86f1ba249a00727db506e4075ec9630e6cf74f312bddf6c3901c9d0786f53e
    CertUtil: -hashfile 命令成功完成。
    3a86f1ba249a00727db506e4075ec9630e6cf74f312bddf6c3901c9d0786f53e

    对比所下载SDK包的SHA256值和下表中对应语言SDK包的SHA256值。如果一致,则表示下载过程不存在篡改和丢包。

    表1 SDK包及对应的SHA256值

    不同语言SDK包

    SHA256

    Java

    3a86f1ba249a00727db506e4075ec9630e6cf74f312bddf6c3901c9d0786f53e

    Go

    23734867eae2e7ef61427c64aa33aa89512571946f2f43a1a5fef5e801e3129f

    Python

    57636d8bacc459cab9dc08c70d01ccc42391ace60e6960c4e947566da1dc5d26

    C#

    e5a3b677f75c28ba3f1e16645d8171f7b6f34a42143f8a32a68bb18719b5e65d

    JavaScript

    442ac2fcb41d84525dc0139ec3f05d190e4e337cdbcdfdfc82a09d79d2ecd25e

    PHP

    2cc76bd2ecd48f00899d18b0f76d05ce2623065180f111c3f70ac14ddf0506f3

    C++

    2a54c3f2486d562ea6af1384eca40b301918bdc02f98bbf2c114f282dc059c00

    C

    4957556c108e0174d55b4b8d720f296967a9367ca54010792b1b3de039b87363

    Android

    0fdcc6fd93a68dce5c3e1b8e6370cc9340429cabfb0f268c3f9e5ea05238ae96

获取“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.9.9.jar

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

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

  3. 创建request,输入AppKey和AppSecret,并指定域名、方法名、请求uri和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 {
            // 认证用的ak和sk编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;
            // 本示例以ak和sk保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量SDK_AK和SDK_SK。
            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. 对请求进行签名,并为请求添加x-Authorization头,值与Authorization头相同。然后生成okhttp3.Request对象来访问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();