Developer Documentation

说明

采用RESTFul 风格API

Request

Method: 表示对资源操作.
Path：表示资源.

Headers公共请求头:

Content-Type: 表示发送的payload的类型，默认为: application/json。
log_thread: 请求追踪ID，客户端传入方便追踪用户操作，从而定位问题，如果不传，后端则会生成。
login_proof: 访问令牌，由 获取会话 接口提供
implement: 用户设备数据上报，格式为json字符串，包含以下字段：

json5

  {
    "package_id": "com.example.myapp", // 包名
    "version": "1.0.0", // 应用版本
    "ip": "192.168.1.1", // ip地址
    "country": "US", // 国家
    "language": "en", // 语言
    "vpn_user": true, // 是否vpn用户
    "dev_type": "Android",// 设备类型 ios android
    "os_version": "Android 13", // 操作系统版本
    "device_model": "Samsung Galaxy S22",// 设备型号
    "network_type": "WIFI", // 网络类型
    "client_time": "2025-06-20 13:38:28", // 客户端时间
  }

location: 平台，ios或者android
cause_category: 来源类型，用于归因

Response: 采用Http状态码+自定义错误响应来表示
- 100-199协议层面，无需处理
- 200-299表示成功，部分无需返回结果的业务以返回的http状态码作为依据
- 300-399相关跳转
- 400-499和500-599响应错误:
  - 返回给客户端错误信息结构如下：
    json5
```
{
  "timestamp": 1747312781642, // 时间戳
  "status": 503, // http code
  "trace_id": "T-OrCEGtFR5fsM", // 追踪id
  "code": 10, // 业务code
  "path": "/accounts:invite", // 路径
  "error": "服务异常"  // 错误信息
}
```

API列表

获取页面布局(根据语言)

Request
- Path: /headline_ads/:screen_type/places/:area
- Method: get
- PathVariable：
  - screen_type：页面类型，home(首页)，ranking(排行榜)，playbill(剧单页)
  - area：语言

Response

Body

json5

{
  "streamer": "${@body._embedded.poster}" // 详见页面布局新数据接口
}

示例值：

json5

{
  "streamer": []
}

获取建议配置

Request
- Path: /registry/guides
- Method: get

Response

Body

json5

{
  "recommend_conf": "${@body._embedded.advice_setting}" // 配置的建议词
}

示例值：

json5

{
  "recommend_conf": ["x","xx"]
}

上报用户建议

Request

Path: /registry/guides/ascend
Method: post
Body:

json5

{
  "guides": "${@body.advices}", // 建议
  "other_recommendations": "${@body.more_advice}" // 更多建议
}

示例值：

json5

{
  "guides": ["x","xx"],
  "other_recommendations": ""
}

Response
- Status: 200

批量删除观看

Request

Path: /registry/slices/seen
Method: delete
Body:

json5

[
  {
    "block_key": "${@$.episode_id}", // 剧id
    "area": "${@$.language}" // 语言
  }
]

示例值：

json5

[
  {
    "block_key": 0,
    "area": ""
  }
]

Response
- Status: 200

批量删除收藏

Request

Path: /registry/slices/appreciated
Method: delete
Body:

json5

[
  {
    "block_key": "${@$.episode_id}", // 剧id
    "area": "${@$.language}" // 语言
  }
]

示例值：

json5

[
  {
    "block_key": 0,
    "area": ""
  }
]

Response
- Status: 200

获取用户某个短剧的收藏情况

Request
- Path: /registry/slices/:block_key/places/:area/appreciated
- Method: get
- PathVariable：
  - block_key：剧id
  - area：语言

Response

Body

json5

{
  "block_key": "${@body.episode_id}", // 剧id
  "area": "${@body.language}", // 语言
  "cherished": "${@body.is_favored}", // 是否收藏
  "dossier_view_timestamp": "${@body.user_watched_last}" // 最新观看时间
}

示例值：

json5

{
  "block_key": 1,
  "area": "en",
  "cherished": true,
  "dossier_view_timestamp": 123
}

获取收藏记录

Request
- Path: /registry/appreciated
- Method: get
- QueryParams：
  - sheet：页码
  - script_volume：页大小
  - area：语言

Response

Body

json5

{
  "sheet": "${@body.page}", // 页码
  "script_volume": "${@body.page_size}", // 页大小
  "appreciated": [ // _embedded.favored
    {
      "block_key": "${@$.episode_id}", // 剧id
      "area": "${@$.language}", // 语言
      "installment_idx": "${@$.part_index}", // 集数
      "entire_reach": "${@$.total_duration}", // 总时长
      "block_aggregate": "${@$.episode_count}", // 总集数
      "tiny_img": "${@$.cover}", // 封面
      "aspect": "${@$.feature}", // 特征
      "schools": "${@$.categories}", // 分类
      "rubric": "${@$.title}", // 标题
      "outline": "${@$.intro}", // 简介
      "minutiae": "${@$.description}", // 详情
      "tags": "${@$.tags}" // 标签
    }
  ]
}

