API文档
接口接入指南
社区新增用户列表
社区新增用户统计
社区积分列表
社区新增用户统计
社区群聊信息查询
社区拉新排行
社区积分排行

分销接口接入指南

线上环境

http://60.191.90.117:9111

接口地址:/api/index

请求方式:POST

输入参数说明

参数默认采用x-www-form-urlencoded的形式编码。

采用json的编码格式

示例如下:

输出参数说明

采用json的编码格式

频率限制:单个接口一分钟的时间段内(开始时间任意)请求不能超过70次

sign(签名,签名的生成规则如下)

1)输入参数值(除sign外)参照字母排序拼接,拼接成key=value的字符串形式

2)首尾加上appSecret值

3)最后对上述值取32位大写MD5值

示例如下:

其他说明

1)渠道方从A部落获取测试环境appKey和appSecret,生产上线前获取生产环境的appKey和appSecret

2)appKey和appSecret, 通过A部落后台申请: http://abuluo.c.wanzqh.com

2.1)用社区账号登陆,申请方式【社区管理】=》【社区开发者】=》【添加】

DEMO下载

php DEMO

社区新增用户列表(new.user.batch.get)

功能描述

获取社区新增用户,相关接入说明参见

公共请求参数

参数名 参数类型 是否必填 说明
method string 方法名,不同接口传入相应的方法名(即文档标题括号中的英文方法名) 最大长度为固定值
appKey string 渠道的AppKey,A部落提供的渠道方标识 最大长度为固定值
sign string 渠道请求参数的签名串,详见签名。 最大长度为固定值
timestamp int 请求时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求 最大长度为固定值

API请求入参

参数名 参数类型 是否必填 说明
account string 社区用户账号
communityId int 社区id
page int 分页索引
pageSize int 分页大小

响应参数

参数名 类型 说明
errorCode int 状态码
errorInfo string 状态信息
data object 结果(errorCode为0的结果)

data参数

参数名 类型 说明
todayUserCount int 社区今日用户数
todayUserCount int 社区昨日用户数
totalUserCount int 社区总用户数
dataList list[object] 数据列表

dataList参数

参数名 类型 说明
account string 社区用户账号
name string 社区用户昵称
pic string 社区用户头像
parentAccount string 邀请人的账号
parentName string 邀请人的账号
createTime string 加入时间

请求示例(json)

响应示例(json)

社区新增用户统计(new.user.count.get)

功能描述

获取近七天数据,相关接入说明参见

公共请求参数

参数名 参数类型 是否必填 说明
method string 方法名,不同接口传入相应的方法名(即文档标题括号中的英文方法名) 最大长度为固定值
appKey string 渠道的AppKey,A部落提供的渠道方标识 最大长度为固定值
sign string 渠道请求参数的签名串,详见签名。 最大长度为固定值
timestamp int 请求时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求 最大长度为固定值

API请求入参

参数名 参数类型 是否必填 说明
account string 社区用户账号
communityId int 社区id

响应参数

参数名 类型 说明
errorCode int 状态码
errorInfo string 状态信息
data object 结果(errorCode为0的结果)

data参数

参数名 类型 说明
dataList list[object] 数据列表

dataList参数

参数名 类型 说明
Y-m-d string 社区用户数量

请求示例(json)

响应示例(json)

社区积分列表(integral.batch.get)

功能描述

获取社区积分明细列表,相关接入说明参见

公共请求参数

参数名 参数类型 是否必填 说明
method string 方法名,不同接口传入相应的方法名(即文档标题括号中的英文方法名) 最大长度为固定值
appKey string 渠道的AppKey,A部落提供的渠道方标识 最大长度为固定值
sign string 渠道请求参数的签名串,详见签名。 最大长度为固定值
timestamp int 请求时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求 最大长度为固定值

API请求入参

参数名 参数类型 是否必填 说明
account string 社区用户账号
communityId int 社区id
page int 分页索引
pageSize int 分页大小

响应参数

参数名 类型 说明
errorCode int 状态码
errorInfo string 状态信息
data object 结果(errorCode为0的结果)

data参数

参数名 类型 说明
todayIntegralTotal int 社区今日总积分
yesterdayIntegralTotal int 社区昨日总积分
totalIntegral int 社区总积分
dataList list[object] 数据列表

