# FinClip Open-API

# 获取小程序版本详情

GET

/api/v1/mop/runtime/app/:appId/:version

参数

字段 类型 描述
appId string 小程序Id
version int 版本号
timestamp int 秒级时间戳
uuid string 唯一标识
sign string 签名

Header

字段 类型 描述
mop-sdk-key string sdkKey

Request-Example

/api/v1/mop/runtime/app/5e040b0dd665060001dbfc01/1?timestamp=15836754&uuid=hiwhioejsgeo-hwoagie&sign=JAOGEHOEJIWOJEGNOWI
'headers': {
  'mop-sdk-key': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9'
}

Success Status

HTTP/1.1 200 OK
{
		"errcode": "OK",
		"error": "",
		"data": {
			"appId": "5e744b3299e8b1000144b1bc",
			"name": "q3",
			"appClass": "Others",
			"appType": "mini program",
			"created": 1584679730758,
			"customData": {
				"detailDescription": "aegeage",
				"sourceFile": [{
					"name": "app.zip",
					"uploadDate": 1584945571752,
					"url": "/api/v1/netdisk/download/5e7859a32951cd000138ba68"
				}],
			"versionDescription": "332323232"
			},
			"version": "2.0.0",
			"sequence": 0,
			"logo": "https://finchat-dev.finogeeks.club/api/v1/netdisk/download/5e7859bb2951cd000138ba6a"
		}
}

Error Status

HTTP/1.1 !=200 服务端异常
400 参数错误、非法签名

# 获取小程序详情

POST

/api/v1/mop/runtime/gray-release/app

Header

字段 类型 描述
mop-sdk-key string sdkKey
mop-encryption-type string sign加密方式:md5(md5加密)、sm(国密)
hashcode string 上次请求该小程序信息data的md5值,如果后端比对返回数据与此一致,就直接返回OK

Request-Example

{
    "appId":"60d0490189dd5e0001981b74", //小程序appId
    "confList":[  //灰度发布匹配参数,key: 唯一键,value: 对应的值
        {
            "key":"xUserId",
            "value":"13300000000"
        },
        {
            "key":"network",
            "value":"wifi"
        }
    ],
    "uuid":"3A37ABBF-801F-4031-B63B-5201B96395DA", //请求唯一id
    "timestamp":1636286176,//秒级时间戳
    "sign":"EA416ED0759D46A8DE58F63A59077499" //请求签名,计算方式为:生成字符串str= "appId={appId}&uuid={uuid}&timestamp={timestamp}&secret={平台上sdkKey对应的secret}",在根据header里面的加密方法对str进行hash之后转为大写
}

Success Status

正常返回 http code = 200
{
    "errcode": "OK",//返回errcode
    "error": "",//错误信息
    "data": {
        "appId": "60d0490189dd5e0001981b74",
        "name": "2",
        "sequence": 3,
        "developerId": "60d048e89e62670001ac7e5f",
        "developerStatus": 1,
        "groupId": "60d048a29e62670001ac7e5d",
        "groupName": "sdasd",
        "inGrayRelease": false,
        "created": 1624268065363,
        "createdBy": "132323",
        "customData": {
            "detailDescription": "",
            "sourceFile": [
                {
                    "fileMd5": "8b33e0b948c4a29cea2f5acc2b1585d9",
                    "name": "app.zip",
                    "url": "/api/v1/mop/netdisk/download/60d0519d1721330001270df9",
                    "basicPackVer": "",
                    "packages": null
                }
            ],
            "versionDescription": "1.1.0",
            "appRuntimeDomain": {
                "business": {
                    "domains": []
                },
                "service": {
                    "download": [],
                    "request": [],
                    "socket": [],
                    "upload": []
                },
                "whitelist": {
                    "domains": [
                        "https://info.gf.com.cn",
                        "https://zzkh.gf.com.cn",
                        "http://mmbiz.qpic.cn",
                        "https://open-q3.gf.com.cn:9443",
                        "https://finogeeks-tools.finogeeks.club",
                        "https://www.baidu.com",
                        "https://www.finogeeks.com"
                    ]
                },
                "blacklist": {
                    "domains": []
                }
            },
            "menuInfo": null,
            "apiInfo": null
        },
        "version": "1.1.0",
        "status": {
            "value": "Published",
            "reason": "",
            "lastUpdated": 1624268076431,
            "modifiedBy": "machine auto"
        },
        "coreDescription": "123",
        "logo": "https://www-cdn.finclip.com/images/ic-default.png",
        "isTemp": false,
        "needCrt": false
    },
    "hashcode": "9e89daeba830eac94f927e38345b9fa7"
}