示例值：

json5

{
  "sheet": 1,
  "script_volume": 12,
  "appreciated": [
    {
      "block_key": 1,
      "area": "",
      "installment_idx": 1,
      "entire_reach": 1.1,
      "block_aggregate": 10,
      "tiny_img": "",
      "aspect": "",
      "schools": ["",""],
      "rubric": "",
      "outline": "",
      "minutiae": "x",
      "tags": ["",""]
    }
  ]
}

获取用户某个短剧的观看情况

Request
- Path: /registry/seen/slices/:block_key/places/:area
- Method: get
- PathVariable：
  - block_key：剧id
  - area：语言

Response

Body

json5

{
  "block_key": "${@body.episode_id}", // 剧id
  "installment_idx": "${@body.part_index}", // 集数
  "area": "${@body.language}", // 语言
  "view_counts": "${@body.play_times}", // 播放次数
  "triggered_timestamp": "${@body.started_at}", // 开始播放时间
  "concluded_moment": "${@body.finished_at}" // 观看完成时间
}

示例值：

json5

{
  "block_key": 1,
  "installment_idx": 1,
  "area": "en",
  "view_counts": 1,
  "triggered_timestamp": 123,
  "concluded_moment": 122
}

获取观看记录

Request
- Path: /registry/seen
- Method: get
- QueryParams：
  - sheet：页码
  - script_volume：页大小
  - area：语言

Response

Body

json5

{
  "sheet": "${@body.page}", // 页码
  "script_volume": "${@body.page_size}", // 页大小
  "seen": [ // _embedded.watched
    {
      "block_key": "${@$.episode_id}", // 剧id
      "area": "${@$.language}", // 语言
      "installment_idx": "${@$.part_index}", // 集数
      "triggered_timestamp": "${@$.started_at}", // 开始播放时间
      "entire_reach": "${@$.total_duration}", // 总时长
      "block_aggregate": "${@$.episode_count}", // 总集数
      "aspect": "${@$.feature}", // 特征
      "cherished": "${@$.is_favored}", // 是否收藏
      "tiny_img": "${@$.cover}", // 封面
      "schools": "${@$.categories}", // 分类
      "rubric": "${@$.title}", // 标题
      "outline": "${@$.intro}", // 简介
      "view_counts": "${@$.play_times}", // 播放次数
      "tags": "${@$.tags}" // 标签
    }
  ]
}

示例值：

json5

{
  "sheet": 1,
  "script_volume": 12,
  "seen": [
    {
      "block_key": 1,
      "area": "",
      "installment_idx": 1,
      "triggered_timestamp": 12,
      "entire_reach": 1.1,
      "block_aggregate": 1,
      "aspect": "",
      "cherished": true,
      "tiny_img": "",
      "schools": ["",""],
      "rubric": "xx",
      "outline": "x",
      "view_counts": 11,
      "tags": ["",""]
    }
  ]
}

获取短剧剧集

Request
- Path: /slices/:block_key/places/:area/cluster
- Method: get
- PathVariable：
  - block_key：剧id
  - area：语言

Response

Body

json5

{
  "block_key": "${@body.episode_id}", // 剧id
  "area": "${@body.language}", // 语言
  "rubric": "${@body.title}", // 标题
  "outline": "${@body.intro}", // 简介 
  "cherished": "${@body.is_favored}", // 是否收藏
  "dossier_view_timestamp": "${@body.user_watched_last}", // 最新观看时间
  "ingress_conf": { // unlock_setting 全局解锁配置
    "cash_on_visit": "${@body.unlock_setting.coins_single_consume}", // 解锁需要的金币
    "extra_by_entry": "${@body.unlock_setting.bonus_single_consume}" // 解锁需要的代币
  },
  "cluster": [ // _embedded.playlist
    {
      "unique_mark": "${@$.id}", // id
      "block_key": "${@$.episode_id}", // 剧id
      "installment_idx": "${@$.part_index}", // 集数
      "area": "${@$.language}", // 语言
      "agree_figure": "${@$.likes}", // 喜欢数
      "allowance": "${@$.coins}", // 解锁需要的金币数
      "perks": "${@$.bonus}", // 解锁需要的代币数
      "range": "${@$.duration}", // 时长
      "outline": "${@$.intro}", // 简介
      "minutiae": "${@$.description}", // 详情
      "intro": "${@$.thumbnail}", // 缩略图
      "watch_wave": "${@$.stream_hls}", // hls播放地址
      "dynamic_brook": "${@$.stream_dash}", // dash播放地址
      "watch_stats": "${@$.watch_times}", // 观看次数
      "entry": "${@$.unlock}" // 是否解锁
    }
  ]
}

示例值：

json5

