服务端埋点参数获取

1. 进入管理控制台-->点击采集信息

2. 主域名：服务端埋点数据上报地址

3. 副域名：默认和主域名一致，私部署客户可以提供副域名作为备用域名

4. ServiceSecret和ServiceID为校验参数，注意保密不可泄露。

注意：因为上述信息涉及系统安全，所以只有用管理员权限才可以看到！

请求

接口地址：https://<收数域名+端口>/server

请求参数content-type：application/json

请求参数

上报事件请求JSON参数

事件 报文协议

{ 
  "sign":"27c95768438645138cfb010ded871091",  //必填，签名
  "app_id":"xxxxxxxxx",                       //对应服务端埋点信息中的：ServiceID
  "appkey":"1344444",                         //必填，应用appkey
  "id" : "get_coupons",                       //必填，事件编码
  "umid" : "edfafs",                          //设备id
  "puid" : "123456",                          //登录用户id
                                              //umid和puid务必至少上传一个
  "page_name":"home_page",                    //选填，页面编码 
  "ts" : "1614667799165",                     //必填，事件发生的时间戳
  "cusp" : {                                  //事件自定义参数
    "p1" : "1",
    "p2" : "2",
    "p3" : "3"
  "sdk_type":"httpapi",                       // 固定值，采集服务自动加上该字段
  "server_ts":"1614667799165",               // 如果主动传入，会使用传入值，不传入会自动使用采集服务采集日志时间戳，采集服务自动加上该字段
  "_id":'123344'                              //日志唯一编码，采集服务自动加上该字段
}

上报用户属性请求JSON参数

用户属性 报文协议

{ 
  "sign":"27c95768438645138cfb010ded871091",  //必填，签名
  "app_id":"xxxxxxxxx",                       //必填，对应服务端埋点信息中的：ServiceID
  "appkey":"1344444",                         //必填，应用appkey
  "id" : "$$_user_profile",                   //必填，标识为用户属性
  "umid" : "edfafs",                          //选填，设备id
  "puid" : "123456",                          //必填，登录用户账号ID
  "ts" : "1614667799165",                     //必填，事件发生的时间戳
  "cusp" : {                                  //必填，自定义用户属性
    "gender" : "1",                           //性别
    "birthday" : "1988-12-24"                 //出生年月
  "sdk_type" : "httpapi",                     //固定值，采集服务自动加上该字段
  "server_ts":"1614667799165",             // 如果主动传入，会使用传入值，不传入会自动使用采集服务采集日志时间戳，采集服务自动加上该字段
  "_id":'123344'                           //日志唯一编码，采集服务自动加上该字段
}

sign生成规则说明

1. 先将除了sign字段的其他所有请求字段的key和value封装成一个map对象

2. 将这个map对象序列化成JSON字符串，生成时需要将key按照自然排序即ascii码排序，java可使用JSONObject.toJSONString(mapObject, SerializerFeature.MapSortField)，（注：json需要进行压缩，去掉个字段之间的空格，如后面的代码块）

3. 获取 serviceSecret

4. sign = MD5(排序完生成的JSON字符串 + serviceSecret)

5. 将计算得到的sign放到原始的map对象中，再序列化成JSON字符串即为最终完整的JSON请求报文

sign校验流程图

响应说明

响应数据content-type：application/json

响应的JSON字符串中有两个字段，分别为code、message

Java Demo参考

package com.aliyun.app.quickaplus.mock.once_mock;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.aliyun.app.quickaplus.mock.util.MD5Util;
import okhttp3.*;
import java.io.IOException;
* 服务端ApiDemo
* @author chengtao
public class ServiceApiDemo {
    * 主域名
    private static final String API_URL = "*****";
    * 对应服务端埋点信息中的：ServiceID
    private static final String SERVICE_ID = "*******";
    * 对应服务端埋点信息中的：ServiceSecret
    private static final String SERVICE_SECRET = "*******";
    * client日志
    private static final OkHttpClient client = new OkHttpClient();
* 主函数
* @param args 参数
    public static void main(String[] args) {
        String srcJsonString = getMockData();
        JSONObject json = JSON.parseObject(srcJsonString);
        //向报文中添加服务ID
        json.put("app_id",SERVICE_ID);
        //向报文中添加ts
        json.put("ts", String.valueOf(System.currentTimeMillis()));
        //计算签名
        String sign = MD5Util.md5(JSONObject.toJSONString(json,
        SerializerFeature.MapSortField) + SERVICE_SECRET);
        json.put("sign", sign);
        String desJsonString = JSON.toJSONString(json,
        SerializerFeature.DisableCircularReferenceDetect);
        Request request = new Request.Builder()
        .url(API_URL + "/server")
        .post(RequestBody.create(desJsonString,
        MediaType.parse("application/json")))
        .build();
        try {
            Response response = client.newCall(request).execute();
            if (!response.isSuccessful()) {
                System.out.printf("[DEMO] 发送日志失败 %s%n", response);
            } else {
                System.out.printf("[DEMO] 发送成功 %s%n",
                response.body().string());
        } catch (IOException e) {
            e.printStackTrace();
* 获取MockData
* @return 返回值
    private static String getMockData() {
        return "{\n" +
        " \"appkey\": \"1344444\",\n" +
        " \"id\": \"get_coupons\",\n" +
        " \"umid\": \"uuid()\",\n" +
        " \"puid\": \"puid1\",\n" +
        " \"page_name\": \"home_page\",\n" +
        " \"cusp\": {\n" +
        " \"p1\": \"1\",\n" +
        " \"p2\": \"2\",\n" +
        " \"p3\": \"3\"\n" +
        " },\n" +
        " \"gp\": {\n" +
        " \"p1\": \"1\",\n" +
        " \"p2\": \"2\",\n" +
        " \"p3\": \"3\"\n" +
        " },\n" +
        " \"sdk_type\": \"httpapi\"\n" +
}

Python Demo 参考

# 正确的签名格式
{"appkey": "4b6G49PAkLUb4212","cusp":{"p1":"1","p2":"2","p3":"3"},"gp":{"p1":"1","p2":"2","p3":"3"},"id":"get_coupons","page_name":"home_page","puid":"puid1","sdk_type":"httpapi","umid":"uuid()"}tEkNnx8VDuR0mwEl3hXd7aozYh8Q2qS4
# 错误的签名格式
{"appkey": "您环境下的AppKey", "cusp": {"p1": "1", "p2": "2", "p3": "3"}, "gp": {"p1": "1", "p2": "2", "p3": "3"}, "id": "get_coupons", "page_name": "home_page", "puid": "puid1", "sdk_type": "httpapi", "umid": "uuid()"}tEkNnx8VDuR0mwEl3hXd7aozYh8Q2qS4

import json
import requests
import hashlib
# service_id
service_id = 您环境下的service_id
# service_secret
service_secret = 您环境下的service_secret
# 收数服务配置
qlc_end_point = 您环境下的收数服务地址
# Mock的报文
data = {
    "app_id": service_id,
    "id": "get_coupons",
    "umid": "uuid1",
    "puid": "puid1",
    "page_name": "home_page",
    "ts": 123,
    "cusp": {
        "p1": "1",
        "p2": "2",
        "p3": "3"
    "gp": {
        "p1": "1",
        "p2": "2",
        "p3": "3"
    "sdk_type": "httpapi"
# 按照key的字典序排序
sorted_data = sorted(data.items(), key=lambda item: item[0])
sorted_dict = dict(sorted_data)
string = json.dumps(sorted_dict, separators=(',', ':')) + service_secret
data['sign'] = hashlib.md5(string.encode('utf-8')).hexdigest()
response = requests.post(qlc_end_point + "/server", json=data)
print(response.text)

MD5Util类代码

package com.aliyun.app.quickaplus.mock.util;
import java.security.MessageDigest;
 * md5加密工具类
 * @author zheng.zhang
public class MD5Util {
    public static String md5(String s) {
        char hexDigits[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
        try {
            byte[] btInput = s.getBytes();
            // 获得MD5摘要算法的 MessageDigest 对象
            MessageDigest mdInst = MessageDigest.getInstance("MD5");
            // 使用指定的字节更新摘要
            mdInst.update(btInput);
            // 获得密文
            byte[] md = mdInst.digest();
            // 把密文转换成十六进制的字符串形式
            int j = md.length;
            char str[] = new char[j * 2];
            int k = 0;
            for (int i = 0; i < j; i++) {
                byte byte0 = md[i];
                str[k++] = hexDigits[byte0 >>> 4 & 0xf];
                str[k++] = hexDigits[byte0 & 0xf];
            return new String(str);
        } catch (Exception e) {
            return null;
     * 单元测试
    public static void main(String[] args) {
        StringBuilder dtskey = new StringBuilder("abc12390");
        dtskey.append('\0').append("~!@#$%^&*()_+");
        System.out.println(MD5Util.md5(dtskey.toString()));
        System.out.println(MD5Util.md5("20121221"));
        System.out.println(MD5Util.md5("加密"));