Error Status

HTTP/1.1 !=200 服务端异常
400 参数错误、参数缺失
403 非法签名
500 服务内部错误

# 批量获取小程序详情

POST

/api/v1/mop/runtime/gray-release/batch/app

Header

字段 类型 描述
mop-sdk-key string sdkKey
mop-encryption-type string sign加密方式:md5(md5加密)、sm(国密)

Request-Example

{
    "reqList":[//批量请求小程序列表
        {
            "appId":"aigejogecalbhzchd", //小程序id
            "confList":[ //灰度发布配置信息
                {
                    "key":"userId",
                    "value":"128939439578"
                },
                {
                    "key":"city",
                    "value":"shenzhen"
                },
                {
                    "key":"age",
                    "value":20
                }
            ]
        },
        {
            "appId":"c1cjialcakcilsslig",
            "confList":[
                {
                    "key":"userId",
                    "value":"128939439578"
                },
                {
                    "key":"city",
                    "value":"shenzhen"
                },
                {
                    "key":"age",
                    "value":20
                }
            ]
        }
    ],
    "timestamp":1594349272,
    "uuid":"792hgesije-ahejigowie",
    "sign":"JOEWIFHIOWNEIWOEJGIWEG", //签名串,计算方式为:生成字符串str= "uuid={uuid}&timestamp={timestamp}&secret={平台上sdkKey对应的secret}",在根据header里面的加密方法对str进行hash之后转为大写
}
    "exp":{} //扩展信息
}

Success Status

正确返回 http code为200:
{
    "data": {
        "succDataList": [
            {
                "appId": "60a358e23a0e1c0001af2f40",
                "name": "autocmpaz",
                "sequence": 12,
                "developerId": "60a358d2bc6c3e0001d5f1aa",
                "developerStatus": 0,
                "groupId": "60a358d2bc6c3e0001d5f1ab",
                "groupName": "autodzljr",
                "inGrayRelease": false,
                "created": 1622535185911,
                "createdBy": "13461390857",
                "customData": {
                    "detailDescription": "",
                    "sourceFile": [
                        {
                            "fileMd5": "7a897d0c6d2678a0a1a8ecce87d7e31a",
                            "name": "app.zip",
                            "url": "/api/v1/mop/netdisk/download/60a35966f5300b0001a14e6c",
                            "basicPackVer": "",
                            "packages": null
                        }
                    ],
                    "versionDescription": "test",
                    "appRuntimeDomain": {
                        "business": {
                            "domains": []
                        },
                        "service": {
                            "download": [],
                            "request": [],
                            "socket": [],
                            "upload": []
                        },
                        "whitelist": {
                            "domains": [
                                "https://info.gf.com.cn",
                                "https://zzkh.gf.com.cn",
                                "http://mmbiz.qpic.cn",
                                "https://open-q3.gf.com.cn:9443",
                                "https://finogeeks-tools.finogeeks.club",
                                "https://www.baidu.com",
                                "https://www.finogeeks.com"
                            ]
                        },
                        "blacklist": {
                            "domains": []
                        }
                    },
                    "menuInfo": null,
                    "apiInfo": null
                },
                "version": "2.0.0",
                "status": {
                    "value": "Published",
                    "reason": "",
                    "lastUpdated": 1622535265160,
                    "modifiedBy": "13461390857"
                },
                "coreDescription": "test",
                "logo": "/api/v1/mop/netdisk/download/60a358e2f5300b0001a14e24",
                "isTemp": false,
                "needCrt": false
            }
        ],
        "failAppList": []
    },
    "errcode": "OK",
    "error": ""
}

Error Status

HTTP/1.1 !=200 服务端异常
400 参数错误 参数缺失
403 非法签名

# mop控制管理配置信息获取

GET

/api/v1/mop/runtime/control/config-info

参数