{
  "block_key": 1,
  "area": "x",
  "rubric": "xx",
  "outline": "xx",
  "cherished": true,
  "dossier_view_timestamp": 122,
  "ingress_conf": {
    "cash_on_visit": 100,
    "extra_by_entry": 100
  },
  "cluster": [
    {
      "unique_mark": 3,
      "block_key": 2,
      "installment_idx": 1,
      "area": "en",
      "agree_figure": 11,
      "allowance": 100,
      "perks": 100,
      "range": 1.1,
      "outline": "xx",
      "minutiae": "xxx",
      "intro": "xx",
      "watch_wave": "xxx",
      "dynamic_brook": "xxx",
      "watch_stats": 11,
      "entry": true
    }
  ]
}

获取用户推荐剧列表

Request
- Path: /registry/slices/places/:area/advocate
- Method: get
- PathVariable：
  - area：语言
- QueryParams：
  - amount_calc：数量

Response

Body

json5

{
  "endorsement_collection": [ // _embedded.recommend_list
    {
      "block_key": "${@$.episode_id}", // 剧集ID
      "area": "${@$.language}", // 语言
      "rubric": "${@$.title}",
      "outline": "${@$.intro}",
      "cherished": "${@$.is_favored}", // 是否收藏
      "dossier_view_timestamp": "${@$.user_watched_last}", // 最近观看
      "ingress_conf": {
        "cash_on_visit": "${@$.unlock_setting.coins_single_consume}", // 解锁需要的金币
        "extra_by_entry": "${@$.unlock_setting.bonus_single_consume}" // 解锁需要的代币
      },
      "cluster": [ // _embedded.playlist
        {
          "unique_mark": "${@$.id}", // ID
          "block_key": "${@$.episode_id}", // 剧集ID
          "installment_idx": "${@$.part_index}", // 集数
          "area": "${@$.language}", // 语言
          "allowance": "${@$.coins}", // 解锁需要的金币数
          "perks": "${@$.bonus}", // 解锁需要的代币数
          "agree_figure": "${@$.likes}", // 点赞数
          "range": "${@$.duration}", // 时长
          "outline": "${@$.intro}", // 简介
          "minutiae": "${@$.description}", // 描述
          "intro": "${@$.thumbnail}", // 缩略图
          "watch_wave": "${@$.stream_hls}", // HLS流
          "dynamic_brook": "${@$.stream_dash}", // DASH流
          "watch_stats": "${@$.watch_times}", // 观看次数
          "entry": "${@$.unlock}" // 是否解锁
        }
      ]
    }
  ]
}

示例值：

json5

{
  "endorsement_collection": [
    {
      "block_key": 0,
      "area": "",
      "rubric": "",
      "outline": "",
      "cherished": true,
      "dossier_view_timestamp": 0,
      "ingress_conf": {
        "cash_on_visit": 0,
        "extra_by_entry": 0
      },
      "cluster": [
        {
          "unique_mark": 0,
          "block_key": 0,
          "installment_idx": 0,
          "area": "en",
          "allowance": 0,
          "perks": 0,
          "agree_figure": 0,
          "range": 0.0,
          "outline": "",
          "minutiae": "",
          "intro": "",
          "watch_wave": "",
          "dynamic_brook": "",
          "watch_stats": 0,
          "entry": true
        }
      ]
    }
  ]
}

获取短剧详情

Request
- Path: /slices/:block_key/places/:area/minutiae
- PathVariable：
  - block_key：剧id
  - area：语言
- Method: get

Response

Body

json5

{
  "block_key": "${@body.episode_id}", // 剧id
  "area": "${@body.language}", // 语言
  "rubric": "${@body.title}", // 标题
  "entire_reach": "${@body.total_duration}", // 总时长
  "block_aggregate": "${@body.episode_count}", // 总集数
  "zero_charge_vol": "${@body.free_count}", // 免费集数
  "outline": "${@body.intro}", // 简介
  "minutiae": "${@body.description}", // 详情
  "annex_name": "${@body.subtitle}", // 副标题
  "tags": "${@body.tags}", // 标签
  "bit_concluded": "${@body.is_episode_end}" // 是否完结
}

示例值：

json5

{
  "block_key": 1,
  "area": "en",
  "rubric": "",
  "entire_reach": 1.1,
  "block_aggregate": 1,
  "zero_charge_vol": 1,
  "outline": "",
  "minutiae": "",
  "annex_name": "",
  "tags": ["x","xx"],
  "bit_concluded": true
}

获取短剧

Request
- Path: /slices/:block_key
- PathVariable：
  - block_key：剧id
- Method: get

Response

Body

json5

{
  "unique_mark": "${@body.id}", // id
  "tiny_img": "${@body.cover}", // 封面
  "tags_tally": "${@body.bookmarks_count}",  // 收藏数
  "rank": "${@body.grade}", // 评分
  "schools": "${@body.categories}", // 分类
  "std_language": "${@body.default_lang}", // 语言
  "release_date": "${@body.released_at}" // 更新时间
}

示例值：

json5

