开启方法
数据接口默认是关闭状态,需要在网站后台,网站设置,安全中心,数据接口密钥,填写密钥并保存完成开启。调试方法
网站后台,系统维护,系统工具,标签模板,数据接口提供了图像化的调试界面。请求地址
电脑版:电脑版首页网址/api/json.php手机版:手机版首页网址/api/json.php
电脑版和手机版调用方法完全一致,唯一区别是返回的网址是电脑网址或手机网址
加密方法
GET参数需要加密,例如请求的地址为/api/json.php?moduleid=5&pagesize=30本文档为了方便说明,省略了实际网址,实际请求自行加上真实网址
1、加入客户端版本信息version,此时请求地址示例
/api/json.php?moduleid=5&pagesize=30&version=1.0.02、加入请求时间time,格式为Unix时间戳,此时请求地址示例
/api/json.php?moduleid=5&pagesize=30&version=1.0.0&time=17647334943、加入签名sign,此时请求地址示例
/api/json.php?moduleid=5&pagesize=30&version=1.0.0&time=1764733494&sign=cb14ef0180b783a54b183723054f6d63
签名sign生成方法
截取请求地址问号后面的参数至Unix时间戳,例如moduleid=5&pagesize=30&version=1.0.0&time=1764733494加入数据接口密钥key,例如
moduleid=5&pagesize=30&version=1.0.0&time=1764733494&key=nK94WQCHpLManQqZpAEbexvWDHmL34zP将上面的字符串md5得到的值即为sign的值
数据接口密钥key应保存在无法被直接访问的位置,以免泄露造成数据任意请求
如果服务器端修改了密钥,客户端无法及时更新,可以修改服务器端api/json/config.key.php,根据版本参数判断进行旧密钥的兼容
读取数据请求参数
moduleid代表模块ID,后台模块管理里可以看到模块和ID
pagesize
代表调用数据数量,可不传,默认与网站设置,服务器优化,列表每页默认信息条数一致,最大值为100
page
代表第几页,可不传,默认第一页
kw
代表关键词,可不传,返回与关键词匹配的信息
catid
代表分类ID,可不传,返回所属分类的信息
areaid
代表地区ID,可不传,返回所属地区的信息
itemid
代表信息ID,可不传,返回所属ID的信息,一般为1条
数据排序
可不传,默认按itemid降序排列
dsc
代表降序排列的字段,例如&dsc=addtime表示数据按添加时间降序(大到小)排列
asc
代表升序排列的字段,例如&asc=addtime表示数据按添加时间升序(小到大)排列
如果以上方法无法调用到需要的数据,可以尝试以下两种方法:
一、在后台系统维护,标签模板,标签向导,生成标签,然后点接口调用按钮,生成对应的标签调用接口
二、在api/json目录创建.inc.php文件自行二开对应的数据操作
特殊字段
file代表文件,例如&moduleid=3&file=webpage
当moduleid=1时,调用 api/json/{$file}.inc.php 文件,可自行开发
当file=module时,调用 api/json/module.inc.php 文件,输出系统模块信息
当file=area时,调用 api/json/area.inc.php 文件,输出系统地区信息
当file=category时,调用 api/json/category.inc.php 文件,输出系统分类信息
当moduleid=2时,调用会员模块 module/member/{$file}.class.php 文件的方法
当moduleid=3时,调用扩展模块 module/extend/{$file}.class.php 文件的方法
其他模块如果存在{$file}.class.php也会自动调用
action
代表动作,例如&moduleid=3&file=webpage&action=add
当调用.class.php文件时,action可以调用对应的函数
当action=add时,代表发布信息
当action=edit时,代表修改信息,默认不开启
当action=delete时,代表删除信息,默认不开启
当action=show时,代表显示单条信息,包括信息的内容
在api/json/common.api.php 删除对应的 dexit('方法未启用'); 手动启用edit和delete方法,此操作比较危险,如非特别需要,请勿开启。
写入请求参数
GET参数与上述一致,先确定moduleid,再根据情况选传file,然后确定action(默认只支持add增,edit改和delele删需手动开启),如果是改和删还应传入itemid(支持数组)
POST参数
根据需要写入目标的数据表字段或前后台发布信息界面表单,确定需要传入的参数名称
创建名为post的数组POST发送,例如:
post[title]=标题&post[content]=内容
也可以转为JSON格式直接通过body发送,例如:
{"title":"标题","content":"内容"}
其他说明
由于会员表比较特殊,不支持直接调用数据,并独立运行于 api/json/member.api.php当传入moduleid=2或moduleid=2&file=member时,自动调用此文件,支持以下action
register
注册新用户,需要POST发送注册表单数据
login
用户登录,需要POST发送户名和密码,验证成功返回包含会员ID的数据
sms
发送短信验证码,需要POST发送手机号码
其他方法可根据需要在此文件中二次开发
由于公司表比较特殊,独立运行于 api/json/company.api.php
当传入moduleid=4或moduleid=4&file=company时,自动调用此文件,支持以下action
show
需传入itemid,返回公司资料及公司介绍
默认
返回公司列表数据