一洼绿地

API DOC

·2 min read

1. 获取公钥

GET /api/v1/ad/protocol/secureTokens

返回 
{
  "code": "0",
  "message": "success",
  "data": {
    "公钥1 key": "公钥1",
    "公钥2 key": "公钥2"
  }
}

2. 上传密钥

POST /api/v1/ad/protocol/encryptKey

请求 
xx...:xxx...

返回 
xxxxx....

3. 基本配置

POST /api/v1/ad/config

请求
{
    "adPlatform":"Vivo", // 平台 Oppo Xiaomi Huawei..
    "businessCode":"Tiantian", // Tiantian  Huanman
    "deviceId":"xxxxxx"  // 唯一 机器ID
}

返回 
{
  "code": "0",
  "message": "success",
  "data": {
    "uncloseRate": 80, // 不能关闭的百分比
    "adQuota": 19,     // 剩余显示多少次广告
    "region": "1",     // (废弃) 
    "rapps": [
      [
        "org.hapjs.debugger", // 包名
        "more package name..."
      ]
    ]
  }
}

4. 壁纸

POST /api/v1/ad/wallpapers

请求
{
    "adPlatform":"Vivo", // 平台 Oppo Xiaomi Huawei..
    "businessCode":"Tiantian", // Tiantian  Huanman
    "deviceId":"xxxxxx"  // 唯一 机器ID
}

返回 
{
  "code": "0",
  "message": "success",
  "data": {
    "beauty": {  // 分类 KEY
      "categoryName": "女孩", // 分类名
      "categoryCode": "beauty", // 分类 KEY
      "resourceList": [
        "https://....", // 图片 1
        "https://...."  // 图片 ...
      ]
    },
    "cat": {  // 分类 KEY
      "categoryName": "小猫", // 分类名
      "categoryCode": "cat", // 分类 KEY
      "resourceList": [
        "https://....", // 图片 1
        "https://...."  // 图片 ...
      ]
    }
  }
}

5. 行为上报

POST /api/v1/action/report

请求
{
    "adPlatform":"Vivo",       // 平台 Oppo Xiaomi Huawei..
    "businessCode":"Tiantian", // Tiantian  Huanman
    "adAction":"AdFinish",     // 行为 AppEnter AppExit AdShow AdClick AdFinish
    "deviceId":"xxxxxxx",      // 唯一 机器ID
    "vivoRequestId": "",       // 回传点击数据时,透传给广告主的 RequestID
    "vivoCreativeId": "",      // 回传点击数据时,透传给广告主的 creativeId
    "userId":"123",            // 用户 id...(可同机器 ID)
    "count":"1"                // 固定 1
}

返回
{
  "code": "0",
  "message": "success",
  "data": ""
}