{
  "unique_mark": 1,
  "tiny_img": "xxx",
  "tags_tally": 10,
  "rank": 1.0,
  "schools": ["x","xx"],
  "std_language": "en",
  "release_date": 123
}

结束播放短剧

Request
- Path: /slices/:block_key/places/:area/divisions/:installment_idx/flow/terminated
- Method: get
- PathVariable：
  - block_key：剧id
  - installment_idx：第几集
  - area：语言
Response
- Status: 200

开始播放短剧

Request
- Path: /slices/:block_key/places/:area/divisions/:installment_idx/flow/live
- Method: get
- PathVariable：
  - block_key：剧id
  - installment_idx：第几集
  - area：语言
Response
- Status: 200

用户取消收藏短剧

Request
- Path: /registry/slices/:block_key/places/:area/delete_favorite
- Method: get
- PathVariable：
  - block_key：剧id
  - area：语言
Response
- Status: 200

用户收藏短剧

Request
- Path: /registry/slices/:block_key/places/:area/save_point
- Method: get
- PathVariable：
  - block_key：剧id
  - area：语言
Response
- Status: 200

用户分享短剧

Request
- Path: /registry/slices/:block_key/places/:area/disseminated
- Method: get
- PathVariable：
  - block_key：剧id
  - area：语言
Response
- Status: 200

获取年龄

Request
- Path: /birth_years
- Method: get

Response

Body

json5

{
  "client_season": "${@body._embedded.ages}" // 词典数据列表
}

示例值：

json5

{
  "client_season": []
}

修改个人详情

Request

Path: /record_content/alter
Method: patch
Body:

json5

{
  "screenname": "${@body.nickname}", // 昵称
  "portrait": "${@body.avatar}", // 头像
  "lifespan_metric": "${@body.age}", // 年龄
  "demographic_sex": "${@body.sex}" // 性别
}

示例值：

json5

{
  "screenname": "",
  "portrait": "",
  "lifespan_metric": "",
  "demographic_sex": ""
}

Response
- Status: 200

获取个人详情

Request
- Path: /record_content
- Method: get

Response

Body

json5

{
  "identity_uuid": "${@body.user_id}", // 用户id
  "screenname": "${@body.nickname}", // 昵称
  "portrait": "${@body.avatar}", // 头像
  "lifespan_metric": "${@body.age}", // 年龄
  "demographic_sex": "${@body.sex}", // 性别
  "root_class": "${@body.source_type}", // 归因类型
  "specific": "${@body.special}", // 特殊用户
  "has_entry": "${@body.is_access}", // 是否白名单用户
  "mobile_edge": "${@body.app_side}", // A、B 面
  "proxy_check": "${@body.check_vpn}", // 是否开启vpn检测
  "record_dues": { // user_subscription
    "deal_type": "${@body.user_subscription.payment_method}", // 支付方式（google: 谷歌内购，apple: 苹果内购）
    "interval_genre": "${@body.user_subscription.bicycle_type}", // 订阅扣款类型 (weekly，monthly, yearly，用于商品类型为vip和coins_package的)
    "term_finish_time": "${@body.user_subscription.expiration_time}", // 订阅过期时间（时间戳）
    "prestige_flag": "${@body.user_subscription.is_vip}", // 是否为vip
    "pledged": "${@body.user_subscription.is_subscribed}" // 是否已订阅
  },
  "beginning_contracts": [ // new_user_subscriptions
    {
      "deal_type": "${@$.payment_method}", // 支付方式（google: 谷歌内购，apple: 苹果内购）
      "interval_genre": "${@$.bicycle_type}", // 订阅扣款类型 (weekly，monthly, yearly，用于商品类型为vip和coins_package的)
      "term_finish_time": "${@$.expiration_time}", // 订阅过期时间（时间戳）
      "prestige_flag": "${@$.is_vip}", // 是否为vip 
      "pledged": "${@$.is_subscribed}", // 是否已订阅
      "gold_unit_tag": "${@$.coins_item_id}", // Coins物品id（用于商品类型为coins_package）
      "money_gross": "${@$.coins_count}", // Coins数量（用于商品类型为coins_package）
      "added_good_marker": "${@$.bonus_item_id}", // Bonus物品id（用于商品类型为coins_package）
      "reward_gross": "${@$.bonus_count}", // Bonus数量（用于商品类型为coins_package）
      "credential_id": "${@$.sign_item_id}", // 签到赠送Bonus物品id（用于商品类型为coins_package）
      "total_logins": "${@$.sign_count}", // 签到赠送Bonus数量（用于商品类型为coins_package）
      "logged_days": "${@$.sign_days}", // 签到赠送Bonus数量（用于商品类型为coins_package）
      "third_party_uid": "${@$.outer_platform_product_id}" // 外部平台商品id
    }
  ],
  "cash_reserve": { // wallet
    "allowance": "${@body.wallet.coins}", // 金币
    "perks": "${@body.wallet.bonus}" // 代币
  },
  "ties": { // _links
    "software_client": "${@body._links.app_user.href}", // 用户协议
    "mobile_isolation": "${@body._links.app_privacy.href}", // 隐私协议
    "tool_transaction": "${@body._links.app_payment.href}", //支付协议
    "utility_compliance": "${@body._links.app_gdpr.href}", // gdpr
    "utility_regulation": "${@body._links.app_ccpa.href}", //ccpa
    "usage_policy": "${@body._links.terms_of_service.href}", // trems
    "zuck_page_iphone": "${@body._links.fb_page_ios.href}", // fb page ios
    "fanpage_domain": "${@body._links.fb_page_web.href}" // fb page web
  }
}

