YesApi 接口文档

3813 模拟产生数据[多合一] App.Common_Faker.AllInOne

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

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

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

接口标签:免费(每月最高10万次)付费(包月/按量/私服)验签

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

接口流量
1
请求协议
HTTP/HTTPS
请求方式
GET/POST(推荐POST)
编码格式
UTF-8
返回格式
JSON

在线测试接口    收藏此接口    在线接口开发    接口请求日记


接口参数 若无特殊说明,接口参数同时支持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每一组模拟数据是否以对象格式返回,否则以数组格式返回,可以根据需要选择是否需要合并在一起

在线测试

参数是否必填
s 固定
uuid 可选
token 可选
return_data 可选
needs 可选
total 可选
is_return_as_object 可选

客户端请求示例

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

请求:
{你的接口域名}/?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密钥字符串)

ret异常错误码

错误码错误类型错误描述信息解决方法
ret = 200成功请求成功
ret = 400客户端非法请求表示客户端参数错误1、根据接口文档的接口参数,提供正确的参数
ret = 404客户端非法请求表示接口服务不存在1、查看小白接口大全,确保接口服务名称拼写正确
ret = 500小白接口异常表示服务端内部错误1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复

常见问题FAQ

Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。

Q2 问:浏览器请求和在线测试接口正常,但本地程序无法正常获取接口结果答:需要注意UTF编码,以及存在中文和特殊字符时的URL编码。GET请求参数应统一进行URL编码后再请求,POST表单数据正常传递即可。

Q3 问:请求接口时提示JSON格式错误答:请先阅读,然后检测本地传递的参数是否符合JSON格式,使用JSON在线工具辅助检测,注意双引号和特殊符号。确认无误后再重新请求API接口。

Q4 问:出现 405 不允许跨域请求 时怎么办?答:可以追加GET参数 &yesapi_allow_origin=1,或参考用反向代理解决跨域问题等3种解决方案。

Q4 问:在wx内无法访问yesapi.cn或okayapi.com域名,怎么办?答:由于曾经短链跳转使用被wx误封域名,可以帮忙进行申诉。申诉后截图联系我们,获取15万次接口流量奖励。