Android SDK 使用指南__SDK_API 网关-阿里云

3.1 权限声明

在AndroidManifest.xml中添加如下内容：

<uses-permission android:name="android.permission.INTERNET" />

3.2 AppKey配置

3.2.1 非安全方式配置AppKey及AppSecret

强烈建议只在开发测试阶段使用非安全的方式配置AppKey及AppSecret。强烈建议在控制台中为移动应用创建新的应用，不和其他端上应用共用AppKey。

从控制台中获取到应用的AppKey及AppSecret，并在AndroidManifest.xml中添加如下内容：

<application>
    <meta-data android:name="com.alibaba.apigateway.appKey" android:value="appKey" />
    <meta-data android:name="com.alibaba.apigateway.appSecret" android:value="appSecret" />
</application>

3.2.2 较安全地存储AppKey及AppSecret

请使用阿里云提供的移动安全产品，点击查看产品介绍。

通过使用安全存储功能将AppKey及AppSecret较安全地存储在移动应用端，点击查看使用文档。请按照上述使用文档联系移动安全产品将API网关所需要AppKey和AppSecret存放在安全图片中。

用户只需要按照上述文档依赖移动安全SDK并正确放置安全图片，API网关会自动从安全图片中获取所需数据。

3.3 SDK初始化

在应用初始化的时候添加SDK初始化代码。以下以MainActivity为例：

package ...;
import ...;
public class MainActivity extends AppCompatActivity  {
    @Override
    protected void onCreate() {
        super.onCreate();
        // 初始化API网关SDK
        initGatewaySdk();
    }
    private void initGatewaySdk() {
        // 初始化API网关
        ApiGatewayClient.init(getApplicationContext(), false);
    }
}

注意，如果SDK依赖的AppKey及AppSecret已通过移动安全服务进行安全存储，请使用以下初始化代码：

ApiGatewayClient.init(getApplicationContext(), true);

// 获取服务
RpcService rpcService = ApiGatewayClient.getRpcService();
ApiRequest apiRequest = new ApiRequest();
// 设置请求地址、Path及Method
apiRequest.setAddress("https://sms.market.alicloudapi.com");
apiRequest.setPath("/singleSendSms");
apiRequest.setMethod(HttpMethod.GET);
// 按照文档设置Query参数，支持设置Header参数、Form形式Body及二进制形式Body
apiRequest.addQuery("ParamString", "demo");
apiRequest.addQuery("RecNum", "demo");
apiRequest.addQuery("SignName", "demo");
apiRequest.addQuery("TemplateCode", "demo");
// 设置超时时间及其他
apiRequest.setTimeout(3000);
try {
    ApiResponse apiResponse = rpcService.call(apiRequest);
    // 处理apiResponse，以下为常用方法
    // RequestId
    // apiResponse.getRequestId();
    // Code
    // apiResponse.getCode();
    // ErrorMessage
    // apiResponse.getErrorMessage();
    // Response Content
    // apiResponse.getStringBody();
    // Response Headers
    // apiResponse.getHeaders();
} catch (ApiInvokeException e) {
    // 处理异常
}

// 获取服务
RpcService rpcService = ApiGatewayClient.getRpcService();
final ApiRequest apiRequest = new ApiRequest();
// 设置请求地址、Path及Method
apiRequest.setAddress("https://dm-51.data.aliyun.com");
apiRequest.setPath("/rest/160601/ocr/ocr_idcard.json");
apiRequest.setMethod(HttpMethod.POST);
// 按照文档设置二进制形式Body，支持设置Query参数、Header参数、Form形式Body
apiRequest.setStringBody("JSON格式参数");
// 设置支持自签等形式的证书，如果服务端证书合法请勿设置该值，仅在开发测试或者非常规场景下设置。
apiRequest.setTrustServerCertificate(true);
// 设置超时
apiRequest.setTimeout(10000);
rpcService.call(apiRequest, new ApiResponseCallback() {
    @Override
    public void onSuccess(ApiResponse apiResponse) {
        // 处理apiResponse
    }
    @Override
    public void onException(ApiInvokeException e) {
        // 处理异常
    }
});