接口路径(新):http://api.okayapi.com/api/SVIP/SID142374_MyApi/AXBRoleCreate
接口路径(旧):http://api.okayapi.com/?s=SVIP.SID142374_MyApi.AXBRoleCreate
接口描述: 增 在自定义数据表单中添加一个新数据,添加的字段应先在后台进行添加。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 表单名称(对应在小白开放平台创建时的数据库表名称),查看我的全部表单 | ||
model_uuid | 字符串 | 必须 | 最大:32 | 表单UUID,即对应表单数据里的uuid字段。分为三种情况: model_uuid为@NULL或未提供时(默认值):如model_uuid=@NULL,即不限制uuid,可匹配任意uuid,包括uuid为空和不为空的数据纪录; model_uuid为空字符串:为空字符串时,如model_uuid=,只匹配uuid为空字符串的数据纪录(即游客数据); model_uuid为具体的值:如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A,则进行精确匹配,只匹配与表单uuid相等的数据纪录。 | |
check_code | 字符串 | 可选 | 最大:64 | 待检测的口令,仅当在小白开放平台配置口令后才会对此参数进行检测,规则配置教程 | |
data | 字符串JSON格式 | 必须 | 创建时的初始化数据,需要JSON编码后传递。格式:data={"字段名1":"字段值1","字段名2":"字段值2"...}。数据中的uuid将优先于model_uuid参数。JSON在线解析及格式化验证(data和data_X二选一) | ||
data_X | 字符串 | 可选 | 动态参数,优先于data的JSON数据。可自由传入动态参数,字段名组合格式:data_ + X(X要换成你的字段名),例如数据表单标题title字段,组合后为:>data_title=YesApi,等效于:>data={"title":"YesApi"}。可以同时传入多个动态参数,例如:>data_title=YesApi>data_year=2020,比JSON格式更方便(data和data_X二选一) |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
null
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1创建失败(不符合表字段要求,或表字段不存在);2应用层规则拦截,拦截后可以小白开放平台查看日记 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.id | 整型 | 新创建数据的自增ID |
data.xbuser_role_uuid | 字符串 | 新创建角色的uuid |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://api.okayapi.com/api/SVIP/SID142374_MyApi/AXBTiKuCreate
接口路径(旧):http://api.okayapi.com/?s=SVIP.SID142374_MyApi.AXBTiKuCreate
接口描述: 按题目标题【非重复】新增题库
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 表单名称(对应在小白开放平台创建时的数据库表名称),查看我的全部表单 | ||
model_uuid | 字符串 | 可选 | 最大:32 | 表单UUID,即对应表单数据里的uuid字段。分为三种情况: model_uuid为@NULL或未提供时(默认值):如model_uuid=@NULL,即不限制uuid,可匹配任意uuid,包括uuid为空和不为空的数据纪录; model_uuid为空字符串:为空字符串时,如model_uuid=,只匹配uuid为空字符串的数据纪录(即游客数据); model_uuid为具体的值:如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A,则进行精确匹配,只匹配与表单uuid相等的数据纪录。 | |
check_code | 字符串 | 可选 | 最大:64 | 待检测的口令,仅当在小白开放平台配置口令后才会对此参数进行检测,规则配置教程 | |
data | 字符串JSON格式 | 可选 | 创建时的初始化数据,需要JSON编码后传递。格式:data={"字段名1":"字段值1","字段名2":"字段值2"...}。数据中的uuid将优先于model_uuid参数。JSON在线解析及格式化验证(data和data_X二选一) | ||
data_X | 字符串 | 可选 | 动态参数,优先于data的JSON数据。可自由传入动态参数,字段名组合格式:data_ + X(X要换成你的字段名),例如数据表单标题title字段,组合后为:>data_title=YesApi,等效于:>data={"title":"YesApi"}。可以同时传入多个动态参数,例如:>data_title=YesApi>data_year=2020,比JSON格式更方便(data和data_X二选一) | ||
check_field | 字符串用,分割 | 必须 | 待检测的字段。注意:data数据中必须包含此字段的数据,用作检测重复的依据。多个检测字段用英文逗号分割。例如:check_field=name,age,表示同时检测名字和年龄。请留意字段类型的相等性判断,如字符串类型的字段不能在data参数中传整型参数。 | ||
model_return_data | 布尔型 | 可选 | false | 是否返回新创建或原来的数据,model_return_data=1 返回,model_return_data=0 不返回 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
null
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1创建失败(不符合表字段要求,或表字段不存在);2应用层规则拦截,拦截后可以小白开放平台查看日记;3、数据已存在,不再创建 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.id | 整型 | 新创建数据的自增ID或原来数据的ID |
data.data | 对象 | 新创建或原来的数据,全部字段返回。默认不返回,model_return_data=1才返回。 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://api.okayapi.com/api/SVIP/SID142374_MyApi/ACyCreateOrUpdate
接口路径(旧):http://api.okayapi.com/?s=SVIP.SID142374_MyApi.ACyCreateOrUpdate
接口描述: 增改非重复 在自定义数据表单中尝试添加一个【非重复】新数据,如果数据已经存在,则进行更新操作。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 表单名称(对应在小白开放平台创建时的数据库表名称),查看我的全部表单 | ||
model_uuid | 字符串 | 可选 | 最大:32 | 表单UUID,即对应表单数据里的uuid字段。分为三种情况: model_uuid为@NULL或未提供时(默认值):如model_uuid=@NULL,即不限制uuid,可匹配任意uuid,包括uuid为空和不为空的数据纪录; model_uuid为空字符串:为空字符串时,如model_uuid=,只匹配uuid为空字符串的数据纪录(即游客数据); model_uuid为具体的值:如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A,则进行精确匹配,只匹配与表单uuid相等的数据纪录。 | |
check_code | 字符串 | 可选 | 最大:64 | 待检测的口令,仅当在小白开放平台配置口令后才会对此参数进行检测,规则配置教程 | |
data | 字符串JSON格式 | 可选 | 创建时的初始化数据,需要JSON编码后传递。格式:data={"字段名1":"字段值1","字段名2":"字段值2"...}。数据中的uuid将优先于model_uuid参数。JSON在线解析及格式化验证(data和data_X二选一) | ||
data_X | 字符串 | 可选 | 动态参数,优先于data的JSON数据。可自由传入动态参数,字段名组合格式:data_ + X(X要换成你的字段名),例如数据表单标题title字段,组合后为:>data_title=YesApi,等效于:>data={"title":"YesApi"}。可以同时传入多个动态参数,例如:>data_title=YesApi>data_year=2020,比JSON格式更方便(data和data_X二选一) | ||
check_field | 字符串用,分割 | 必须 | 待检测的字段。注意:data数据中必须包含待检测的全部字段。即check_field可指定data数据中的一个或多个字段。多个检测字段用英文逗号分割。例如:check_field=name,age,表示同时检测名字和年龄。请留意字段类型的相等性判断,如字符串类型的字段不能在data参数中传整型参数。 | ||
logic | 字符串 | 可选 | and | 多个check_field的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
null
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1创建失败(不符合表字段要求,或表字段不存在);2应用层规则拦截,拦截后可以小白开放平台查看日记; |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.id | 整型 | 新创建数据的自增ID或原来数据的ID |
data.op_type | 字符串 | 本次操作的具体类型,insert为插入,update为更新 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://api.okayapi.com/api/SVIP/SID142374_MyApi/AXBPromptGet
接口路径(旧):http://api.okayapi.com/?s=SVIP.SID142374_MyApi.AXBPromptGet
接口描述: 查 根据ID,获取自定义数据表单中的数据
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 表单名称(对应在小白开放平台创建时的数据库表名称),查看我的全部表单 | ||
model_uuid | 字符串 | 可选 | 最大:32 | 表单UUID,即对应表单数据里的uuid字段。分为三种情况: model_uuid为@NULL或未提供时(默认值):如model_uuid=@NULL,即不限制uuid,可匹配任意uuid,包括uuid为空和不为空的数据纪录; model_uuid为空字符串:为空字符串时,如model_uuid=,只匹配uuid为空字符串的数据纪录(即游客数据); model_uuid为具体的值:如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A,则进行精确匹配,只匹配与表单uuid相等的数据纪录。 | |
check_code | 字符串 | 可选 | 最大:64 | 待检测的口令,仅当在小白开放平台配置口令后才会对此参数进行检测,规则配置教程 | |
id | 整型 | 必须 | 最小:1 | 数据ID,例如:1,2,3,…… |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
null
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,获取失败(符合表字段要求,或表字段不存在);2应用层规则拦截,拦截后可以小白开放平台查看日记;3获取失败(数据已删除或不存在) |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.data | 对象 | 获取的数据,并返回全部字段的数据 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://api.okayapi.com/api/SVIP/SID142374_MyApi/AXBUserRole
接口路径(旧):http://api.okayapi.com/?s=SVIP.SID142374_MyApi.AXBUserRole
接口描述: 【学霸】获取用户所有角色列表
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 表单名称(对应在小白开放平台创建时的数据库表名称),查看我的全部表单 | ||
model_uuid | 字符串 | 可选 | 最大:32 | 表单UUID,即对应表单数据里的uuid字段。分为三种情况: model_uuid为@NULL或未提供时(默认值):如model_uuid=@NULL,即不限制uuid,可匹配任意uuid,包括uuid为空和不为空的数据纪录; model_uuid为空字符串:为空字符串时,如model_uuid=,只匹配uuid为空字符串的数据纪录(即游客数据); model_uuid为具体的值:如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A,则进行精确匹配,只匹配与表单uuid相等的数据纪录。 | |
check_code | 字符串 | 可选 | 最大:64 | 待检测的口令,仅当在小白开放平台配置口令后才会对此参数进行检测,规则配置教程 | |
select | 字符串用,分割 | 可选 | SQL语句的SELECT部分,多个字段用英文逗号分割,如:select=id,uuid | ||
logic | 字符串 | 可选 | and | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 | |
where | 字符串JSON格式 | 可选 | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中: 字段名:表单结构中存在的字段,或表字段 比较符:比较符号可以是>gt;、>gt;=、>lt;、>lt;=、>lt;>gt;、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值:需要比较的值,不同比较符的比较值格式会有所不同。如果字段是数值类型,请传递数值类型,不要用字符串。 示例:当logic=and, where=[["id",">gt;",9],["id",">lt;=",10]],则表示:id >gt; 9 AND id >lt;= 10。 写法2(Beta):每一组的条件格式可以为:MySQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求: 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用,并且使用静态参数,开启接口签名,以防SQL注入攻击 示例:当logic=and, where=["id >gt; 9", "id >lt;= 10"],则表示:id >gt; 9 AND id >lt;= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入,请用写法1;如果需要更强大的条件组合,并且是固定参数条件时,可用写法2。更多示例说明请参考WHERE参数介绍。 | ||
where_uuid | 字符串 | 可选 | 动态条件,优先于where的JSON数据,简化的where条件,更易使用但只支持部分比较符。条件格式:where_ + X(X要换成你的字段名) = 比较符(见下方) + 中横线(-) + 比较值。支持的比较符和示例如下: EQ:等于(默认),如:where_year=EQ-2020,或:where_year=2020,表示年份year等于2020; GT:大于,如:where_year=GT-2020,表示年份year大于2020; GE:大于等于,如:where_year=GE-2020,表示年份year大于或等于2020; LT:小于,如:where_year=LT-2020,表示年份year小于2020; LE:大于等于,如:where_year=LE-2020,表示年份year小于或等于2020; NE:不等于,如:where_year=NE-2020,表示年份year不等于2020; LIKE:模糊匹配,如:where_name=LIKE-小白,表示名字name含有小白的; NLIKE:模糊匹配(排除),如:where_name=NLIKE-小白,表示名字name不包含小白的 IN:枚举查询,如:where_year=IN-2020,2021,2022,表示年份year在这三个年份,多个值用英文逗号分割 NIN:枚举查询(排除),如:where_year=NIN-2020,2021,2022,表示年份year不在这三个年份,多个值用英文逗号分割 如果同一字段有多个条件,使用双竖线||分割,如:where_year=GT-2000||LT-2020,表示year年份大于2020(logic=and或logic=or)小于2020。(where和where_X二选一,不可混用,以where_X优先) | ||
order | 字符串JSON格式 | 可选 | SQL语句的ORDER部分,JSON格式。具体格式为:[第一组排序,第二组排序,……],可以单个或组合排序。每一组排序格式为:"字段名 + 空格 + ASC|DESC",其中:ASC:为指定列按升序排列DESC:为指定列按降序排列。例1:单个排序,order=["id DESC"],表示按ID降序,即最新的在最前面。例2:组合排序,order=["id DESC", "add_time ASC"],表示id DESC, add_time ASC,即先按ID从大到小,再按创建时间倒序排序。特别地,RAND表示随机排序,请慎用。 | ||
page | 整型 | 可选 | 1 | 最小:1 | 第几页 |
perpage | 整型 | 可选 | 10 | 最小:1;最大:10000 | 分页数量 |
is_real_total | 布尔型 | 可选 | true | 是否需要真正的总数,1是0否,当表单数据过多时,如果不需要查询真正的总数,将能极大提升接口响应的速度。若为假总数,固定返回9999999。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
null
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,查询失败(表单不存在或查询错误);2应用层规则拦截,拦截后可以小白开放平台查看日记 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.total | 整型 | 数据的总条目数量 |
data.list | 字符串 | 查询的结果列表数据 |
data.page | 整型 | 当前第几页 |
data.perpage | 整型 | 当前分页数量 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://api.okayapi.com/api/SVIP/SID142374_MyApi/ACyCiKu
接口路径(旧):http://api.okayapi.com/?s=SVIP.SID142374_MyApi.ACyCiKu
接口描述: 查 分页获取列表数据或全部数据,支持字段选择、排序、条件查询,功能强大,是最为常用的数据接口。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 表单名称(对应在小白开放平台创建时的数据库表名称),查看我的全部表单 | ||
model_uuid | 字符串 | 可选 | 最大:32 | 表单UUID,即对应表单数据里的uuid字段。分为三种情况: model_uuid为@NULL或未提供时(默认值):如model_uuid=@NULL,即不限制uuid,可匹配任意uuid,包括uuid为空和不为空的数据纪录; model_uuid为空字符串:为空字符串时,如model_uuid=,只匹配uuid为空字符串的数据纪录(即游客数据); model_uuid为具体的值:如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A,则进行精确匹配,只匹配与表单uuid相等的数据纪录。 | |
check_code | 字符串 | 可选 | 最大:64 | 待检测的口令,仅当在小白开放平台配置口令后才会对此参数进行检测,规则配置教程 | |
select | 字符串用,分割 | 可选 | SQL语句的SELECT部分,多个字段用英文逗号分割,如:select=id,uuid | ||
logic | 字符串 | 可选 | and | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 | |
where | 字符串JSON格式 | 可选 | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中: 字段名:表单结构中存在的字段,或表字段 比较符:比较符号可以是>gt;、>gt;=、>lt;、>lt;=、>lt;>gt;、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值:需要比较的值,不同比较符的比较值格式会有所不同。如果字段是数值类型,请传递数值类型,不要用字符串。 示例:当logic=and, where=[["id",">gt;",9],["id",">lt;=",10]],则表示:id >gt; 9 AND id >lt;= 10。 写法2(Beta):每一组的条件格式可以为:MySQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求: 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用,并且使用静态参数,开启接口签名,以防SQL注入攻击 示例:当logic=and, where=["id >gt; 9", "id >lt;= 10"],则表示:id >gt; 9 AND id >lt;= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入,请用写法1;如果需要更强大的条件组合,并且是固定参数条件时,可用写法2。更多示例说明请参考WHERE参数介绍。 | ||
where_chengyu_difficulty | 字符串 | 可选 | 动态条件,优先于where的JSON数据,简化的where条件,更易使用但只支持部分比较符。条件格式:where_ + X(X要换成你的字段名) = 比较符(见下方) + 中横线(-) + 比较值。支持的比较符和示例如下: EQ:等于(默认),如:where_year=EQ-2020,或:where_year=2020,表示年份year等于2020; GT:大于,如:where_year=GT-2020,表示年份year大于2020; GE:大于等于,如:where_year=GE-2020,表示年份year大于或等于2020; LT:小于,如:where_year=LT-2020,表示年份year小于2020; LE:大于等于,如:where_year=LE-2020,表示年份year小于或等于2020; NE:不等于,如:where_year=NE-2020,表示年份year不等于2020; LIKE:模糊匹配,如:where_name=LIKE-小白,表示名字name含有小白的; NLIKE:模糊匹配(排除),如:where_name=NLIKE-小白,表示名字name不包含小白的 IN:枚举查询,如:where_year=IN-2020,2021,2022,表示年份year在这三个年份,多个值用英文逗号分割 NIN:枚举查询(排除),如:where_year=NIN-2020,2021,2022,表示年份year不在这三个年份,多个值用英文逗号分割 如果同一字段有多个条件,使用双竖线||分割,如:where_year=GT-2000||LT-2020,表示year年份大于2020(logic=and或logic=or)小于2020。(where和where_X二选一,不可混用,以where_X优先) | ||
order | 字符串JSON格式 | 可选 | SQL语句的ORDER部分,JSON格式。具体格式为:[第一组排序,第二组排序,……],可以单个或组合排序。每一组排序格式为:"字段名 + 空格 + ASC|DESC",其中:ASC:为指定列按升序排列DESC:为指定列按降序排列。例1:单个排序,order=["id DESC"],表示按ID降序,即最新的在最前面。例2:组合排序,order=["id DESC", "add_time ASC"],表示id DESC, add_time ASC,即先按ID从大到小,再按创建时间倒序排序。特别地,RAND表示随机排序,请慎用。 | ||
page | 整型 | 可选 | 1 | 最小:1 | 第几页 |
perpage | 整型 | 可选 | 10 | 最小:1;最大:10000 | 分页数量 |
is_real_total | 布尔型 | 可选 | true | 是否需要真正的总数,1是0否,当表单数据过多时,如果不需要查询真正的总数,将能极大提升接口响应的速度。若为假总数,固定返回9999999。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
null
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,查询失败(表单不存在或查询错误);2应用层规则拦截,拦截后可以小白开放平台查看日记 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.total | 整型 | 数据的总条目数量 |
data.list | 字符串 | 查询的结果列表数据 |
data.page | 整型 | 当前第几页 |
data.perpage | 整型 | 当前分页数量 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://api.okayapi.com/api/SVIP/SID142374_MyApi/ACyDuanwei
接口路径(旧):http://api.okayapi.com/?s=SVIP.SID142374_MyApi.ACyDuanwei
接口描述: 查 分页获取列表数据或全部数据,支持字段选择、排序、条件查询,功能强大,是最为常用的数据接口。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 表单名称(对应在小白开放平台创建时的数据库表名称),查看我的全部表单 | ||
model_uuid | 字符串 | 可选 | 最大:32 | 表单UUID,即对应表单数据里的uuid字段。分为三种情况: model_uuid为@NULL或未提供时(默认值):如model_uuid=@NULL,即不限制uuid,可匹配任意uuid,包括uuid为空和不为空的数据纪录; model_uuid为空字符串:为空字符串时,如model_uuid=,只匹配uuid为空字符串的数据纪录(即游客数据); model_uuid为具体的值:如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A,则进行精确匹配,只匹配与表单uuid相等的数据纪录。 | |
check_code | 字符串 | 可选 | 最大:64 | 待检测的口令,仅当在小白开放平台配置口令后才会对此参数进行检测,规则配置教程 | |
select | 字符串用,分割 | 可选 | SQL语句的SELECT部分,多个字段用英文逗号分割,如:select=id,uuid | ||
logic | 字符串 | 可选 | and | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 | |
where | 字符串JSON格式 | 可选 | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中: 字段名:表单结构中存在的字段,或表字段 比较符:比较符号可以是>gt;、>gt;=、>lt;、>lt;=、>lt;>gt;、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值:需要比较的值,不同比较符的比较值格式会有所不同。如果字段是数值类型,请传递数值类型,不要用字符串。 示例:当logic=and, where=[["id",">gt;",9],["id",">lt;=",10]],则表示:id >gt; 9 AND id >lt;= 10。 写法2(Beta):每一组的条件格式可以为:MySQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求: 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用,并且使用静态参数,开启接口签名,以防SQL注入攻击 示例:当logic=and, where=["id >gt; 9", "id >lt;= 10"],则表示:id >gt; 9 AND id >lt;= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入,请用写法1;如果需要更强大的条件组合,并且是固定参数条件时,可用写法2。更多示例说明请参考WHERE参数介绍。 | ||
where_dwjifen | 字符串 | 可选 | 动态条件,优先于where的JSON数据,简化的where条件,更易使用但只支持部分比较符。条件格式:where_ + X(X要换成你的字段名) = 比较符(见下方) + 中横线(-) + 比较值。支持的比较符和示例如下: EQ:等于(默认),如:where_year=EQ-2020,或:where_year=2020,表示年份year等于2020; GT:大于,如:where_year=GT-2020,表示年份year大于2020; GE:大于等于,如:where_year=GE-2020,表示年份year大于或等于2020; LT:小于,如:where_year=LT-2020,表示年份year小于2020; LE:大于等于,如:where_year=LE-2020,表示年份year小于或等于2020; NE:不等于,如:where_year=NE-2020,表示年份year不等于2020; LIKE:模糊匹配,如:where_name=LIKE-小白,表示名字name含有小白的; NLIKE:模糊匹配(排除),如:where_name=NLIKE-小白,表示名字name不包含小白的 IN:枚举查询,如:where_year=IN-2020,2021,2022,表示年份year在这三个年份,多个值用英文逗号分割 NIN:枚举查询(排除),如:where_year=NIN-2020,2021,2022,表示年份year不在这三个年份,多个值用英文逗号分割 如果同一字段有多个条件,使用双竖线||分割,如:where_year=GT-2000||LT-2020,表示year年份大于2020(logic=and或logic=or)小于2020。(where和where_X二选一,不可混用,以where_X优先) | ||
order | 字符串JSON格式 | 可选 | SQL语句的ORDER部分,JSON格式。具体格式为:[第一组排序,第二组排序,……],可以单个或组合排序。每一组排序格式为:"字段名 + 空格 + ASC|DESC",其中:ASC:为指定列按升序排列DESC:为指定列按降序排列。例1:单个排序,order=["id DESC"],表示按ID降序,即最新的在最前面。例2:组合排序,order=["id DESC", "add_time ASC"],表示id DESC, add_time ASC,即先按ID从大到小,再按创建时间倒序排序。特别地,RAND表示随机排序,请慎用。 | ||
page | 整型 | 可选 | 1 | 最小:1 | 第几页 |
perpage | 整型 | 可选 | 10 | 最小:1;最大:10000 | 分页数量 |
is_real_total | 布尔型 | 可选 | true | 是否需要真正的总数,1是0否,当表单数据过多时,如果不需要查询真正的总数,将能极大提升接口响应的速度。若为假总数,固定返回9999999。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
null
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,查询失败(表单不存在或查询错误);2应用层规则拦截,拦截后可以小白开放平台查看日记 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.total | 整型 | 数据的总条目数量 |
data.list | 字符串 | 查询的结果列表数据 |
data.page | 整型 | 当前第几页 |
data.perpage | 整型 | 当前分页数量 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://api.okayapi.com/api/SVIP/SID142374_MyApi/AXBChangeIQ
接口路径(旧):http://api.okayapi.com/?s=SVIP.SID142374_MyApi.AXBChangeIQ
接口描述: 改 可以根据自定义的多个条件(AND或者OR),修改某个或多个字段的数值,可增加或可减少。通过在服务端进行数值的叠加,尽量保持并发下的数据一致性。注意,此接口可更新多条数据。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 表单名称(对应在小白开放平台创建时的数据库表名称),查看我的全部表单 | ||
model_uuid | 字符串 | 可选 | 最大:32 | 表单UUID,即对应表单数据里的uuid字段。分为三种情况: model_uuid为@NULL或未提供时(默认值):如model_uuid=@NULL,即不限制uuid,可匹配任意uuid,包括uuid为空和不为空的数据纪录; model_uuid为空字符串:为空字符串时,如model_uuid=,只匹配uuid为空字符串的数据纪录(即游客数据); model_uuid为具体的值:如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A,则进行精确匹配,只匹配与表单uuid相等的数据纪录。 | |
check_code | 字符串 | 可选 | 最大:64 | 待检测的口令,仅当在小白开放平台配置口令后才会对此参数进行检测,规则配置教程 | |
logic | 字符串 | 可选 | and | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 | |
where | 字符串JSON格式 | 可选 | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中: 字段名:表单结构中存在的字段,或表字段 比较符:比较符号可以是>gt;、>gt;=、>lt;、>lt;=、>lt;>gt;、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值:需要比较的值,不同比较符的比较值格式会有所不同。如果字段是数值类型,请传递数值类型,不要用字符串。 示例:当logic=and, where=[["id",">gt;",9],["id",">lt;=",10]],则表示:id >gt; 9 AND id >lt;= 10。 写法2(Beta):每一组的条件格式可以为:MySQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求: 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用,并且使用静态参数,开启接口签名,以防SQL注入攻击 示例:当logic=and, where=["id >gt; 9", "id >lt;= 10"],则表示:id >gt; 9 AND id >lt;= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入,请用写法1;如果需要更强大的条件组合,并且是固定参数条件时,可用写法2。更多示例说明请参考WHERE参数介绍。 | ||
where_X | 字符串 | 可选 | 动态条件,优先于where的JSON数据,简化的where条件,更易使用但只支持部分比较符。条件格式:where_ + X(X要换成你的字段名) = 比较符(见下方) + 中横线(-) + 比较值。支持的比较符和示例如下: EQ:等于(默认),如:where_year=EQ-2020,或:where_year=2020,表示年份year等于2020; GT:大于,如:where_year=GT-2020,表示年份year大于2020; GE:大于等于,如:where_year=GE-2020,表示年份year大于或等于2020; LT:小于,如:where_year=LT-2020,表示年份year小于2020; LE:大于等于,如:where_year=LE-2020,表示年份year小于或等于2020; NE:不等于,如:where_year=NE-2020,表示年份year不等于2020; LIKE:模糊匹配,如:where_name=LIKE-小白,表示名字name含有小白的; NLIKE:模糊匹配(排除),如:where_name=NLIKE-小白,表示名字name不包含小白的 IN:枚举查询,如:where_year=IN-2020,2021,2022,表示年份year在这三个年份,多个值用英文逗号分割 NIN:枚举查询(排除),如:where_year=NIN-2020,2021,2022,表示年份year不在这三个年份,多个值用英文逗号分割 如果同一字段有多个条件,使用双竖线||分割,如:where_year=GT-2000||LT-2020,表示year年份大于2020(logic=and或logic=or)小于2020。(where和where_X二选一,不可混用,以where_X优先) | ||
change_field | 字符串用,分割 | 必须 | 待修改数值的字段名,多个字段名用英文逗号分割。change_value和change_field分割后的数量应当相同。 | ||
change_value | 字符串用,分割 | 必须 | 待叠加的数值,正数表示相加,负数表示相减,需要传递有效数值。多个数值用英文逗号分割。change_value和change_field分割后的数量应当相同。 | ||
try_add_data | 字符串JSON格式 | 可选 | 当无更新时尝试创建的数据,仅当无更新且有传此参数时才会进行数据创建。此参数可用于初始化等操作。此参数只用于初始化,不会再进行change_value的修改。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
null
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,修改失败(表单不存在或字段类型不是数值类型);2应用层规则拦截,拦截后可以小白开放平台查看日记 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.change_value | 字符串 | 回传客户端本次待更改的数值 |
data.details[].update_rows | 整型 | 本次的更新结果,对应更新的条目数量。没有更新或没有创建时为0,如果进行更新或初始化创建则为1,其他情况为对应更新的条目数量 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://api.okayapi.com/api/SVIP/SID142374_MyApi/ACyUpDataUser
接口路径(旧):http://api.okayapi.com/?s=SVIP.SID142374_MyApi.ACyUpDataUser
接口描述: 改 可以根据自定义的多个条件(AND或者OR),修改某个或多个字段的数值,可增加或可减少。通过在服务端进行数值的叠加,尽量保持并发下的数据一致性。注意,此接口可更新多条数据。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 表单名称(对应在小白开放平台创建时的数据库表名称),查看我的全部表单 | ||
model_uuid | 字符串 | 可选 | 最大:32 | 表单UUID,即对应表单数据里的uuid字段。分为三种情况: model_uuid为@NULL或未提供时(默认值):如model_uuid=@NULL,即不限制uuid,可匹配任意uuid,包括uuid为空和不为空的数据纪录; model_uuid为空字符串:为空字符串时,如model_uuid=,只匹配uuid为空字符串的数据纪录(即游客数据); model_uuid为具体的值:如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A,则进行精确匹配,只匹配与表单uuid相等的数据纪录。 | |
check_code | 字符串 | 可选 | 最大:64 | 待检测的口令,仅当在小白开放平台配置口令后才会对此参数进行检测,规则配置教程 | |
logic | 字符串 | 可选 | and | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 | |
where | 字符串JSON格式 | 可选 | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中: 字段名:表单结构中存在的字段,或表字段 比较符:比较符号可以是>gt;、>gt;=、>lt;、>lt;=、>lt;>gt;、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值:需要比较的值,不同比较符的比较值格式会有所不同。如果字段是数值类型,请传递数值类型,不要用字符串。 示例:当logic=and, where=[["id",">gt;",9],["id",">lt;=",10]],则表示:id >gt; 9 AND id >lt;= 10。 写法2(Beta):每一组的条件格式可以为:MySQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求: 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用,并且使用静态参数,开启接口签名,以防SQL注入攻击 示例:当logic=and, where=["id >gt; 9", "id >lt;= 10"],则表示:id >gt; 9 AND id >lt;= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入,请用写法1;如果需要更强大的条件组合,并且是固定参数条件时,可用写法2。更多示例说明请参考WHERE参数介绍。 | ||
where_X | 字符串 | 可选 | 动态条件,优先于where的JSON数据,简化的where条件,更易使用但只支持部分比较符。条件格式:where_ + X(X要换成你的字段名) = 比较符(见下方) + 中横线(-) + 比较值。支持的比较符和示例如下: EQ:等于(默认),如:where_year=EQ-2020,或:where_year=2020,表示年份year等于2020; GT:大于,如:where_year=GT-2020,表示年份year大于2020; GE:大于等于,如:where_year=GE-2020,表示年份year大于或等于2020; LT:小于,如:where_year=LT-2020,表示年份year小于2020; LE:大于等于,如:where_year=LE-2020,表示年份year小于或等于2020; NE:不等于,如:where_year=NE-2020,表示年份year不等于2020; LIKE:模糊匹配,如:where_name=LIKE-小白,表示名字name含有小白的; NLIKE:模糊匹配(排除),如:where_name=NLIKE-小白,表示名字name不包含小白的 IN:枚举查询,如:where_year=IN-2020,2021,2022,表示年份year在这三个年份,多个值用英文逗号分割 NIN:枚举查询(排除),如:where_year=NIN-2020,2021,2022,表示年份year不在这三个年份,多个值用英文逗号分割 如果同一字段有多个条件,使用双竖线||分割,如:where_year=GT-2000||LT-2020,表示year年份大于2020(logic=and或logic=or)小于2020。(where和where_X二选一,不可混用,以where_X优先) | ||
change_field | 字符串用,分割 | 必须 | 待修改数值的字段名,多个字段名用英文逗号分割。change_value和change_field分割后的数量应当相同。 | ||
change_value | 字符串用,分割 | 必须 | 待叠加的数值,正数表示相加,负数表示相减,需要传递有效数值。多个数值用英文逗号分割。change_value和change_field分割后的数量应当相同。 | ||
try_add_data | 字符串JSON格式 | 可选 | 当无更新时尝试创建的数据,仅当无更新且有传此参数时才会进行数据创建。此参数可用于初始化等操作。此参数只用于初始化,不会再进行change_value的修改。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
null
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,修改失败(表单不存在或字段类型不是数值类型);2应用层规则拦截,拦截后可以小白开放平台查看日记 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.change_value | 字符串 | 回传客户端本次待更改的数值 |
data.details[].update_rows | 整型 | 本次的更新结果,对应更新的条目数量。没有更新或没有创建时为0,如果进行更新或初始化创建则为1,其他情况为对应更新的条目数量 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://api.okayapi.com/api/SVIP/SID142374_MyApi/ACyFindUserInfo
接口路径(旧):http://api.okayapi.com/?s=SVIP.SID142374_MyApi.ACyFindUserInfo
接口描述: 查 可以根据自定义的多个条件(AND或者OR),查找获取一条数据
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 表单名称(对应在小白开放平台创建时的数据库表名称),查看我的全部表单 | ||
model_uuid | 字符串 | 可选 | 最大:32 | 表单UUID,即对应表单数据里的uuid字段。分为三种情况: model_uuid为@NULL或未提供时(默认值):如model_uuid=@NULL,即不限制uuid,可匹配任意uuid,包括uuid为空和不为空的数据纪录; model_uuid为空字符串:为空字符串时,如model_uuid=,只匹配uuid为空字符串的数据纪录(即游客数据); model_uuid为具体的值:如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A,则进行精确匹配,只匹配与表单uuid相等的数据纪录。 | |
check_code | 字符串 | 可选 | 最大:64 | 待检测的口令,仅当在小白开放平台配置口令后才会对此参数进行检测,规则配置教程 | |
logic | 字符串 | 可选 | and | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 | |
where | 字符串JSON格式 | 可选 | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中: 字段名:表单结构中存在的字段,或表字段 比较符:比较符号可以是>gt;、>gt;=、>lt;、>lt;=、>lt;>gt;、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值:需要比较的值,不同比较符的比较值格式会有所不同。如果字段是数值类型,请传递数值类型,不要用字符串。 示例:当logic=and, where=[["id",">gt;",9],["id",">lt;=",10]],则表示:id >gt; 9 AND id >lt;= 10。 写法2(Beta):每一组的条件格式可以为:MySQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求: 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用,并且使用静态参数,开启接口签名,以防SQL注入攻击 示例:当logic=and, where=["id >gt; 9", "id >lt;= 10"],则表示:id >gt; 9 AND id >lt;= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入,请用写法1;如果需要更强大的条件组合,并且是固定参数条件时,可用写法2。更多示例说明请参考WHERE参数介绍。 | ||
where_uuid | 字符串 | 可选 | 动态条件,优先于where的JSON数据,简化的where条件,更易使用但只支持部分比较符。条件格式:where_ + X(X要换成你的字段名) = 比较符(见下方) + 中横线(-) + 比较值。支持的比较符和示例如下: EQ:等于(默认),如:where_year=EQ-2020,或:where_year=2020,表示年份year等于2020; GT:大于,如:where_year=GT-2020,表示年份year大于2020; GE:大于等于,如:where_year=GE-2020,表示年份year大于或等于2020; LT:小于,如:where_year=LT-2020,表示年份year小于2020; LE:大于等于,如:where_year=LE-2020,表示年份year小于或等于2020; NE:不等于,如:where_year=NE-2020,表示年份year不等于2020; LIKE:模糊匹配,如:where_name=LIKE-小白,表示名字name含有小白的; NLIKE:模糊匹配(排除),如:where_name=NLIKE-小白,表示名字name不包含小白的 IN:枚举查询,如:where_year=IN-2020,2021,2022,表示年份year在这三个年份,多个值用英文逗号分割 NIN:枚举查询(排除),如:where_year=NIN-2020,2021,2022,表示年份year不在这三个年份,多个值用英文逗号分割 如果同一字段有多个条件,使用双竖线||分割,如:where_year=GT-2000||LT-2020,表示year年份大于2020(logic=and或logic=or)小于2020。(where和where_X二选一,不可混用,以where_X优先) | ||
fields | 字符串用,分割 | 可选 | 需要返回的字段名,多个字段用英文逗号分割,示例:fields=id,uuid,add_time |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
null
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,获取失败(表单不存在);2应用层规则拦截,拦截后可以小白开放平台查看日记;3查无数据 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.data | 对象 | 获取的数据,可以指定返回字段 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://api.okayapi.com/api/SVIP/SID142374_MyApi/AXBFreeOne
接口路径(旧):http://api.okayapi.com/?s=SVIP.SID142374_MyApi.AXBFreeOne
接口描述: 查 可以根据自定义的多个条件(AND或者OR),随机获取一条数据。获取数据后不会修改或删除数据。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 表单名称(对应在小白开放平台创建时的数据库表名称),查看我的全部表单 | ||
model_uuid | 字符串 | 可选 | 最大:32 | 表单UUID,即对应表单数据里的uuid字段。分为三种情况: model_uuid为@NULL或未提供时(默认值):如model_uuid=@NULL,即不限制uuid,可匹配任意uuid,包括uuid为空和不为空的数据纪录; model_uuid为空字符串:为空字符串时,如model_uuid=,只匹配uuid为空字符串的数据纪录(即游客数据); model_uuid为具体的值:如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A,则进行精确匹配,只匹配与表单uuid相等的数据纪录。 | |
check_code | 字符串 | 可选 | 最大:64 | 待检测的口令,仅当在小白开放平台配置口令后才会对此参数进行检测,规则配置教程 | |
logic | 字符串 | 可选 | and | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 | |
where | 字符串JSON格式 | 可选 | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中: 字段名:表单结构中存在的字段,或表字段 比较符:比较符号可以是>gt;、>gt;=、>lt;、>lt;=、>lt;>gt;、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值:需要比较的值,不同比较符的比较值格式会有所不同。如果字段是数值类型,请传递数值类型,不要用字符串。 示例:当logic=and, where=[["id",">gt;",9],["id",">lt;=",10]],则表示:id >gt; 9 AND id >lt;= 10。 写法2(Beta):每一组的条件格式可以为:MySQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求: 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用,并且使用静态参数,开启接口签名,以防SQL注入攻击 示例:当logic=and, where=["id >gt; 9", "id >lt;= 10"],则表示:id >gt; 9 AND id >lt;= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入,请用写法1;如果需要更强大的条件组合,并且是固定参数条件时,可用写法2。更多示例说明请参考WHERE参数介绍。 | ||
where_X | 字符串 | 可选 | 动态条件,优先于where的JSON数据,简化的where条件,更易使用但只支持部分比较符。条件格式:where_ + X(X要换成你的字段名) = 比较符(见下方) + 中横线(-) + 比较值。支持的比较符和示例如下: EQ:等于(默认),如:where_year=EQ-2020,或:where_year=2020,表示年份year等于2020; GT:大于,如:where_year=GT-2020,表示年份year大于2020; GE:大于等于,如:where_year=GE-2020,表示年份year大于或等于2020; LT:小于,如:where_year=LT-2020,表示年份year小于2020; LE:大于等于,如:where_year=LE-2020,表示年份year小于或等于2020; NE:不等于,如:where_year=NE-2020,表示年份year不等于2020; LIKE:模糊匹配,如:where_name=LIKE-小白,表示名字name含有小白的; NLIKE:模糊匹配(排除),如:where_name=NLIKE-小白,表示名字name不包含小白的 IN:枚举查询,如:where_year=IN-2020,2021,2022,表示年份year在这三个年份,多个值用英文逗号分割 NIN:枚举查询(排除),如:where_year=NIN-2020,2021,2022,表示年份year不在这三个年份,多个值用英文逗号分割 如果同一字段有多个条件,使用双竖线||分割,如:where_year=GT-2000||LT-2020,表示year年份大于2020(logic=and或logic=or)小于2020。(where和where_X二选一,不可混用,以where_X优先) | ||
fields | 字符串用,分割 | 可选 | 需要返回的字段名,多个字段用英文逗号分割,示例:fields=id,uuid,add_time |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
null
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,获取失败(表单不存在);2应用层规则拦截,拦截后可以小白开放平台查看日记;3查无数据;4当前取随机数据已超过10万条,为保证接口服务质量,请联系小白客服进行定制化。 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.data | 对象 | 获取的数据,可以指定返回字段 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://api.okayapi.com/api/SVIP/SID142374_MyApi/ACyFreeRandOne
接口路径(旧):http://api.okayapi.com/?s=SVIP.SID142374_MyApi.ACyFreeRandOne
接口描述: 查 可以根据自定义的多个条件(AND或者OR),随机获取一条数据。获取数据后不会修改或删除数据。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
model_name | 字符串 | 必须 | 表单名称(对应在小白开放平台创建时的数据库表名称),查看我的全部表单 | ||
model_uuid | 字符串 | 可选 | 最大:32 | 表单UUID,即对应表单数据里的uuid字段。分为三种情况: model_uuid为@NULL或未提供时(默认值):如model_uuid=@NULL,即不限制uuid,可匹配任意uuid,包括uuid为空和不为空的数据纪录; model_uuid为空字符串:为空字符串时,如model_uuid=,只匹配uuid为空字符串的数据纪录(即游客数据); model_uuid为具体的值:如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A,则进行精确匹配,只匹配与表单uuid相等的数据纪录。 | |
check_code | 字符串 | 可选 | 最大:64 | 待检测的口令,仅当在小白开放平台配置口令后才会对此参数进行检测,规则配置教程 | |
logic | 字符串 | 可选 | and | where条件的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 | |
where | 字符串JSON格式 | 可选 | SQL语句的WHERE查询条件,JSON格式,格式为:[第一组条件, 第二组条件, ……]。(where和where_X二选一,不可混用,以where_X优先) 写法1:每一组的条件格式为:["字段名", "比较符", "比较值"],其中: 字段名:表单结构中存在的字段,或表字段 比较符:比较符号可以是>gt;、>gt;=、>lt;、>lt;=、>lt;>gt;、!=、EQ、GT、GE、LT、LE、NE、LIKE、NLIKE、IN、NIN、BETWEEN、NBETWEEN 比较值:需要比较的值,不同比较符的比较值格式会有所不同。如果字段是数值类型,请传递数值类型,不要用字符串。 示例:当logic=and, where=[["id",">gt;",9],["id",">lt;=",10]],则表示:id >gt; 9 AND id >lt;= 10。 写法2(Beta):每一组的条件格式可以为:MySQL条件字符串,支持嵌套、组合、函数等,功能更强大,组合更灵活,但要求: 必须符合MySQL语法 一些疑似危险的操作已被禁止 建议掌握MySQL语法的专业开发者使用,并且使用静态参数,开启接口签名,以防SQL注入攻击 示例:当logic=and, where=["id >gt; 9", "id >lt;= 10"],则表示:id >gt; 9 AND id >lt;= 10。 以上两种写法可以混合使用。如果需要有效防止SQL注入,请用写法1;如果需要更强大的条件组合,并且是固定参数条件时,可用写法2。更多示例说明请参考WHERE参数介绍。 | ||
where_chengyu_difficulty | 字符串 | 可选 | 动态条件,优先于where的JSON数据,简化的where条件,更易使用但只支持部分比较符。条件格式:where_ + X(X要换成你的字段名) = 比较符(见下方) + 中横线(-) + 比较值。支持的比较符和示例如下: EQ:等于(默认),如:where_year=EQ-2020,或:where_year=2020,表示年份year等于2020; GT:大于,如:where_year=GT-2020,表示年份year大于2020; GE:大于等于,如:where_year=GE-2020,表示年份year大于或等于2020; LT:小于,如:where_year=LT-2020,表示年份year小于2020; LE:大于等于,如:where_year=LE-2020,表示年份year小于或等于2020; NE:不等于,如:where_year=NE-2020,表示年份year不等于2020; LIKE:模糊匹配,如:where_name=LIKE-小白,表示名字name含有小白的; NLIKE:模糊匹配(排除),如:where_name=NLIKE-小白,表示名字name不包含小白的 IN:枚举查询,如:where_year=IN-2020,2021,2022,表示年份year在这三个年份,多个值用英文逗号分割 NIN:枚举查询(排除),如:where_year=NIN-2020,2021,2022,表示年份year不在这三个年份,多个值用英文逗号分割 如果同一字段有多个条件,使用双竖线||分割,如:where_year=GT-2000||LT-2020,表示year年份大于2020(logic=and或logic=or)小于2020。(where和where_X二选一,不可混用,以where_X优先) | ||
fields | 字符串用,分割 | 可选 | 需要返回的字段名,多个字段用英文逗号分割,示例:fields=id,uuid,add_time |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
null
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 状态操作码,0成功;1开发类错误,获取失败(表单不存在);2应用层规则拦截,拦截后可以小白开放平台查看日记;3查无数据;4当前取随机数据已超过10万条,为保证接口服务质量,请联系小白客服进行定制化。 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.data | 对象 | 获取的数据,可以指定返回字段 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://api.okayapi.com/api/SVIP/SID142374_MyApi/ACyUserRegister
接口路径(旧):http://api.okayapi.com/?s=SVIP.SID142374_MyApi.ACyUserRegister
接口描述: 热门 进行新用户注册,创建一个新的会员账号,注册密码需要使用md5后的密码。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
username | 字符串 | 必须 | 最小:3;最大:12 | 注册成为应用的会员账号,注册后不可修改。 | |
password | 字符串 | 必须 | 最小:6;最大:50 | MD5后的密码,须md5后传递,保持全部小写,MD5加密工具 | |
ext_info | 字符串JSON格式 | 可选 | 注册时的用户扩展信息,注册后可修改,需要JSON编码后传递。格式:ext_info={"扩展字段名":"值"},可以同时更新多个字段。JSON在线解析及格式化验证 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
null
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0注册成功,1已注册,-1可用注册人数已用完 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.uuid | 字符串 | 全局唯一UUID,全局唯一用户ID,注册成功时返回 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://api.okayapi.com/api/SVIP/SID142374_MyApi/ACyUserLogin
接口路径(旧):http://api.okayapi.com/?s=SVIP.SID142374_MyApi.ACyUserLogin
接口描述: 热门 根据账号和md5后的密码进行会员登录
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
|