果创云开放接口

8601 获取我的表单列表 接口文档

接口路径(新)：http://hd215.api.yesapi.cn/api/App/Platform_MyModels/GetMyModelsList

接口路径(旧)：http://hd215.api.yesapi.cn/?s=App.Platform_MyModels.GetMyModelsList

接口描述： 查 获取小白开放平台的全部表单列表

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
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，欢迎使用小白开放接口！"}。
model_name字符串可选搜索表单名称(英文)，支持表单匹配
sort_type整型可选排序，1表单名称升级(默认)，2表单名称降序，3添加时间升序，4添加时间降序

客户端请求示例

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

HTTP通用示例 
请求：
{你的接口域名}/?s=App.Platform_MyModels.GetMyModelsList&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "models": [
        {
            "model_name": "yesapi_lastest_news",
            "model_desc": "新闻动态",
            "group_name": "",
            "add_time": "2019-12-05 09:19:48"
        },
        {
            "model_name": "test",
            "model_desc": "测试",
            "group_name": "测试",
            "add_time": "2020-01-02 19:10:09"
        }
        ]
    },
    "msg": "V1.4.14 小白开放接口 App.Platform_MyModels.GetMyModelsList"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
data.models字符串我的全部表单，没有时为空数组
data.models[].model_name字符串表单名称(英文)
data.models[].model_desc字符串表单描述(中文)
data.models[].add_time字符串创建时间
data.models[].group_name字符串分组名称
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)
果创云开放接口

8602 创建新表单 接口文档

接口路径(新)：http://hd215.api.yesapi.cn/api/App/Platform_MyModels/CreateNewModel

接口路径(旧)：http://hd215.api.yesapi.cn/?s=App.Platform_MyModels.CreateNewModel

接口描述： 加 创建一个新表单，每个账号当前最多可创建的表单数量为200个。

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
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，欢迎使用小白开放接口！"}。
model_name字符串必须最小：1；最大：50待创建的表单名称(英文)，用于数据库建表，由字母开头和数字的组成（如：demo），50个字符以内
model_desc字符串必须最小：1；最大：100用于页面展示，请起一个简短的中文名称（如：示例），100个字符以内
group_name字符串可选表单分组名称，不填为默认分组

客户端请求示例

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

HTTP通用示例 
请求：
{你的接口域名}/?s=App.Platform_MyModels.CreateNewModel&model_name=test&model_desc=测试&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "V1.4.14 小白开放接口 App.Platform_MyModels.CreateNewModel"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0成功，1表单已存在，2表单数量已达到上限，3创建失败请重试，4接口创建失败
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)
果创云开放接口

8603 添加表单字段 接口文档

接口路径(新)：http://hd215.api.yesapi.cn/api/App/Platform_MyModels/AddNewField

接口路径(旧)：http://hd215.api.yesapi.cn/?s=App.Platform_MyModels.AddNewField

接口描述： 加 为表单添加新字段，每个表单最多可创建100个字段。

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
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，欢迎使用小白开放接口！"}。
model_name字符串必须表单名称(英文)
field_name字符串必须最小：1；最大：50字段名称(英文)，请填写有效的数据库表字段名称，如：demo
field_desc字符串必须最小：1；最大：100字段描述（中文），将会显示在各大菜单，如：示例数据
field_type枚举类型必须范围：tinyint/smallint/mediumint/int/bigint/float/double/char/varchar/tinytext/text/mediumtext/longtext/date/time/year/datetime/timestamp字段类型，可选字段类型如下：
  • tinyint：数值 - tinyint - 小整数值（-128~127）
  • smallint：数值 - smallint - 大整数值（-32768~32767）
  • mediumint：数值 - mediumint - 大整数值（-8388608~8388607）
  • int：数值 - int - 大整数值（-2^31~2^31-1）
  • bigint：数值 - bigint - 极大整数值（-2^63~2^63-1）
  • float：数值 - float - 单精度浮点数值（-3.4E+38~3.4E+38）
  • double：数值 - double - 双精度浮点数值（-1.79E+308~1.79E+308(）
  • char：字符串 - char - 定长字符串（1~255 个字节）
  • varchar：字符串 - varchar - 变长字符串（1~255 个字节）
  • tinytext：字符串 - tinytext - 短文本字符串（最大长度255个字节）
  • text：字符串 - text - 长文本数据（最大长度65535个字节）
  • mediumtext：字符串 - mediumtext - 中等长度文本数据（最大长度 16777215 个字节）
  • longtext：字符串 - longtext - 极大文本数据（最大长度4294967295个字节）
  • date：日期时间 - date - 日期值（yyyy-mm-dd）
  • time：日期时间 - time - 时间值或持续时间（hh:mm:ss）
  • year：日期时间 - year - 年份值（yyyy）
  • datetime：日期时间 - datetime - 混合日期和时间值（yyyymmddhhmmss）
  • timestamp：日期时间 - timestamp - 时间戳
field_length整型可选0字段类型长度，重要提示：varchar时长度必填！
field_default字符串可选最大：80各类型的缺省默认值分别是：int为0、double为0、varchar为空字符串，datetime为19 70-01-01 00:00:00，date为1970-01-01。特别地，输入@NULL表示NULL
field_is_null布尔型可选true是否允许空值，1可为NULL，0不可为NULL(即字段必须)
field_index枚举类型可选no范围：no/normal/unique索引，no无索引，normal普通索引，unique唯一索引。注意：如果需要添加唯一索引，请确保现有表数据无重复值，否则会添加失败。索引创建失败不会影响字段的创建。
field_is_binary布尔型可选false

客户端请求示例

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

HTTP通用示例 
请求：
{你的接口域名}/?s=App.Platform_MyModels.AddNewField&model_name=test&field_name=test_name&field_desc=字段说明&field_type=varchar&field_length=100&field_is_null=1&field_index=no&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "V1.4.14 小白开放接口 App.Platform_MyModels.AddNewField"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0成功，1字段已存在，2字段数量已达到上限，3创建失败请重试，4接口创建失败 5表单不存在
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)
果创云开放接口

