YesApi 接口文档

3801 模拟产生地址数据

接口路径(新)：http://hn216.api.yesapi.cn/api/App/Common_Faker/Address

接口路径(旧)：http://hn216.api.yesapi.cn/?s=App.Common_Faker.Address

接口描述： 模拟产生地址数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
needs字符串用,分割可选需要模拟的字段，默认返回全部，多个所需字体用英文逗号分割
total整型可选3最小：1需要模拟的数据条目数量

客户端请求示例

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

PHP示例 
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Common_Faker.Address');
// 输出结果
print_r($rs);

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[items] => Array 
		( 
			[state] => Array ( [0] => 宁夏回族自治区 [1] => 四川省 [2] => 辽宁省 ) 
			[stateAbbr] => Array ( [0] => 晋 [1] => 鲁 [2] => 京 ) 
			[city] => Array ( [0] => 武汉 [1] => 天津 [2] => 石家庄 ) 
			[postcode] => Array ( [0] => 583900 [1] => 395200 [2] => 371400 ) 
			[address] => Array ( [0] => 西安高明区 [1] => 太原海港区 [2] => 重庆滨城区 ) 
			[latitude] => Array ( [0] => 81.001984 [1] => -69.073263 [2] => 25.608491 ) 
			[longitude] => Array ( [0] => 82.592177 [1] => 144.325868 [2] => 158.85701 ) 
		) 
	) 
	[msg] => 小白开放接口：App.Common_Faker.Address 
)
*/

接口返回及数据结构

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

3802 模拟产生颜色数据

接口路径(新)：http://hn216.api.yesapi.cn/api/App/Common_Faker/Color

接口路径(旧)：http://hn216.api.yesapi.cn/?s=App.Common_Faker.Color

接口描述： 模拟产生彦希数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
needs字符串用,分割可选需要模拟的字段，默认返回全部，多个所需字体用英文逗号分割
total整型可选3最小：1需要模拟的数据条目数量

客户端请求示例

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

PHP示例 
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Common_Faker.Color');
// 输出结果
print_r($rs);

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[items] => Array 
		( 
			[hexcolor] => Array ( [0] => #575f13 [1] => #3048d1 [2] => #a0a0f5 ) 
			[rgbcolor] => Array ( [0] => 242,101,142 [1] => 4,242,92 [2] => 163,66,36 ) 
			[rgbColorAsArray] => Array ( [0] => Array ( [0] => 39 [1] => 251 [2] => 82 ) [1] => Array ( [0] => 206 [1] => 64 [2] => 107 ) [2] => Array ( [0] => 46 [1] => 169 [2] => 134 ) ) 
			[rgbCssColor] => Array ( [0] => rgb(62,88,131) [1] => rgb(123,100,21) [2] => rgb(23,127,145) ) 
			[safeColorName] => Array ( [0] => 黑色 [1] => 藏青 [2] => 银色 )
			[colorName] => Array ( [0] => 鼠尾草蓝 [1] => 蓟紫 [2] => 薰衣草紫 ) 
		)
	) 
	[msg] => 小白开放接口：App.Common_Faker.Color
)
*/

接口返回及数据结构

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

3803 模拟产生公司数据

接口路径(新)：http://hn216.api.yesapi.cn/api/App/Common_Faker/Company

接口路径(旧)：http://hn216.api.yesapi.cn/?s=App.Common_Faker.Company

接口描述： 模拟产生公司数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
needs字符串用,分割可选需要模拟的字段，默认返回全部，多个所需字体用英文逗号分割
total整型可选3最小：1需要模拟的数据条目数量

客户端请求示例

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

PHP示例 
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Common_Faker.Company');
// 输出结果
print_r($rs);

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[items] => Array
		( 
			[catchPhrase] => Array ( [0] => SOHU：足迹生活每一天 [1] => 只溶在口，不溶在手。 [2] => 只溶在口，不溶在手。 ) 	
			[company] => Array ( [0] => 信诚致远传媒有限公司 [1] => 合联电子网络有限公司 [2] => 创亿信息有限公司 ) 
			[companySuffix] => Array ( [0] => 网络有限公司 [1] => 科技有限公司 [2] => 科技有限公司 ) 
		) 
	) 
	[msg] => 小白开放接口：App.Common_Faker.Company 
)
*/