字段 类型 描述
timestamp int 秒级时间戳
uuid string 唯一标识
sign string 签名

Header

字段 类型 描述
mop-sdk-key string sdkKey
mop-encryption-type string sign加密方式:md5(md5加密)、sm(国密)

Request-Example

Success Status

正确返回 http code为200:
{
    "data": {
        "configCiphertext": "3HSnEVeGl1qQhj5jpS8crPKgbX6yHbyAnlHdGvOjbhFffQ2sXftMU06A7A+SOq2TaS7juMN9jn0DF2+uMYJtekJwO/zfIYKYGxeZdivxf3mRlcnMGfaLiOqqXQTZLeFV8FJ4Uq74b8uFZb9RW51ticpdVwnz8sAPnxDkZMqLEz0FplbJYqxv21QKjLYGn4zKAA=="
    },
    "errcode": "OK",
    "error": "成功"
}

Error Status

HTTP/1.1 !=200 服务端异常
400 参数错误 非法签名

# 获取最新基础库信息

GET

/api/v1/mop/runtime/latest-basic-pack

参数

字段 类型 描述
timestamp int 秒级时间戳
uuid string 唯一标识
sign string 签名
sdkVer string sdk版本号
sdkPlat string sdk平台

Header

字段 类型 描述
mop-sdk-key string sdkKey
mop-encryption-type string sign加密方式:md5(md5加密)、sm(国密)

Request-Example

Success Status

正确返回 http code为200:
{
    "data": {
        "downMd5": "99cc4cafd6554df02502099a119ce552",
        "downUrl": "/api/v1/mop/netdisk/download/61760486407ccb000136e15a",
        "sdkPlat": "android",
        "sdkVer": "2.14.8-alpha20210901v02",
        "sequence": 326,
        "version": "2.11.3-alpha20211025v01"
    },
    "errcode": "OK",
    "error": ""
}

Error Status

HTTP/1.1 !=200 服务端异常
400 参数错误
403 参数缺失

# 小程序搜索

GET

/api/v1/mop/runtime/search/app

参数

字段 类型 描述
timestamp int 秒级时间戳
uuid string 唯一标识
sign string 签名
searchText string 签名串,计算方式:首先按字母序排序获得字符串str=”searchText={searchText}&timestamp={timestamp}&uuid={uuid}&secret={header里面sdk对应的secret}”,再根据header里面的加密方法对str进行hash之后转为大写获得sign

Header

字段 类型 描述
mop-sdk-key string sdkKey
mop-encryption-type string sign加密方式:md5(md5加密)、sm(国密)

Request-Example

Success Status

正确返回 http code为200:
{
    "data": {},
    "errcode": "OK",
    "error": "成功"
}

Error Status

HTTP/1.1 !=200 服务端异常
400 参数错误 非法签名

# 根据微信二维码获取appId

GET

/api/v1/mop/runtime/qrcode/app

参数

字段 类型 描述
timestamp int 秒级时间戳
uuid string 唯一标识
sign string 签名
qrcode string 二维码信息

Header

字段 类型 描述
mop-sdk-key string sdkKey
mop-encryption-type string sign加密方式:md5(md5加密)、sm(国密)

Request-Example

Success Status

正确返回 http code为200:
{
    "data":{
        "list":[
            {
                "appId":"6180dc40a37a530001621281",
                "appName":"刀削面",
                "desc":"keke",
                "highLights":[
                    {
                        "key":"appName",
                        "value":"<em>刀</em><em>削</em><em>面</em>"
                    },
                    {
                        "key":"desc",
                        "value":"keke"
                    },
                    {
                        "key":"keys",
                        "value":""
                    },
                    {
                        "key":"pageSource",
                        "value":"以下将展示小程序官方组件能力组件样式仅供参考"
                    }
                ],
                "logo":"https://www-cdn.finclip.com/images/ic-default.png",
                "organName":"个人-13333333335",
                "pageUrl":"pages/component/index/index",
                "showText":"keke"
            },
            {
                "appId":"617f95973878a60001b71c4e",
                "appName":"牛肉面",
                "desc":"qwe",
                "highLights":[
                    {
                        "key":"appName",
                        "value":"牛肉<em>面</em>"
                    },
                    {
                        "key":"desc",
                        "value":"qwe"
                    },
                    {
                        "key":"keys",
                        "value":""
                    },
                    {
                        "key":"pageSource",
                        "value":"小程"
                    }
                ],
                "logo":"https://www-cdn.finclip.com/images/ic-default.png",
                "organName":"个人-13333333335",
                "pageUrl":"packageAPI/pages/Accelerometer/index",
                "showText":"qwe"
            }
        ],
        "total":2
    },
    "errcode":"OK",
    "error":"成功"
}