8604 删除表单字段 接口文档

接口路径(新)：http://hd215.api.yesapi.cn/api/App/Platform_MyModels/DropField

接口路径(旧)：http://hd215.api.yesapi.cn/?s=App.Platform_MyModels.DropField

接口描述： 删 删除表单已经存在的字段，注意删除后该字段的全部数据列将会被同步删除，不可恢复。

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
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，欢迎使用小白开放接口！"}。
model_name字符串必须表单名称(英文)
field_name字符串必须最小：1；最大：50待删除的字段名称(英文)，删除后不可恢复，请确认后再删除

客户端请求示例

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

HTTP通用示例 
请求：
{你的接口域名}/?s=App.Platform_MyModels.DropField&model_name=test&field_name=test_name&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "V1.4.14 小白开放接口 App.Platform_MyModels.DropField"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0成功，1表单不存在，2字段不存在，4接口删除失败
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)
果创云开放接口

8605 删除表单 接口文档

接口路径(新)：http://hd215.api.yesapi.cn/api/App/Platform_MyModels/DangerClear

接口路径(旧)：http://hd215.api.yesapi.cn/?s=App.Platform_MyModels.DangerClear

接口描述： 删 清空表单数据，同时可以同时彻底删除表单结构。注意数据清空后不可恢复！彻底删除表单结构后不可恢复！请再三确认！！

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
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，欢迎使用小白开放接口！"}。
model_name字符串必须最小：1；最大：50待清空数据或彻底删除的表单名称(英文)，删除后不可恢复，请三思后确认再删除！
is_drop_table布尔型可选false是否同时彻底删除表单结构及其全部表单字段，删除后表单结构将不再存在，需要重新创建并添加字段

客户端请求示例

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

HTTP通用示例 
请求：
{你的接口域名}/?s=App.Platform_MyModels.DangerClear&model_name=test&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "V1.4.15 小白开放接口 App.Platform_MyModels.DangerClear"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0成功，1表单不存在，4接口删除失败
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)

YesApi.cn | API低代码开发平台
零基础、低代码、接口稳定、自助快速开发

新手引导

1. 免费注册开发者
2. 创建一个新表单
3. 创建新数据API
4. SDK/客户端接入

产品

YesApi 果创云
YesApi 小白接口
YesApi 数据库大全
YesApi 接口大师
YesDev 项目管理

关于

用户服务协议

联系我们

合作：
huangchanzong@yesapi.cn QQ群：179679552(闲) 工作时间：09:00-18:00 (周一至周五) 地址：广州市黄埔区光谱中路11号云升科学园B1栋11层

微信咨询 客户经理

友情链接： 果创云 | YesDev项目管理 | PhalApi专业版 | PhalApi开源接口框架 | ApiAdmin | 开发者在线工具 | 出海游戏SDK | 贝特游戏SDK
©2017-2023 V3.3.0 小白接口 果创云 YesApi.cn （原OkayApi.com） 广州果创网络科技有限公司 All Rights Reserved.

粤公网安备 44011302002121号

 粤ICP备19016086号