查询独享代理城市信息

1. 接口描述

https://dev.kdlapi.com/api/querykpscity 英文代号:query kps city

本接口用于查询独享代理有哪些城市可供开通。对于IP共享型还可查询到每个城市可开通的IP数量。

  1. HTTP GET接口
  2. 参数和返回内容均采用utf-8编码
  3. 接口最快调用频率:1秒1次
  4. 必须使用虚拟订单号或独享代理订单号调用本接口

2. 参数说明

参数 是否必填 参数说明 取值说明
orderid 订单号 有效独享代理订单号或虚拟订单号
推荐使用虚拟订单号。
sign_type 签名验证方式。目前支持simple和hmacsha1。 默认值:simple
signature 请求签名,用来验证此次请求的合法性。 支持2种签名验证方式,签名计算方法参见API 授权与验证
timestamp 当前 UNIX 时间戳(秒级),可记录发起 API 请求的时间。
sign_type=hmacsha1时此参数为必填项。
例如1557546010,如果与当前时间相差过大,会引起签名过期错误。
serie 独享类型 1: IP共享型
2: IP独享型
model 型号选择
serie=1时此参数生效并且为必填项
DYN: 动态型
STD: 标准型
PRO: 专业型
ENT: 企业型
city 城市编码
指定查询某个城市是否可以购买
取值为2~4位城市编码(参见中国地区编码表)
默认取值:空串
取值为空串或不带此参数代表查询所有可购买的城市

3. 调用示例

在会员中心订单API接口页面得到虚拟订单和API Key。

  • 虚拟订单号:399141692192336
  • apikey:jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

为演示简单,这里采用密钥明文验证生成签名参数,建议您在生产环境采用数字签名验证。

IP共享型

调用示例

如下示例查询IP共享型下的专业型所有可开通的城市:

GET https://dev.kdlapi.com/api/querykpscity?orderid=399141692192336
&serie=1
&model=PRO
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

调用示例

如下示例查询IP共享型下的动态型能不能开通杭州市(城市编码:3301)的IP:

GET https://dev.kdlapi.com/api/querykpscity?orderid=399141692192336
&serie=1
&model=DYN
&city=3301
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

IP独享型

调用示例

如下示例查询IP独享型所有可开通的城市:

GET https://dev.kdlapi.com/api/querykpscity?orderid=399141692192336
&serie=2
&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

4. 返回结果

接口返回json格式,样例:

{
  "msg": "",
  "code": 0,
  "data": [
    {
      "count": 9,  #IP独享型不返回count字段
      "code": "410300",
      "name": "洛阳市"
    },
    {
      "count": 8,  #IP独享型不返回count字段
      "code": "320400",
      "name": "常州市"
    },
    {
      "count": 5,  #IP独享型不返回count字段
      "code": "410100",
      "name": "郑州市"
    }
  ]
}

没有查询到可供开通的城市返回:

{"code": 0, "msg": "no available kps found", "data": []}

异常返回格式样例:

{"code": -1, "msg": "缺少参数", "data": ""}

5. 错误码一览

错误码 说明
-1 缺少参数
-2 参数值错误
-3 订单类型错误

查看公共错误码 →

6. SDK

快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

SDK下载

联系我们
  • 售前在线咨询
    咨询享免费测试,专业工程师提供技术支持
  • 客服热线
    400-058-0638  周一至周六 9:00-18:30
  • 提交工单
    您的每一次反馈我们都认真对待
  • 客服微信 & QQ
    客服微信:kuaidaili,客服QQ:800849628
  • 企业客户通道
    提交需求后专业的售前工程师为您提供服务