Error Status

HTTP/1.1 !=200 服务端异常
400 参数错误 非法签名

# 获取编译小程序信息

POST

/api/v1/mop/runtime/build/app-info

参数

字段 类型 描述
codeId string 唯一id
type string 类型 体验版:trial;临时版:temporary;审核版:review;线上版:release
apiServer string 域名
confList string 配置字段(预留)
key string 键
value Object 值(可任意值)
extList Array 扩展字段(里面放userId)
timestamp string 秒级时间戳
uuid string 唯一标识
sign string 签名

Header

字段 类型 描述
mop-sdk-key string sdkKey
hashcode string 返回信息的hashcode
mop-qrcode-sign string 加密串

Request-Example

{
  "codeId": "唯一id",
  "type": "小程序类型",
  "apiServer": "域名",
  "confList": [
    {
      "key": "key",
      "value": "ccc"
    }
  ],
  "extList": [
    {
      "key": "key",
      "value": "ccc"
    },
    {
      "key": "userId",
      "value": "11111"
    }
  ],
  "uuid": "3A37ABBF-801F-4031-B63B-5201B96395DA",//uuid
  "timestamp": 1623136201,//秒级时间戳
  "sign": "EA416ED0759D46A8DE58F63A59077499" //签名
}

Success Status

正确返回 http code为200:
{
   "errcode": "OK",
   "error": "",
   "data": {
       "infoId": "60a358e23a0e1c0001af2f40",//唯一Id
       "coreDescription": "test",//小程序简介
       "created": 1622535185911,//该信息创建时间
       "createdBy": "13461390857",//该版本的创建人
       "customData": {
           "appRuntimeDomain": { //域名信息
               "business": {
                   "domains": []
               },
               "service": {
                   "download": [],
                   "request": [],
                   "socket": [],
                   "upload": []
               },
               "whitelist": {
                   "domains": []
               },
               "blacklist": {
                   "domains": []
               }
           },
           "sourceFile": [
               {
                   "fileMd5": "7a897d0c6d2678a0a1a8ecce87d7e31a",
                   "name": "app.zip",
                   "uploadDate": 1621317991147,
                   "url": "/api/v1/mop/netdisk/download/60a35966f5300b0001a14e6c",
                   "sourceFileUrl": "",
                   "basicPackVer": ""
               }
           ],
           "versionDescription": "test",//版本描述
           "detailDescription": "",//详细描述
           "menuInfo": {
               "total": 0,
               "list": []
           },
           "apiInfo": null
       },
       "groupId": "60a358d2bc6c3e0001d5f1ab",//企业Id
       "groupName": "autodzljr",//企业名称
       "logo": "/api/v1/mop/netdisk/download/60a358e2f5300b0001a14e24",//小程序logo
       "name": "autocmpaz",//小程序名称
       "version": "2.0.0",//版本号码
       "needCrt": false //是否需要crt
   }
    "hashcode": "de3cca0ccaa027e7b7d887681ed6ed17"   // 优化项,去除优化就不生效了
}

Error Status

HTTP/1.1 !=200 服务端异常
400 参数错误  参数缺失
403 二维码已失效 非法签名

备注

sign的生成方式如下:
对所有字段进行字母序排序,并用=号连接字段名称和其值,对于请求中的confList,extList字段,需要对数组进行排序,排序的依据是item里面的key对应的值,排序之后取其json marshal之后的字符串,字段与字段之间则用&符号相连。最后再用&符号拼接上:secret=a(a即sdkKey对应的secret),得到字符串 s,对s进行进行md5加密之后再转为大写即为sign,示例:
{
“a”:”111”,
“b”:”222”,
“c”:[
{“key”:”k1”,”value”:”v1”},
{“key”:”k2”,”value”:2}
],
“d”:{
“name”:”wangkang”
}
“timestamp”:1623136200000,
“uuid”:”aaa-bbb-ccc-dddd”
}
则最终获得的加密串s=”a=111&b=222&c=[{“key”:”k1”,”value”:”v1”},{“key”:”k2”,”value”:2}]&d={“name”:”wangkang”}&timestamp=1623136200000&uuid=aaa-bbb-ccc-dddd&secret=ssssssss”

