# FinClip Open-API

# Get Mini-Program Version Details

GET

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

Parameters

Field Type Description
appId string Mini-Program Id
version int Version Number
timestamp int Seconds Timestamp
uuid string Unique Identifier
sign string Signature

Header

Field Type Description
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': 'eyJhbGciOiJIUzI1NiIsınR5cCI6IkpXVCJ9'
}

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 Server Exception
400 Parameter Error, Illegal Signature

# Get Mini-Program Details

POST

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

Header

Field confidence Type Description
mop-sdk-key string
mop-encryption-type string
hashcode string

Request-Example

{
    "appId":"60d0490189dd5e0001981b74", //Mini-Program appId
    "confList":[  //Gray release matching parameters, key: unique key, value: corresponding value
        {
            "key":"xUserId",
            "value":"13300000000"
        },
        {
            "key":"network",
            "value":"wifi"
        }
    ],
    "uuid":"3A37ABBF-801F-4031-B63B-5201B96395DA", //Request unique id
    "timestamp":1636286176,//Seconds Timestamp
    "sign":"EA416ED0759D46A8DE58F63A59077499" //Request signature, calculation method: generate string str= "appId={appId}&uuid={uuid}&timestamp={timestamp}&secret={secret corresponding to the sdkKey on the platform}", then hash str according to the encryption method in the header and convert to uppercase
}

Success Status