dataList参数

参数名 类型 说明
account string 社区用户账号
name string 社区用户昵称
integral string 社区用户积分
createTime string 创建时间

请求示例(json)

响应示例(json)

社区新增用户统计(integral.count.get)

功能描述

获取近七天数据,相关接入说明参见

公共请求参数

参数名 参数类型 是否必填 说明
method string 方法名,不同接口传入相应的方法名(即文档标题括号中的英文方法名) 最大长度为固定值
appKey string 渠道的AppKey,A部落提供的渠道方标识 最大长度为固定值
sign string 渠道请求参数的签名串,详见签名。 最大长度为固定值
timestamp int 请求时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求 最大长度为固定值

API请求入参

参数名 参数类型 是否必填 说明
account string 社区用户账号
communityId int 社区id

响应参数

参数名 类型 说明
errorCode int 状态码
errorInfo string 状态信息
data object 结果(errorCode为0的结果)

data参数

参数名 类型 说明
dataList list[object] 数据列表

dataList参数

参数名 类型 说明
Y-m-d string 社区用户数量

请求示例(json)

响应示例(json)

社区群聊信息查询(team.msg.batch.get)

功能描述

社区群聊信息查询,相关接入说明参见

公共请求参数

参数名 参数类型 是否必填 说明
method string 方法名,不同接口传入相应的方法名(即文档标题括号中的英文方法名) 最大长度为固定值
appKey string 渠道的AppKey,A部落提供的渠道方标识 最大长度为固定值
sign string 渠道请求参数的签名串,详见签名。 最大长度为固定值
timestamp int 请求时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求 最大长度为固定值

API请求入参

参数名 参数类型 是否必填 说明
account string 社区用户账号
communityId int 社区id
teamId string 社群id
loginName string 查询账号
page int 分页索引
pageSize int 分页大小

响应参数

参数名 类型 说明
errorCode int 状态码
errorInfo string 状态信息
data object 结果(errorCode为0的结果)

data参数

参数名 类型 说明
dataList list[object] 数据列表

dataList参数

参数名 类型 说明
createTime string 发送消息时间
type string 消息类型(文字或其他)
teamId string 社群id
teamName string 社群名称
content string 内容

请求示例(json)

响应示例(json)

社区拉新排行(user.rank.batch.get)

功能描述

社区拉新排行,相关接入说明参见

公共请求参数

参数名 参数类型 是否必填 说明
method string 方法名,不同接口传入相应的方法名(即文档标题括号中的英文方法名) 最大长度为固定值
appKey string 渠道的AppKey,A部落提供的渠道方标识 最大长度为固定值
sign string 渠道请求参数的签名串,详见签名。 最大长度为固定值
timestamp int 请求时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求 最大长度为固定值

API请求入参

参数名 参数类型 是否必填 说明
account string 社区用户账号
communityId int 社区id

响应参数

参数名 类型 说明
errorCode int 状态码
errorInfo string 状态信息
data object 结果(errorCode为0的结果)

data参数

参数名 类型 说明
dataList list[object] 数据列表

dataList参数

参数名 类型 说明
number int 拉新数量
name string 社区用户昵称
pic string 社区用户头像

请求示例(json)

响应示例(json)

社区积分排行(integral.bank.batch.get)

功能描述

社区拉新排行,相关接入说明参见

公共请求参数

参数名 参数类型 是否必填 说明
method string 方法名,不同接口传入相应的方法名(即文档标题括号中的英文方法名) 最大长度为固定值
appKey string 渠道的AppKey,A部落提供的渠道方标识 最大长度为固定值
sign string 渠道请求参数的签名串,详见签名。 最大长度为固定值
timestamp int 请求时间戳,采用yyyy-MM-dd HH:mm:ss的形式,前后5分钟内的请求为有效请求 最大长度为固定值

API请求入参

参数名 参数类型 是否必填 说明
account string 社区用户账号
communityId int 社区id

响应参数

参数名 类型 说明
errorCode int 状态码
errorInfo string 状态信息
data object 结果(errorCode为0的结果)

data参数

参数名 类型 说明
dataList list[object] 数据列表

dataList参数

参数名 类型 说明
number int 积分
name string 社区用户昵称
pic string 社区用户头像

请求示例(json)

响应示例(json)