中文
登录
后可查看全部文档
成长工具/短剧SDK/短剧-服务端接口/短剧信息/订单查询接口
短剧信息/订单查询接口
最近更新 2024-01-18 19:56:47

一、接口说明

  1. 建议使用短剧物料做页面渲染时(聚合页或者入口渲染等),采用实时获取的方式;
  2. 在接入前,请提供穿山甲应用id并联系穿山甲对接同学获取秘钥。

请求说明

  • 请求域名:https://csj-sp.csjdeveloper.com
  • 请求方式:POST
  • 数据格式:json
  • 公共请求头:

key

value

备注

Content-Type

application/json

请求json格式

x-csj-sp-site-id

5xxxxxx

在穿山甲平台申请的应用id,以5开头的7位数字

x-csj-sp-timestamp


请求时间戳,比如:1699361433

x-csj-sp-sign


签名,见签名部分

x-csj-sp-nonce


16位随机字符串,必须16位

x-csj-sp-version

1.0

固定值1.0

签名

使用HmacSHA256算法加密,秘钥为在穿山甲平台上申请应用后BD线下提供的信息,拼接规则,最后转为16进制。

复制

示例代码

golang

复制

PHP

复制

Python

复制

1、获取类目列表

path

/csj_sp/openapi/v1/shortplay/get_category

请求

http body格式为json

key

type

value

uid

int

用户在开发者侧唯一标志

请求示例

复制

响应

key

type

value

ret

int

0为成功,非0为失败,具体见msg

msg

string

非0错误码时,见该字段排查

request_id

string

请求唯一标志,排查问题时可以拿此作为凭证

data

object


data对象

key

type

value

list

object

类目数组

list对象

key

type

value

id

int

类目id

name

string

类目名称

level

int

类目级别1:一级类目;2:二级类目;

children

object

二级类目列表

返回示例

复制

2、获取短剧信息

path

/csj_sp/openapi/v1/shortplay/get_sp_list

请求

http body格式为json

key

type

value

uid

int

用户在开发者侧唯一标志

page_size

int

每页数量,默认为20

page

int

请求页码,从1开始,默认为1

order

int

请求顺序:0:正序;1:逆序

query_type

string

all:获取所有短剧

category:获取请求二级类目id短剧

shortplay:获取请求短剧id的短剧

shortplay_ids

[]int

短剧id列表,query_type为shortplay时必传,示例[1,2,3]

category_id

[]int

短剧id列表,query_type为category时必传,示例[1,2,3]

请求示例

复制

响应

key

type

value

ret

int

0为成功,非0为失败,具体见msg

msg

string

非0错误码时,见该字段排查

request_id

string

请求唯一标志,排查问题时可以拿此作为凭证

data

object


data对象

key

type

value

list

object

类目数组

total

int

总共短剧数

has_more

bool

是否还有短剧

list对象

key

type

value

shortplay_id

int

短剧id

title

string

短剧名称

desc

string

短剧简介

cover_image

string

短剧封面

category_id

int

短剧二级类目id

category_name

string

短剧二级类目名称

total

int

短剧的剧集数

create_time

int

短剧创建时间戳

status

int

完结状态. 0:已完结;1: 未完结

返回示例

复制

3、开发者订单查询

功能

获取当前应用下,对应时间/用户的订单信息列表

path

/csj_sp/openapi/v1/shortplay/order_list

请求

key

type

value

ouid

int

用户在开发者侧的ID

trade_time_start

int

查询交易发起时间的区间:trade_time_end>=交易发起时间>=trade_time_start

trade_time_end

int

同上

page_size

int

每页数量,默认为20

page

int

请求页码,从1开始,默认为1

响应

key

type

value

ret

int

0为成功,非0为失败,具体见msg

msg

string

非0错误码时,见该字段排查

request_id

string

请求唯一标志,排查问题时可以拿此作为凭证

data

object


data对象

key

type

value

list

object

订单列表

total

int

总共订单数

has_more

bool

是否还有订单

list对象

key

type

value

out_trade_no

string

外部订单号(媒体侧订单号)

media_uid

string

媒体侧用户Id

site_id

int

应用Id

trade_no

string

交易订单号

trade_status

int

交易状态1:待支付;2:支付成功待发放权益;3:交易成功4:交易关闭;5权益发放失败

trade_time

int

交易发生时间

trade_name

string

交易名称

trade_desc

string

交易描述

comb

object

套餐信息

comb对象

key

type

value

come_name

string

套餐名称

combo_type

int

套餐类型,1:会员;2:单部短剧;

shortplay_id

int

单部短剧购买时的短剧ID

membership_duration

int

会员购买时的会员周期,Day:1 Week:2 Month:3 Quarter:4 Year:5

payMethod

object

支付信息

payMethod对象

key

type

value

pay_type

int

目前只有1:财经;

amount

Int

支付金额,单位分

currency

币种

人民币:CNY

返回示例

复制


本篇目录
联系我们