API接口使用说明

仅对授权的用户开放,如需使用该项服务,请与客服联系

获取接口权限

  • 向几维安全申请私有化平台private.kiwisec.com的使用账号
  • 在账号中心的账号信息页面,获取UserId和生成私有的SecurityKey

第一步:上传APK文件

接口地址

https://private.kiwisec.com/api/encrypt/android/upload

请求方式

POST

头部信息

字段名 变量名 必填 示例值 描述
用户ID X-KiwiSec-UserId 10001 用户唯一标识ID
用户KEY X-KiwiSec-UserKey 4B65A7D1606CC95E955ACBC6876E638B.1521794392700 接口调用的授权信息

用户KEY的生成方式为:拼接字符串UserId+"KIWI"+SecurityKey+"KIWI"+timestamp,并获取该字符串的MD5值,再拼接"."+timestamp字符串

UserId = 10001
SecurityKey = "7a4b78f3ed1f4cccd1de82bb3a2111g7"
timestamp = 1521794392700 //13位的时间戳
UserKey = MD5("10001KIWI7a4b78f3ed1f4cccd1de82bb3a2111g7KIWI1521794392700")+".1521794392700"
// UserKey = "4B65A7D1606CC95E955ACBC6876E638B.1521794392700"

请求参数

字段名 变量名 必填 示例值 描述
APK文件 apk_path fs.createReadStream('path/to/test.apk') 上传准备加密的APK文件
异常通知URL notify_result_url http://abc.com/getEncryptResultNotify 加密完成后以GET方式访问该地址,通知用户已完成加密

响应数据

字段名 变量名 必填 示例值 描述
返回码 return_code success success为提交成功
failed为提交失败
返回数据 data {
    "id": "5a6eb4b356fb0dfac18f6b66",
    "app_name":"Test APP",
    "app_version":"2.1.3",
    "app_md5": "bae7215e6e1fb82052ab913b110d4c01",
    "state":0,
    "state_txt":"队列中,等待加密"
}
上传成功后返回APK的基本数据
响应数据之data说明
字段名 变量名 必填 示例值 描述
记录ID id 5a6eb4b356fb0dfac18f6b66 几维安全内部记录唯一ID
应用名称 app_name Test APP 上传APK的应用名称
应用版本 app_version 2.1.3 上传APK的应用版本
应用MD5 app_md5 bae7215e6e1fb82052ab913b110d4c01 上传APK的MD5值
加密状态 state 0 加密状态说明:-2已加过密 -1加密失败 0队列中 1正在加密 2已完成加密
加密状态描述 state_txt 队列中 加密状态的文本描述

第二步:查询APK加密状态

接口地址

https://private.kiwisec.com/api/encrypt/android/queryState

请求方式

GET

头部信息

字段名 变量名 必填 示例值 描述
用户ID X-KiwiSec-UserId 10001 用户唯一标识ID
用户KEY X-KiwiSec-UserKey 4B65A7D1606CC95E955ACBC6876E638B.1521794392700 接口调用的授权信息,生成方式参考上传接口

请求参数

字段名 变量名 必填 示例值 描述
应用MD5 app_md5 bae7215e6e1fb82052ab913b110d4c01 应用APK包的MD5值

响应数据

字段名 变量名 必填 示例值 描述
返回码 return_code success success为提交成功 failed为提交失败
返回数据 data {
    "app_name":"Test APP",
    "app_version":"2.1.3",
    "app_md5": "bae7215e6e1fb82052ab913b110d4c01",
    "state":0,
    "state_txt":"队列中,等待加密"
}
上传成功后返回APK的基本数据,字段说明参考APK上传接口

第三步:下载APK加密包

接口地址

https://private.kiwisec.com/api/encrypt/android/download

请求方式

GET

头部信息

字段名 变量名 必填 示例值 描述
用户ID X-KiwiSec-UserId 10001 用户唯一标识ID
用户KEY X-KiwiSec-UserKey 4B65A7D1606CC95E955ACBC6876E638B.1521794392700 接口调用的授权信息,生成方式参考上传接口

请求参数

字段名 变量名 必填 示例值 描述
应用MD5 app_md5 bae7215e6e1fb82052ab913b110d4c01 应用APK包的MD5值

响应数据

接口授权校验成功,将返回APK加密包的二进制文件

如遇问题请联系我们的客服或技术支持,公司电话:028-83177117

results matching ""

    No results matching ""