Normal return http code = 200
{
    "errcode": "OK",//Return errcode
    "error": "",//Error message
    "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.",
            "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 Server Exception
400 Parameter Error, Parameter Missing
403 Illegal Signature
500 Internal Server Error

# Batch Get Mini-Program Details

POST

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

Header

Field Type Description
mop-sdk-key string sdkKey
mop-encryption-type string Signature Encryption Method: md5 (MD5 encryption), sm (SM encryption)

Request-Example

{
    "reqList":[//Batch request Mini-Program list
        {
            "appId":"aigejogecalbhzchd", //Mini-Program id
            "confList":[ //Gray release configuration information
                {
                    "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", //Signature string, calculation method: generate string str= "uuid={uuid}&timestamp={timestamp}&secret={secret corresponding to the sdkKey on the platform}", then hash str according to the encryption method in the header and convert to uppercase
}
    "exp":{} //Extension information
}

Success Status

Correct return http code is 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 Server Exception
400 Parameter Error, Parameter Missing
403 Illegal Signature

# Get MOP Control Management Configuration Information

GET

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

Parameters

Field Type Description
timestamp int Seconds Timestamp
uuid string Unique Identifier
sign string Signature

Header

Field Type Description
mop-sdk-key string sdkKey
mop-encryption-type string Signature Encryption Method: md5 (MD5 encryption), sm (SM encryption)

Request-Example

Success Status

Correct return http code is 200:
{
    "data": {
        "configCiphertext": "3HSnEVeGl1qQhj5jpS8crPKgbX6yHbyAnlHdGvOjbhFffQ2sXftMU06A7A+SOq2TaS7juMN9jn0DF2+uMYJtekJwO/zfIYKYGxeZdivxf3mRlcnMGfaLiOqqXQTZLeFV8FJ4Uq74b8uFZb9RW51ticpdVwnz8sAPnxDkZMqLEz0FplbJYqxv21QKjLYGn4zKAA=="
    },
    "errcode": "OK",
    "error": "Success"
}

Error Status

HTTP/1.1 !=200 Server Exception
400 Parameter Error, Illegal Signature

# Get Latest Base Library Information

GET

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

Parameters

Field Type Description
timestamp int Seconds Timestamp
uuid string Unique Identifier
sign string Signature
sdkVer string SDK Version Number
sdkPlat string SDK Platform

Header

Field Type Description
mop-sdk-key string sdkKey
mop-encryption-type string Signature Encryption Method: md5 (MD5 encryption), sm (SM encryption)

Request-Example

Success Status

Correct return http code is 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 Server Exception
400 Parameter Error
403 Parameter Missing

GET

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

Parameters

Field Type Description
timestamp int Seconds Timestamp
uuid string Unique Identifier
sign string Signature
searchText string Signature string, calculation method: First sort alphabetically to get string str=”searchText={searchText}&timestamp={timestamp}&uuid={uuid}&secret={secret corresponding to the SDK in the header}”, then hash str according to the encryption method in the header and convert to uppercase to get sign

Header

Field Type Description
mop-sdk-key string sdkKey
mop-encryption-type string Signature Encryption Method: md5 (MD5 encryption), sm (SM encryption)

Request-Example

Success Status

Correct return http code is 200:
{
    "data": {},
    "errcode": "OK",
    "error": "Success"
}

Error Status

HTTP/1.1 !=200 Server Exception
400 Parameter Error, Illegal Signature

# Get appId Based on WeChat QR Code

GET

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

Parameters

Field Type Description
timestamp int Seconds Timestamp
uuid string Unique Identifier
sign string Signature
qrcode string QR Code Information

Header

Field Type Description
mop-sdk-key string sdkKey
mop-encryption-type string Signature Encryption Method: md5 (MD5 encryption), sm (SM encryption)

Request-Example

Success Status

Correct return http code is 200:
{
    "data":{
        "list":[
            {
                "appId":"6180dc40a37a530001621281",
                "appName":"Knife-cut Noodles",
                "desc":"keke",
                "highLights":[
                    {
                        "key":"appName",
                        "value":"<em>Knife</em><em>cut</em><em>Noodles</em>"
                    },
                    {
                        "key":"desc",
                        "value":"keke"
                    },
                    {
                        "key":"keys",
                        "value":""
                    },
                    {
                        "key":"pageSource",
                        "value":"The following will demonstrate the official Mini-Program component capabilities. Component styles are for reference only."
                    }
                ],
                "logo":"https://www-cdn.finclip.com/images/ic-default.png",
                "organName":"Individual-13333333335",
                "pageUrl":"pages/component/index/index",
                "showText":"keke"
            },
            {
                "appId":"617f95973878a60001b71c4e",
                "appName":"Beef Noodles",
                "desc":"qwe",
                "highLights":[
                    {
                        "key":"appName",
                        "value":"Beef<em>Noodles</em>"
                    },
                    {
                        "key":"desc",
                        "value":"qwe"
                    },
                    {
                        "key":"keys",
                        "value":""
                    },
                    {
                        "key":"pageSource",
                        "value":"Mini-Program"
                    }
                ],
                "logo":"https://www-cdn.finclip.com/images/ic-default.png",
                "organName":"Individual-13333333335",
                "pageUrl":"packageAPI/pages/Accelerometer/index",
                "showText":"qwe"
            }
        ],
        "total":2
    },
    "errcode":"OK",
    "error":"Success"
}

Error Status

HTTP/1.1 !=200 Server Exception
400 Parameter Error, Illegal Signature

# Get Compiled Mini-Program Information

POST

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

Parameters

Field Type Description
codeId string Unique id
type string Type Trial Version: trial; Temporary Version: temporary; Review Version: review; Release Version: release
apiServer string Domain
confList string Configuration field (reserved)
key string Key
value Object Value (can be any value)
extList Array Extension field (put userId inside)
timestamp string Seconds Timestamp
uuid string Unique Identifier
sign string Signature

Header

Field Type Description
mop-sdk-key string sdkKey
hashcode string Hashcode of the returned information
mop-qrcode-sign string Encryption string

Request-Example

{
  "codeId": "Unique id",
  "type": "Mini-Program Type",
  "apiServer": "Domain",
  "confList": [
    {
      "key": "key",
      "value": "ccc"
    }
  ],
  "extList": [
    {
      "key": "key",
      "value": "ccc"
    },
    {
      "key": "userId",
      "value": "11111"
    }
  ],
  "uuid": "3A37ABBF-801F-4031-B63B-5201B96395DA",//uuid
  "timestamp": 1623136201,//Seconds Timestamp
  "sign": "EA416ED0759D46A8DE58F63A59077499" //Signature
}

Success Status

Correct return http code is 200:
{
   "errcode": "OK",
   "error": "",
   "data": {
       "infoId": "60a358e23a0e1c0001af2f40",//Unique Id
       "coreDescription": "test",//Mini-Program Introduction
       "created": 1622535185911,//Creation time of this information
       "createdBy": "13461390857",//Creator of this version
       "customData": {
           "appRuntimeDomain": { //Domain information
               "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",//Version Description
           "detailDescription": "",//Detailed Description
           "menuInfo": {
               "total": 0,
               "list": []
           },
           "apiInfo": null
       },
       "groupId": "60a358d2bc6c3e0001d5f1ab",//Enterprise Id
       "groupName": "autodzljr",//Enterprise Name
       "logo": "/api/v1/mop/netdisk/download/60a358e2f5300b0001a14e24",//Mini-Program logo
       "name": "autocmpaz",//Mini-Program Name
       "version": "2.0.0",//Version Number
       "needCrt": false //Whether CRT is needed
   }
    "hashcode": "de3cca0ccaa027e7b7d887681ed6ed17"   // Optimization item, removed if optimization is not effective
}

Error Status

HTTP/1.1 !=200 Server Exception
400 Parameter Error, Parameter Missing
403 QR Code Expired, Illegal Signature

Remarks

The sign generation method is as follows:
Sort all fields alphabetically and connect the field name and its value with =. For the confList and extList fields in the request, the array needs to be sorted based on the value corresponding to the key in the item. After sorting, take the JSON marshal string. Connect fields with &. Finally, concatenate with &: secret=a (a is the secret corresponding to sdkKey) to get string s. Perform MD5 encryption on s and then convert to uppercase to get sign. Example:
{
“a”:”111”,
“b”:”222”,
“c”:[
{“key”:”k1”,”value”:”v1”},
{“key”:”k2”,”value”:2}
],
“d”:{
“name”:”wangkang”
}
“timestamp”:1623136200000,
“uuid”:”aaa-bbb-ccc-dddd”
}
Then the final encrypted string 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”

# Get Managed Mini-Program List

POST

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

Header

Field Type Description
mop-sdk-key string sdkKey

Request-Example

{
    "appId":"Mini-Program id",
    "extList":[//Extension field
        {
            "key":"userId",
            "value":"222"
        }
    ],
    "uuid":"3A37ABBF-801F-4031-B63B-5201B96395DA",
    "timestamp":1623136201,
    "sign":"EA416ED0759D46A8DE58F63A59077499"//See remarks for signature
}

Success Status

Correct return http code is 200:
{
    "data":{
        "appList":[
            {
                "appId":"Mini-Program Id",
                "logo":"Mini-Program logo",
                "name":"Mini-Program Name"
            },
            {
                "appId":"Mini-Program Id",
                "logo":"Mini-Program logo",
                "name":"Mini-Program Name"
            }
        ],
        "total":2
    },
    "errcode":"OK",
    "error":""
}

Error Status

HTTP/1.1 !=200 Server Exception
400 Parameter Missing, Parameter Error, No Permission for this Mini-Program
403 Illegal Signature

# Get Mini-Program Release, Development, Trial Versions

POST

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

Parameters

Field Type Description
appId string Mini-Program Id
extList Array Extension list
timestamp string Seconds Timestamp
uuid string Unique Identifier
sign string Signature

Request-Example

Success Status

Correct return http code is 200:
{
    "data":{
        "releaseInfo":{
            "appId":"Mini-Program Id",
            "version:"Version Number",
            "versionDescription":"Version Description"
        },
        "trialInfo":{
            "codeId":"codeId",
            "version":"Version Number",
            "versionDescription":"Version Description"
        },
        "devInfo":{
            "list":[
                {
                    "codeId":"Mini-Program Id",
                    "version:"Version Number",
                    "versionDescription":"Version Description" 
                }
            ],
            "total":1
        }
    },
    "errcode":"OK",
    "error":""
}

Error Status

HTTP/1.1 !=200 Server Exception
400 Parameter Missing, Parameter Error
403 Illegal Signature

# Get QR Code Information

GET

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

Parameters

Field Type Description
infoid string QR Code id obtained by scanning
timestamp int Seconds Timestamp
uuid string Unique Identifier
sign string Signature

Header

Field Type Description
mop-sdk-key string sdkKey
mop-encryption-type string Signature Encryption Method: md5 (MD5 encryption), sm (SM encryption)

Request-Example

Success Status

Non-FinClip App scan, return 301, redirect
 FinClip App scan
Normal 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 Server Exception
400 Parameter Error
403 Illegal Signature
© FinClip with ❤ , Since 2017