示例值：

json5

{
  "identity_uuid": "",
  "screenname": "",
  "portrait": "",
  "lifespan_metric": "",
  "demographic_sex": "",
  "root_class": "",
  "specific": "",
  "has_entry": "",
  "mobile_edge": "",
  "proxy_check": "",
  "record_dues": {
    "deal_type": "",
    "interval_genre": "",
    "term_finish_time": 1231,
    "prestige_flag": true,
    "pledged": true
  },
  "beginning_contracts": [
    {
      "deal_type": "",
      "interval_genre": "",
      "term_finish_time": 123,
      "prestige_flag": true,
      "pledged": true,
      "gold_unit_tag": 1,
      "money_gross": 0,
      "added_good_marker": 2,
      "reward_gross": 0,
      "credential_id": 2,
      "total_logins": 0,
      "logged_days": 0,
      "third_party_uid": ""
    }
  ],
  "cash_reserve": {
    "allowance": 100,
    "perks": 100
  },
  "ties": {
    "software_client": "x",
    "mobile_isolation": "x",
    "tool_transaction": "xx",
    "utility_compliance": "xx",
    "utility_regulation": "xx",
    "usage_policy": "xx",
    "zuck_page_iphone": "x",
    "fanpage_domain": "x"
  }
}

修改用户自动解锁配置

Request
- Path: /registry/cash_reserve/machine_admission_conf
- Method: patch
Response
- Status: 200

获取会话

Request
- Path: /network_nodes
- Method: get
- QueryParams：
  - product_mold：产品组

Response

Body

json5

{
  "door_ticket": "${@body.access_token}", // token
  "expiry_instant": "${@body.expires_at}", // 过期时间
  "fresh_user": "${@body.is_new_user}", // 是否新用户
  "visitor_mode": "${@body.is_anonymous}", // 是否匿名用户
  "machine_admission_setup": "${@body.auto_unlock_setting}" // 是否开启自动解锁
}

示例值：

json5

{
  "door_ticket": "",
  "expiry_instant": 123,
  "fresh_user": true,
  "visitor_mode": true,
  "machine_admission_setup": false
}

获取指定语言的词典数据

Request
- Path: /glossaries/places/:area
- Method: get
- PathVariable：
  - area：语言

Response

Body

json5

{
  "glossaries": [ // 词典数据列表，_embedded.dict_item_vo_lis
    {
      "lexeme": "${@$.word}", // 词汇
      "locale": "${@$.trans}" // 翻译
    }
  ]
}

示例值：

json5

{
  "glossaries": [
    {
      "lexeme": "For You",
      "locale": "Para Você"
    },
    {
      "lexeme": "Home",
      "locale": "Início"
    }
  ]
}

获取支持的语言列表

Request
- Path: /glossaries/places
- Method: get

Response

Body

json5

{
  "places": "${@body._embedded.languages}" // 支持的语言列表
}

示例值：

json5

{
  "places": ["pt", "en"]
}

获取首页短剧推送列表

Request
- Path: /dashboard_alert/places/:area
- Method: get
- PathVariable：
  - area：语言

Response

Body

json5

{
  "topic_core": [ // body
    {
       "block_key": "${@$.episode_id}", // 剧id
       "rubric": "${@$.title}", // 标题
       "tiny_img": "${@$.cover}", // 封面
       "outline": "${@$.intro}" // 详情
    }
  ]
}

示例值：

json5

{
  "topic_core": [
    {
       "block_key": 1,
       "rubric": "x",
       "tiny_img": "xx",
       "outline": "xxx"
    }
  ]
}

上报事件

Request
- Path: /occasions/:event_id
- Method: post
- PathVariable：
  - event_id：事件名

Response

Status: 200

Body

json5

{
  "xxx": "xxx", //事件参数
  "xxx": "xxx"
}

示例值：

json5

{
  "xxx": "xxx"
}

更新FCM访问令牌

Request

Path: /record_content/fire_auth_sign
Method: patch

Body:

json5

{
  "notify_permit": "${@body.fcm_token}" // fcm令牌
}

示例值：

json5

{
  "notify_permit": "xxxxx"
}

Response
- Status: 200

解锁剧集

Request
- Path: /slices/:block_key/places/:area/divisions/:installment_idx/entry
- Method: get
- PathVariable：
  - block_key：剧id
  - installment_idx：第几集
  - area：语言