接口返回及数据结构

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

3804 模拟产生用户数据

接口路径(新)：http://hn216.api.yesapi.cn/api/App/Common_Faker/Person

接口路径(旧)：http://hn216.api.yesapi.cn/?s=App.Common_Faker.Person

接口描述： 模拟产生用户数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
needs字符串用,分割可选需要模拟的字段，默认返回全部，多个所需字体用英文逗号分割
total整型可选3最小：1需要模拟的数据条目数量

客户端请求示例

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

PHP示例 
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Common_Faker.Person');
// 输出结果
print_r($rs);

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[items] => Array 
		( 
			[name] => Array ( [0] => 熊欣 [1] => 练新华 [2] => 伍娜 )
			[lastName] => Array ( [0] => 涂 [1] => 洪 [2] => 费 ) 
			[firstName] => Array ( [0] => 金凤 [1] => 桂珍 [2] => 杨 ) 
			[firstNameMale] => Array ( [0] => 东 [1] => 捷 [2] => 建国 ) 
			[firstNameFemale] => Array ( [0] => 桂花 [1] => 玲 [2] => 春梅 ) 
		) 
	) 
	[msg] => 小白开放接口：App.Common_Faker.Person 
)
*/

接口返回及数据结构

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

3805 模拟产生网络数据

接口路径(新)：http://hn216.api.yesapi.cn/api/App/Common_Faker/Internet

接口路径(旧)：http://hn216.api.yesapi.cn/?s=App.Common_Faker.Internet

接口描述： 模拟产生网络数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
needs字符串用,分割可选需要模拟的字段，默认返回全部，多个所需字体用英文逗号分割
total整型可选3最小：1需要模拟的数据条目数量

客户端请求示例

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

PHP示例 
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Common_Faker.Internet');
// 输出结果
print_r($rs);

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[items] => Array 
		( 
			[email] => Array ( [0] => molestiae.neque@qq.com [1] => soluta57@sina.com [2] => corrupti43@gmail.com ) 
			[userName] => Array ( [0] => accusamus44 [1] => quo_pariatur [2] => estest ) 
			[password] => Array ( [0] => nIJGp@PB [1] => =Q6/l[a.@1'%ZE [2] => R6C=.2 ) 
			[slug] => Array ( [0] => ea-velit-id-et-rerum-quia-cumque [1] => sit-ex-fuga-occaecati-quas [2] => est-accusantium-necessitatibus-totam-molestias-accusantium-quod ) 
			[ipv4] => Array ( [0] => 59.56.101.207 [1] => 92.193.91.133 [2] => 37.190.180.35 ) 
			[localIpv4] => Array ( [0] => 10.144.146.212 [1] => 10.89.201.97 [2] => 10.87.134.116 ) 
			[ipv6] => Array ( [0] => fd05:48b5:3b10:b72:a115:5b47:562e:ca12 [1] => c28c:b2f:89d4:d64d:6502:e267:8e23:e5f6 [2] => 8819:8fd7:5c7d:f80e:882a:5c0e:e8db:8b0f ) 
			[macAddress] => Array ( [0] => 1F:A8:97:DF:DD:A9 [1] => 08:3D:80:7D:AC:7C [2] => F0:3A:57:5E:9F:70 ) 
		) 
	) 
	[msg] => 小白开放接口：App.Common_Faker.Internet 
)
*/

接口返回及数据结构

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

3806 模拟产生电话数据

接口路径(新)：http://hn216.api.yesapi.cn/api/App/Common_Faker/Phonenumber

接口路径(旧)：http://hn216.api.yesapi.cn/?s=App.Common_Faker.Phonenumber

接口描述： 模拟产生电话数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
needs字符串用,分割可选需要模拟的字段，默认返回全部，多个所需字体用英文逗号分割
total整型可选3最小：1需要模拟的数据条目数量

客户端请求示例

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

PHP示例 
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Common_Faker.Phonenumber');
// 输出结果
print_r($rs);