# 获取管理小程序列表

POST

/api/v1/mop/runtime/manage/app-list

Header

字段 类型 描述
mop-sdk-key string sdkKey

Request-Example

{
    "appId":"小程序id",
    "extList":[//扩展字段
        {
            "key":"userId",
            "value":"222"
        }
    ],
    "uuid":"3A37ABBF-801F-4031-B63B-5201B96395DA",
    "timestamp":1623136201,
    "sign":"EA416ED0759D46A8DE58F63A59077499"//签名见备注
}

Success Status

正确返回 http code为200:
{
    "data":{
        "appList":[
            {
                "appId":"小程序Id",
                "logo":"小程序logo",
                "name":"小程序名称"
            },
            {
                "appId":"小程序Id",
                "logo":"小程序logo",
                "name":"小程序名称"
            }
        ],
        "total":2
    },
    "errcode":"OK",
    "error":""
}

Error Status

HTTP/1.1 !=200 服务端异常
400 参数缺失 参数错误 该小程序无权限
403 非法签名

# 获取小程序线上、开发、体验版本

POST

/api/v1/mop/runtime/manage/ver-list

参数

字段 类型 描述
appId string 小程序Id
extList Array 扩展list
timestamp string 秒级时间戳
uuid string 唯一标识
sign string 签名

Request-Example

Success Status

正确返回 http code为200:
{
    "data":{
        "releaseInfo":{
            "appId":"小程序Id",
            "version:"版本号",
            "versionDescription":"版本描述"
        },
        "trialInfo":{
            "codeId":"codeId",
            "version":"版本号",
            "versionDescription":"版本描述"
        },
        "devInfo":{
            "list":[
                {
                    "codeId":"小程序Id",
                    "version:"版本号",
                    "versionDescription":"版本描述" 
                }
            ],
            "total":1
        }
    },
    "errcode":"OK",
    "error":""
}

Error Status

HTTP/1.1 !=200 服务端异常
400 参数缺失 参数错误
403 非法签名

# 获取二维码信息

GET

/api/v1/mop/runtime/applet/:infoid

参数

字段 类型 描述
infoid string 扫码获取到的二维码id
timestamp int 秒级时间戳
uuid string 唯一标识
sign string 签名

Header

字段 类型 描述
mop-sdk-key string sdkKey
mop-encryption-type string sign加密方式:md5(md5加密)、sm(国密)

Request-Example

Success Status

非 FinClip App 扫码,返回301,重定向
 FinClip App 扫码
正常的话http code = 200
{
    "data": {
        "url": "https://finchat-mop-b.finogeeks.club/mop/scattered-page/#/sdktip?info=Hz3AmiApzeQT/s9HqFjrZClkUDbqpMGQuphFns+UbwBHAiw6KL+mY7IOPC9V+mdAwjciYPqRb4pIjZhiFiAPWWgpzNGAS1kYsyJE8RoZV2FmrYTkullu5Apy4JkHiw69/eaDd2R9TZCVYj92cpDGM4Apx/pkSgazuS/5Z9T6QeSnwm7NqN55I7SLaI+GFsUlmuNFin05NFBj6+sfmp57hj+u1AVeyqBnYQfyu7euVJCjjpGM+85dh/1ALrzhin1dSS18axGkluLh/68OgTBGGRjdIWEd00y7GKZULkwyTH5flAfSdVlKs04AhLEcx/XLwiyuzlewJ+dfno4nMClPKJsBo6qlJhK8muceeMzaA00nX6IWlKyIJCuOGKgAYU2qA5fB7qwOl6VGYRfB9K1aSQ==&type=scanOpen&codeType=temporary"
    },
    "errcode": "OK",
    "error": ""
}

Error Status

HTTP/1.1 !=200 服务端异常
400 参数错误
403 非法签名
© FinClip with ❤ , Since 2017