- QueryParams：
  - entry_route：解锁方式 item 物品解锁 ad 广告解锁

Response

Body

json5

{
  "unique_mark": "${@body.id}", // id
  "block_key": "${@body.episode_id}", // 剧id
  "installment_idx": "${@body.part_index}", // 第几集
  "area": "${@body.language}", // 语言
  "range": "${@body.duration}", // 时长
  "intro": "${@body.thumbnail}", // 首帧图
  "watch_wave": "${@body.stream_hls}", // hls播放地址
  "dynamic_brook": "${@body.stream_dash}" // dash播放地址
}

示例值：

json5

{
  "unique_mark": 1,
  "block_key": 1,
  "installment_idx": 1,
  "area": "en",
  "range": 1.1,
  "intro": "xx",
  "watch_wave": "xx",
  "dynamic_brook": "xx"
}

上报用户设备信息

Request

Path: /network_nodes/physical_tech
Method: post

Body:

json5

{
  "rig_serial": "${@body.device_id}", //设备id
  "software_platform": "${@body.os}", // 系统
  "revision_code": "${@body.os_version}", // 系统版本
  "tune_uuid": "${@body.adid}", // adjust id
  "play_track_id": "${@body.google_ad_id}", // google ad id
  "android_origin": "${@body.google_attribution}", // google 归因信息
  "modify_credit": "${@body.adjust_attribution}", // adjust 归因信息
  "ios_promo_uid": "${@body.ios_ad_id}", // ios id
  "target_href": "${@body.deep_link}" // 深度链接
}

示例值：

json5

{
  "rig_serial": "",
  "software_platform": "",
  "revision_code": "",
  "tune_uuid": "",
  "play_track_id": "",
  "android_origin": "",
  "modify_credit": "",
  "ios_promo_uid": "",
  "target_href": ""
}

Response

Body

json5

{
  "moviehouse_idx": "${@body.theatre_id}" // 剧id
}

示例值：

json5

{
  "moviehouse_idx": 19
}

获取用户奖励记录

Request
- Path: /registry/cash_reserve/presented_data
- Method: get
- QueryParams：
  - immediate：游标
  - amount_calc：大小

Response

Body

json5

{
  "profile_achievements": [ // _embedded.user_rewarded_histories
    {
      "unique_mark": "${@$.id}", // id
      "award_ref": "${@$.item_id}", // 物品id
      "award_volume": "${@$.item_num}", // 物品数量
      "aim": "${@$.reason}", // 原因
      "constructed_when": "${@$.created_at}" // 创建时间
    }
  ]
}

示例值：

json5

{
  "profile_achievements": [
    {
      "unique_mark": 1,
      "award_ref": 2,
      "award_volume": 100,
      "aim": "",
      "constructed_when": 12333
    }
  ]
}

获取用户解锁记录

Request
- Path: /registry/cash_reserve/admission_data
- Method: get
- QueryParams：
  - immediate：游标
  - amount_calc：大小

Response

Body

json5

{
  "dossier_usage": [ // _embedded.user_unlock_histories
    {
      "unique_mark": "${@$.id}", // id
      "block_key": "${@$.episode_id}", // 剧id
      "area": "${@$.language}", // 语言
      "rubric": "${@$.title}", // 标题
      "installment_idx": "${@$.part_index}", // 第几集
      "auth_procedure": { // unlock_way
        "perks": [ // items
          {
            "award_ref": "${@$.item_id}", // 物品id
            "award_volume": "${@$.item_num}" // 物品数量
          }
        ],
        "user_role_type": "${@$.unlock_way.unlock_type}" // 解锁方式 itme 物品 ad 广告
      },
      "constructed_when": "${@$.created_at}" // 创建时间
    }
  ]
}

示例值：

json5

{
  "dossier_usage": [
    {
      "unique_mark": 1,
      "block_key": 2,
      "area": "en",
      "rubric": "xx",
      "installment_idx": 3,
      "auth_procedure": {
        "perks": [
          {
            "award_ref": 1,
            "award_volume": 100
          }
        ],
        "user_role_type": "item"
      },
      "constructed_when": 123
    }
  ]
}

获取用户钱包

Request
- Path: /registry/cash_reserve
- Method: get

Response

Body

json5

{
  "allowance": "${@body.coins}", // 金币
  "perks": "${@body.bonus}", // 代币
  "machine_admission_setup": "${@body.auto_unlock_setting}" // 是否自动解锁
}

示例值：

json5

{
  "allowance": 100,
  "perks": 100,
  "machine_admission_setup": true
}

内购创建订单V2

Request

Path: /tier_2/registry/orders/compose
Method: post
Body:

json5

{
  "merch_code": "${@body.product_id}", // 商品ID
  "deal_type": "${@body.payment_method}", // 支付方式（google: 谷歌内购，apple: 苹果内购）
  "block_key": "${@body.episode_id}" // 剧库id，用于数数上报
}