/*
Array 
(
	 [ret] => 200 
	 [data] => Array 
	 ( 
	 	[err_code] => 0 
		[err_msg] => 
		[items] => Array 
		( 
			[phoneNumber] => Array 
			( 
				[0] => 17053483746 
				[1] => 13873960759 
				[2] => 15891626287 
			) 
		) 
	 ) 
	[msg] => 小白开放接口：App.Common_Faker.Phonenumber 
)
*/

接口返回及数据结构

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

3807 模拟产生时间数据

接口路径(新)：http://hn216.api.yesapi.cn/api/App/Common_Faker/Datetime

接口路径(旧)：http://hn216.api.yesapi.cn/?s=App.Common_Faker.Datetime

接口描述： 模拟产生时间数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
needs字符串用,分割可选需要模拟的字段，默认返回全部，多个所需字体用英文逗号分割
total整型可选3最小：1需要模拟的数据条目数量

客户端请求示例

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

PHP示例 
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Common_Faker.Datetime');
// 输出结果
print_r($rs);

/*
Array 
( 
	[ret] => 200 
	[data] => Array
	( 
		[err_code] => 0 
		[err_msg] => 
		[items] => Array 
		( 
			[unixTime] => Array ( [0] => 847846543 [1] => 446048920 [2] => 1080023440 ) 
			[iso8601] => Array ( [0] => 1988-08-11T04:36:48+0900 [1] => 2011-05-28T21:07:32+0800 [2] => 2000-05-21T13:17:05+0800 ) 				 			[date] => Array ( [0] => 2018-10-18 [1] => 1996-11-24 [2] => 2001-05-02 ) 
			[time] => Array ( [0] => 03:09:35 [1] => 18:47:47 [2] => 10:09:02 ) 
			[year] => Array ( [0] => 1980 [1] => 1970 [2] => 1999 )
			[month] => Array ( [0] => 05 [1] => 12 [2] => 11 ) 
			[dayOfMonth] => Array ( [0] => 12 [1] => 01 [2] => 20 ) 
			[amPm] => Array ( [0] => 下午 [1] => 下午 [2] => 上午 ) 
		) 
	) 
	[msg] => 小白开放接口：App.Common_Faker.Datetime 
)
*/

接口返回及数据结构

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

3808 模拟产生用户代理数据

接口路径(新)：http://hn216.api.yesapi.cn/api/App/Common_Faker/Useragent

接口路径(旧)：http://hn216.api.yesapi.cn/?s=App.Common_Faker.Useragent

接口描述： 模拟产生用户代理数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
needs字符串用,分割可选需要模拟的字段，默认返回全部，多个所需字体用英文逗号分割
total整型可选3最小：1需要模拟的数据条目数量

客户端请求示例

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

接口返回及数据结构

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

3809 模拟产生图片数据

接口路径(新)：http://hn216.api.yesapi.cn/api/App/Common_Faker/Image

接口路径(旧)：http://hn216.api.yesapi.cn/?s=App.Common_Faker.Image

接口描述： 模拟产生图片数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
needs字符串用,分割可选需要模拟的字段，默认返回全部，多个所需字体用英文逗号分割
total整型可选3最小：1需要模拟的数据条目数量

客户端请求示例

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

PHP示例 
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Common_Faker.Image');
// 输出结果
print_r($rs);

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[items] => Array 
		( 
			[imageUrl] => Array 
			( 
				[0] => https://lorempixel.com/640/480/?92919 
				[1] => https://lorempixel.com/640/480/?24875 
				[2] => https://lorempixel.com/640/480/?74147 
			) 
		) 
	) 
	[msg] => 小白开放接口：App.Common_Faker.Image 
)
*/

接口返回及数据结构

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

3810 模拟产生UUID数据

接口路径(新)：http://hn216.api.yesapi.cn/api/App/Common_Faker/Uuid

接口路径(旧)：http://hn216.api.yesapi.cn/?s=App.Common_Faker.Uuid

接口描述： 模拟产生UUID数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
needs字符串用,分割可选需要模拟的字段，默认返回全部，多个所需字体用英文逗号分割
total整型可选3最小：1需要模拟的数据条目数量

客户端请求示例

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

