概念云开放API - 获取用户区域信息

本站API接口已于2023.06.01正式关闭使用，目前正在改版接口规则，重新开放日期请关注博客公告！

欢迎使用概念云开放API - 区域信息获取 接口！

获取用户信息

接口最后更新时间：2023.02.20
文档最后更新时间：2023.03.06

接口介绍

这是一个可以返回当前用户区域信息的HTTP接口。目前返回信息包括省、市/地级以及城市代码。
注：为响应相关政策保护用户隐私部分数据已截断在服务端！

使用场景

如果您的网站需要使用到定位服务，如评论显示用户所在区域或者使用城市码请求天气信息等。

使用限制

1. Key
2. 用户目前IP（当前接口没有主动获取用户IP的功能，因此需要手动传参）
3. 目前调用量没有限制
4. Qps过高目前明确会被服务器拒绝

使用说明

第一步申请Key
第二步拼接HTTP请求URL，第一步申请的key需要连带sig作为参数一起发送
第三步接收返回的数据（JSON），解析数据
如无特殊声明，接口的输入参数和输出数据编码全部统一为UTF-8。

接口

获取用户区域信息接口地址

URL	https://api.cptyun.com/api/v1/getarea?parameters。
请求方式	GET

parameters 代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&)进行分隔。下面的列表枚举了这些参数及其使用规则。

请求参数

参数名	含义	是否必须	缺省值
key	请求服务权限标识	是	无
sig	与服务器校验身份加密值	是	无
ip	访问用户的IP	是	无
output	返回值	否	JSON

返回结果参数说明

名称	含义	说明
status	状态码	200为正常，204为Key无效或过期，205为Sig计算错误，500服务器错误
success	请求状态	仅有500情况下会返回false，标明是服务器出现错误，与调用方无关；其余情况下均返回true（无论是否正常返回结果）
msg	success描述	参考success
data	返回的数据	主要返回的数据位于该字段
data-province	省级名称	省
data-city	市/地级名称	市/地级
data-adcode	城市代码	城市代码

服务示例
请求地址：https://api.cptyun.com/api/v1/getarea?ip=123.456.789.951&key=123456&sig=123456

{
  "status": 200,
  "success": true,
  "msg": "OK",
  "data": {
    "province": "北京",
    "city": "北京",
    "adcode": "140200"
  }
}