示例值：

json5

{
  "merch_code": "",
  "deal_type": "",
  "block_key": ""
}

Response

Body

json5

{
  "identity_call_no": "${@body.user_order_no}", // 订单号（uuid）
  "third_party_uid": "${@body.outer_platform_product_id}", // 外部平台商品id
  "extraneous_os": "${@body.outer_platform}", // 外部商品平台（google: 谷歌，apple: 苹果）
  "merch_code": "${@body.product_id}", // 商品ID
  "deal_type": "${@body.payment_method}" // 支付方式（google: 谷歌内购，apple: 苹果内购）
}

示例值：

json5

{
  "identity_call_no": "",
  "third_party_uid": "",
  "extraneous_os": "",
  "merch_code": 0,
  "deal_type": "apple"
}

获取所有上架商品V2

Request
- Path: /tier_2/effects
- Method: get
- QueryParams：
  - sheet：分页
  - script_volume：分页大小
  - section：商品类型，vip（VIP订阅）、coins_package（金币包订阅）、gift_radio（充值赠币）

Response

Body

json5

{
  "sheet": "${@body.page}", // 页码
  "script_volume": "${@body.page_size}", // 分页大小
  "effects": [ // _embedded.products
    {
      "unique_mark": "${@$.id}", // 商品ID
      "name": "${@$.name}", // 商品名
      "expense": "${@$.price}", // 商品原单价
      "deduction": "${@$.discount_price}", // 商品优惠价格
      "gold_unit_tag": "${@$.coins_item_id}", // Coins物品id（用于商品类型为gift_radio）
      "money_gross": "${@$.coins_count}", // Coins数量（用于商品类型为gift_radio）
      "reward_gross": "${@$.bonus_count}", // Bonus数量（用于商品类型为gift_radio）
      "added_good_marker": "${@$.bonus_item_id}", // Bonus物品id（用于商品类型为gift_radio）
      "premium_grade": "${@$.gift_ratio}", // 赠送比例（买金币赠送代币的比例，用于商品类型为gift_radio）
      "interval_genre": "${@$.sub_bicycle_type}", // 订阅扣款类型 (weekly，monthly，用于商品类型为vip和coins_package的)
      "extraneous_os": "${@$.outer_platform}", // 外部商品平台（google: 谷歌，apple: 苹果）
      "third_party_uid": "${@$.outer_platform_product_id}", // 外部平台商品id
      "stranger_brand": "${@$.outer_platform_product_name}", // 外部平台商品名
      "rebate_timer": "${@$.duration_discount_minutes}", // 限时优惠倒计时（单位分钟）
      "bargain_state": "${@$.is_discount}", // 是否为限时优惠
      "section": "${@$.type}", // 商品类型，vip（VIP订阅）、coins_package（金币包订阅）、gift_radio（充值赠币）
      "minutiae": "${@$.description}" // 商品详情描述
    }
  ]
}

示例值：

json5

{
  "sheet": 1,
  "script_volume": 10,
  "effects": [
    {
      "unique_mark": 1,
      "name": "Week Subscription",
      "expense": 29.9,
      "deduction": 9.9,
      "gold_unit_tag": 1,
      "money_gross": 0,
      "reward_gross": 0,
      "added_good_marker": 2,
      "premium_grade": 0.0,
      "interval_genre": "weekly",
      "extraneous_os": "",
      "third_party_uid": "",
      "stranger_brand": "",
      "rebate_timer": 0,
      "bargain_state": false,
      "section": "vip",
      "minutiae": "Week Subscription"
    }
  ]
}

未支付订单取消V2

Request
- Path: /tier_2/registry/orders/:ticket_num/void
- Method: patch
- PathVariable：
  - ticket_num：订单号（uuid）
Response
- Status: 200

苹果订阅恢复

Request
- Path: /itunes/registry/restitution/:trace
- Method: post
- PathVariable：
  - trace：苹果交易ID

Response

Body

json5

{
  "trace": "${@body.transaction_id}", // 苹果交易ID
  "identity_uuid": "${@body.user_id}", // 用户ID
  "door_ticket": "${@body.access_token}" // 恢复后的用户访问令牌
}

示例值：

json5

{
  "trace": "xxx",
  "identity_uuid": "xxxx",
  "door_ticket": "xxxx"
}

获取订单列表V2

Request
- Path: /tier_2/registry/orders
- Method: get
- QueryParams：
  - sheet：分页
  - script_volume：分页大小

Response

Body

json5