PHP示例 
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Common_Faker.Uuid');
// 输出结果
print_r($rs);

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[items] => Array 
		( 
			[uuid] => Array 
			( 
				[0] => bafb373c-7d09-32a3-8c20-73da588a08d4 
				[1] => a4fcba72-46ef-3fa2-9b7f-aa01ff77d6cd 
				[2] => bacd3690-7ba7-3c95-8449-d661a6484332 
			) 
		) 
	) 
	[msg] => 小白开放接口：App.Common_Faker.Uuid 
)
*/

接口返回及数据结构

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

3811 模拟产生条形码数据

接口路径(新)：http://hn216.api.yesapi.cn/api/App/Common_Faker/Barcode

接口路径(旧)：http://hn216.api.yesapi.cn/?s=App.Common_Faker.Barcode

接口描述： 模拟产生条形码数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
needs字符串用,分割可选需要模拟的字段，默认返回全部，多个所需字体用英文逗号分割
total整型可选3最小：1需要模拟的数据条目数量

客户端请求示例

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

PHP示例 
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Common_Faker.Barcode');
// 输出结果
print_r($rs);

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[items] => Array 
		( 
			[ean13] => Array ( [0] => 1606998021868 [1] => 1107672980094 [2] => 1387664382086 ) 
			[ean8] => Array ( [0] => 20426439 [1] => 63759181 [2] => 60909077 ) 
			[isbn13] => Array ( [0] => 9794356486991 [1] => 9797170714172 [2] => 9793032314986 ) 
			[isbn10] => Array ( [0] => 3631761775 [1] => 0376899115 [2] => 3342503130 ) 
		) 
	) 
	[msg] => 小白开放接口：App.Common_Faker.Barcode
)
*/

接口返回及数据结构

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

3812 模拟产生开发数据

接口路径(新)：http://hn216.api.yesapi.cn/api/App/Common_Faker/Dev

接口路径(旧)：http://hn216.api.yesapi.cn/?s=App.Common_Faker.Dev

接口描述： 模拟产生开发数据

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
needs字符串用,分割可选需要模拟的字段，默认返回全部，多个所需字体用英文逗号分割
total整型可选3最小：1需要模拟的数据条目数量

客户端请求示例

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

PHP示例 
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$rs = OkayApiClient::request('App.Common_Faker.Dev');
// 输出结果
print_r($rs);

/*
Array 
( 
	[ret] => 200 
	[data] => Array 
	( 
		[err_code] => 0 
		[err_msg] => 
		[items] => Array 
		( 
			[md5] => Array ( [0] => 354a95807cb190e40a44d591513b89ed [1] => 14bea31a0e90acf24a89bdc72f104556 [2] => 549742c2b1d87762bcaf694ab0b2869b ) 
			[sha1] => Array ( [0] => 14f457462c726c954a015cbc1a2049fca7e077ea [1] => b0f794877a1337f8d4cc3761fe562b3a1a31f965 [2] => 080e7f7c5f35411559e648347a3ad257e6893b72 ) 
			[sha256] => Array ( [0] => ba148efafb63fb04aff65a1aad8259c85bf9be0d230830c32439bed3a4a348df [1] => 78b660e753d4a61cd91ce484536e7c09aa7129dd82b4effd11401fd28235ff68 [2] => c99b71ec59f19e441335e48478483da2638ffae46f03460cbddd4d9fb8087f18 ) 
		) 
	) 
	[msg] => 小白开放接口：App.Common_Faker.Dev 
)
*/

接口返回及数据结构

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

3813 模拟产生数据[多合一]

接口路径(新)：http://hn216.api.yesapi.cn/api/App/Common_Faker/AllInOne

接口路径(旧)：http://hn216.api.yesapi.cn/?s=App.Common_Faker.AllInOne

