YesApi 接口文档

8201 百度地图开放平台-普通IP定位

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

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

接口描述： 普通IP定位是一套以HTTP/HTTPS形式提供的轻量级定位接口，用户可以通过该服务，根据IP定位来获取大致位置。利用IP获取大致位置，调用API接口，返回请求参数中指定上网IP的大致位置信息（一般为城市级别），位置信息包括：经纬度、省、市等地址信息。普通IP定位服务目前不支持海外场景。依赖于Web服务API | 百度地图API SDK。配额有限，仅用于学习，如果需要正式使用，请联系我们技术客服

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
ip字符串可选IP地址，用户上网的IP地址，请求中如果不出现或为空，会针对发来请求的IP进行定位，示例：183.237.142.178
coor字符串可选设置返回位置信息中，经纬度的坐标类型，分别如下：
coor不出现、或为空：百度墨卡托坐标，即百度米制坐标
coor = bd09ll：百度经纬度坐标，在国测局坐标基础之上二次加密而来
coor = gcj02：国测局02坐标，在原始GPS坐标基础上，按照国家测绘行业统一要求，加密后的坐标

客户端请求示例

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

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

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "正常",
        "address": "CN|广东|广州|None|CHINANET|0|0", #详细地址信息  
        "content": {  #结构信息
            "address_detail": { #结构化地址信息
                "province": "广东省",  #省份
                "city": "广州市", #城市
                "district": "", #区县  
                "street": "", #街道  
                "street_number": "", #门牌号
                "city_code": 257 #百度城市代码  
            },
            "address": "广东省广州市", #简要地址信息 
            "point": { #当前城市中心点  
                "y": "2629614.08", #当前城市中心点经度
                "x": "12613487.11" #当前城市中心点纬度
            }
        },
        "ip": "158.82.155.184"
    },
    "msg": "V1.2.27 小白开放接口 App.Open_Baidu.LocationIP"
}

接口返回及数据结构

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

8202 百度地图开放平台-道路路况查询

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

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

接口描述： 实时路况查询服务（又名Traffic API）是一类Web API接口服务，开发者可利用该服务查询指定道路或区域的实时拥堵情况和拥堵趋势，可应用于智能音箱、智能车载设备、交通出行类应用中，实现诸如："信息路堵不堵？"、"五道口堵不堵？"这类用户询问路况场景。依赖于I | 百度地图API SDK。配额有限，仅用于学习，如果需要正式使用，请联系我们技术客服

接口参数 若无特殊说明，接口参数同时支持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，欢迎使用小白开放接口！"}。
road_name字符串必须道路名称，如："北五环"、"信息路"。 目前支持除多方向立交桥和多方向道路以外的各类道路名称（注：多方向是指道路方向多于2个方向，如：南向北、北向南、西向东、东向西，称为4方向）
city字符串必须所在城市，支持
1. 全国城市名称，如："北京市"、"上海市"等
2. 百度地图行政区划adcode，仅支持城市级别（adcode映射表），如"110000"

客户端请求示例

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

HTTP通用示例 
请求：
{你的接口域名}/?s=App.Open_Baidu.TrafficV1Road&uuid=@NULL&road_name=北五环&city=北京市&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "成功",
        "description": "北五环：自东向西畅通；自西向东较为畅通；北五环路严重拥堵；西向东,来广营桥附近严重拥堵；北五环路拥堵；北五环路拥堵。",
        "evaluation": {
            "status": 1,
            "status_desc": "自东向西畅通；自西向东较为畅通"
        },
        "road_traffic": [
        {
            "congestion_sections": [
            {
                "congestion_distance": 1390,
                "speed": 16.33,
                "status": 4,
                "congestion_trend": "加重",
                "section_desc": "北五环路"
            },
            {
                "congestion_distance": 1660,
                "speed": 18.13,
                "status": 4,
                "congestion_trend": "加重",
                "section_desc": "西向东,来广营桥附近"
            },
            {
                "congestion_distance": 1820,
                "speed": 30.25,
                "status": 3,
                "congestion_trend": "加重",
                "section_desc": "北五环路"
            },
            {
                "congestion_distance": 1440,
                "speed": 30.1,
                "status": 3,
                "congestion_trend": "加重",
                "section_desc": "北五环路"
            }
            ],
                "road_name": "北五环"
        }
        ]
    },
    "msg": "V1.2.27 小白开放接口 App.Open_Baidu.TrafficV1Road"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
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＋万次