{
  "sheet": "${@body.page}", // 页码
  "script_volume": "${@body.page_size}", // 分页大小
  "orders": [ // _embedded.orders
    {
      "ticket_num": "${@$.order_no}", // 订单号（uuid）
      "interval_genre": "${@$.sub_bicycle_type}", // 订阅扣款类型（weekly: 周订阅，monthly: 月订阅，用于商品类型为 vip 和 coins_package）
      "gold_unit_tag": "${@$.coins_item_id}", // Coins 物品 id（用于商品类型为 gift_radio 和 coins_package）
      "money_gross": "${@$.coins_count}", // Coins 数量（用于商品类型为 gift_radio 和 coins_package）
      "reward_gross": "${@$.bonus_count}", // Bonus 数量（用于商品类型为 gift_radio 和 coins_package）
      "added_good_marker": "${@$.bonus_item_id}", // Bonus物品id（用于商品类型为gift_radio）
      "premium_grade": "${@$.gift_ratio}", // 赠送比例（买金币赠送代币的比例，用于商品类型为 gift_radio 和 coins_package）
      "cargo_desc": "${@$.product_name}", // 商品名
      "cargo_type": "${@$.product_type}", // 商品类型，vip（VIP订阅）、coins_package（金币包订阅）、gift_radio（充值赠币）
      "terminal_bill": "${@$.actual_amount}", // 商品实付金额
      "term_finish_time": "${@$.subscription_expiration_time}", // 订阅失效截止时间（用于商品类型为 vip 和 coins_package，单位：秒）
      "mode": "${@$.status}", // 订单状态（processing: 处理中，success: 成功，failed: 失败，refunded: 已退款）
      "deal_moment": "${@$.payment_time}", // 支付时间（单位：秒）
      "deal_type": "${@$.payment_method}", // 支付方式（google: 谷歌内购，apple: 苹果内购）
      "defect_seed": "${@$.failed_reason}", // 订单失败原因
      "constructed_when": "${@$.created_at}" // 创建时间，时间戳秒
    }
  ]
}

示例值：

json5

{
  "sheet": 1,
  "script_volume": 10,
  "orders": [
    {
      "ticket_num": "",
      "interval_genre": "weekly",
      "gold_unit_tag": 1,
      "money_gross": 0,
      "reward_gross": 0,
      "added_good_marker": 2,
      "premium_grade": 0.5,
      "cargo_desc": "",
      "cargo_type": "gift_radio",
      "terminal_bill": 9.9,
      "term_finish_time": 1697059200,
      "mode": "success",
      "deal_moment": 1696972800,
      "deal_type": "google",
      "defect_seed": "",
      "constructed_when": 1696972800
    }
  ]
}

谷歌订阅恢复

Request
- Path: /mountainview/registry/restitution/:trace
- Method: post
- PathVariable：
  - trace：谷歌订单id

Response

Body

json5

{
  "trace": "${@body.transaction_id}", // 谷歌交易ID
  "identity_uuid": "${@body.user_id}", // 用户ID
  "door_ticket": "${@body.access_token}" // 恢复后的用户访问令牌
}

示例值：

json5

{
  "trace": "xxx",
  "identity_uuid": "xxxx",
  "door_ticket": "xxxx"
}

说明 ​

API列表 ​

获取页面布局(根据语言) ​

获取建议配置 ​

上报用户建议 ​

批量删除观看 ​

批量删除收藏 ​

获取用户某个短剧的收藏情况 ​

获取收藏记录 ​

获取用户某个短剧的观看情况 ​

获取观看记录 ​

获取短剧剧集 ​

获取用户推荐剧列表 ​

获取短剧详情 ​

获取短剧 ​

结束播放短剧 ​

开始播放短剧 ​

用户取消收藏短剧 ​

用户收藏短剧 ​

用户分享短剧 ​

获取年龄 ​

修改个人详情 ​

获取个人详情 ​

修改用户自动解锁配置 ​

获取会话 ​

获取指定语言的词典数据 ​

获取支持的语言列表 ​

获取首页短剧推送列表 ​

上报事件 ​

更新FCM访问令牌 ​

解锁剧集 ​

上报用户设备信息 ​

获取用户奖励记录 ​

获取用户解锁记录 ​

获取用户钱包 ​

内购创建订单V2 ​

获取所有上架商品V2 ​

未支付订单取消V2 ​

苹果订阅恢复 ​

获取订单列表V2 ​

谷歌订阅恢复 ​

说明

API列表

获取页面布局(根据语言)

获取建议配置

上报用户建议

批量删除观看

批量删除收藏

获取用户某个短剧的收藏情况

获取收藏记录

获取用户某个短剧的观看情况

获取观看记录

获取短剧剧集

获取用户推荐剧列表

获取短剧详情

获取短剧

结束播放短剧

开始播放短剧

用户取消收藏短剧

用户收藏短剧

用户分享短剧

获取年龄

修改个人详情

获取个人详情

修改用户自动解锁配置

获取会话

获取指定语言的词典数据

获取支持的语言列表

获取首页短剧推送列表

上报事件

更新FCM访问令牌

解锁剧集

上报用户设备信息

获取用户奖励记录

获取用户解锁记录

获取用户钱包

内购创建订单V2

获取所有上架商品V2

未支付订单取消V2

苹果订阅恢复

获取订单列表V2

谷歌订阅恢复