接口描述： 多合一 可以一次性组合模拟产生多种数据，功能更为强大。

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
needs字符串用,分割可选address,barcode,color需要模拟的数据类型，多个数据类型用英文逗号分割。支持以下数据类型：
  • Address：地址数据，字段有state,stateAbbr,city,postcode,address,latitude,longitude
  • Barcode：条形码数据，字段有ean13,ean8,isbn13,isbn10
  • Color：颜色数据，字段有hexcolor,rgbcolor,rgbColorAsArray,rgbCssColor,safeColorName,colorName
  • Company：公司数据，字段有catchPhrase,company,companySuffix
  • Datetime：时间数据，字段有unixTime,iso8601,date,time,year,month,dayOfMonth,amPm
  • Dev：开发数据，字段有md5,sha1,sha256
  • Image：图片数据，字段有imageUrl
  • Internet：网络数据，字段有email,userName,password,slug,ipv4,localIpv4,ipv6,macAddress
  • Person：用户数据，字段有name,lastName,firstName,firstNameMale,firstNameFemale
  • Phonenumber：电话数据，字段有phoneNumber
  • Useragent：用户代理数据，字段有userAgent,chrome,firefox,safari,opera,internetExplorer
  • Uuid：UUID数据，字段有uuid
total整型可选3最小：1需要模拟的数据条目数量
is_return_as_object布尔型可选true每一组模拟数据是否以对象格式返回，否则以数组格式返回，可以根据需要选择是否需要合并在一起

客户端请求示例

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

HTTP通用示例 
请求：
{你的接口域名}/?s=App.Common_Faker.AllInOne&uuid=&token=&needs=address,company&total=3&is_return_as_object=1&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "items": [
        {
            "state": "新疆维吾尔自治区",
            "stateAbbr": "津",
            "city": "北京",
            "postcode": "724700",
            "address": "昆明新区",
            "latitude": 45.809922,
            "longitude": 159.784064,
            "catchPhrase": "天天都是春天",
            "company": "凌颖信息传媒有限公司",
            "companySuffix": "传媒有限公司"
        },
        {
            "state": "甘肃省",
            "stateAbbr": "吉",
            "city": "上海",
            "postcode": "405700",
            "address": "郑州吉利区",
            "latitude": 45.506068,
            "longitude": -177.204935,
            "catchPhrase": "牛奶香浓，丝般感受。",
            "company": "恒聪百汇传媒有限公司",
            "companySuffix": "信息有限公司"
        },
        {
            "state": "河北省",
            "stateAbbr": "辽",
            "city": "昆明",
            "postcode": "428100",
            "address": "石家庄花溪区",
            "latitude": -22.61345,
            "longitude": -67.388615,
            "catchPhrase": "永远要让驾驶执照比你自己先到期。",
            "company": "太极信息有限公司",
            "companySuffix": "传媒有限公司"
        }
        ]
    },
    "msg": "V1.3.11 小白开放接口 App.Common_Faker.AllInOne"
}

如果需要每组数据单独分开，可以把传参数is_return_as_object=0，例如请求：
{你的接口域名}/?s=App.Common_Faker.AllInOne&needs=address,company&total=3&is_return_as_object=0&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "items": {
            "state": [
                "上海市",
            "广西壮族自治区",
            "湖北省"
                ],
            "stateAbbr": [
                "吉",
            "苏",
            "渝"
                ],
            "city": [
                "香港",
            "天津",
            "南京"
                ],
            "postcode": [
                "725400",
            "448000",
            "594400"
                ],
            "address": [
                "上海吉利区",
            "拉萨南湖区",
            "上海沈河区"
                ],
            "latitude": [
                0.790029,
            11.611364,
            15.771068
                ],
            "longitude": [
                -58.11326,
            -72.033088,
            167.233041
                ],
            "catchPhrase": [
                "要想皮肤好，早晚用大宝。",
            "三十六计走为上",
            "做光明的牛，产光明的奶"
                ],
            "company": [
                "毕博诚传媒有限公司",
            "诺依曼软件信息有限公司",
            "东方峻景网络有限公司"
                ],
            "companySuffix": [
                "网络有限公司",
            "网络有限公司",
            "信息有限公司"
                ]
        }
    },
    "msg": "V1.3.11 小白开放接口 App.Common_Faker.AllInOne"
}

接口返回及数据结构

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

特别注意：当前 hn216.api.yesapi.cn 为临时接口测试域名！请先完成 绑定独立接口域名后 ，才能正式进行API调用。

由 果创云YesApi.cn 提供技术支持，4万+开发者都在用，累计API调用1,800,000＋万次