YesApi接口文档 | 果创云_数据库API_500+免费接口(原名:小白接口)

YesApi 接口文档

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Dsq_CcsIp/GetAndUpdateCssIp

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Dsq_CcsIp.GetAndUpdateCssIp

接口描述：按条件获取ip_address，use_num并更新use_num，保证多客户端并发调用

接口参数若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字	参数类型	是否必须	默认值	备注	参数说明
app_key	字符串	必须		最小：32	公共参数开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign	字符串	可选			公共参数接口签名，其中：使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。使用静态签名，点击获取我的静态签名关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。定制签名支持专属签名算法定制开发
uuid	字符串	必须			uuid
token	字符串	可选			公共参数当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data	字符串	可选	0		公共参数数据返回结构，其中： return_data=0，返回完整的接口结果，示例：`{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}`； return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：`{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}`。
num	整型	必须			获取数量
group_id	字符串	可选			非必须的获取条件，groupId
ip_type	字符串	可选			非必须的获取条件，ipType
country	字符串	可选			非必须的获取条件，country

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段	类型	说明
ret	整型	接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
data	object/array/混合	接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code	整型	0表示获取成功，1表示无数据，2表示有其他客户端调用
data.err_msg	字符串	获取信息
data.ipData	字符串	获取的数据
data.ipData[].id	整型	id
data.ipData[].ip_address	字符串	ip地址
data.ipData[].use_num	整型	更新前的use_num
msg	字符串	提示信息，面向技术人员的帮助或错误提示信息
_t	整数	服务器当时Unix时间戳，例如：1657513450
_auth	字符串	反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：`_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)`，若需要关闭或开启请提交工单