Android SDK 使用手冊__使用SDK調用已開放API_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) {
        // 處理異常
    }
});