在线客服 9:00-21:00  余额： 0 ￥      登出
API调用说明v2023.05.05
请求

API请求路径为： https://kookeey.com/

所有请求采用 HTTP GET 方式

请求固定包含accessid，signature和ts3个参数

单账户的请求频率限制为 10 qps/s

https://kookeey.com/方法名?accessid=开发者ID&signature=参数字符串和时间戳的签名值&ts=请求发起时间戳(秒)
https://kookeey.com/stock?accessid=1&signature=ZDQyNmExY2FiOWZhNDdiMjAzNTYyYmFhZDZmMWIyNzM4N2FjM2JmMA==&g=433&ts=1609430400
签名

签名方式：将所有的请求参数拼接完成后，通过开发者token计算出拼接完字符串的的HMAC-SHA1值，最后进行base64编码

accessid：开发者ID，请从账户信息获取

加密秘钥：请从账户中心获取

参数字符串：请查看每个接口的具体定义, 需要注意的是，加密的参数字符串的顺序需要与URL的参数顺序一致，例如，加密的参数字符串是：g=1&ts=1609430400；则URL是：/stock?accessid=1&signature=YzVkMjQxYjVmNjA2MWExMjAwYWYxMzUxM2I1YTY4YWYyOWIxMzA5NA==&g=1&ts=1609430400

说明：本文档所有请求示例，均使用加密秘钥1234567ABCDEFG进行加密，只是用作校验您的签名是否符合 API 的要求。 你向 API 发起请求时，请使用真实的数据

JAVA:Base64(HMAC-SHA1(加密秘钥,UTF-8-Encoding-Of(参数字符串)))

PHP(>=5.1.2):base64_encode(hash_hmac("sha1", 参数字符串, 加密秘钥, false))

PYTHON(>=3.0):base64.b64encode((hmac.new(bytes(加密秘钥,encoding='utf-8'),bytes(参数字符串.strip('&'),encoding='utf-8'),hashlib.sha1).hexdigest()).encode("utf-8"))

响应

响应数据使用JSON格式

标准返回包含四个参数:success/data/msg/code

响应参数类型描述
successbool接口响应状态，true表示成功,false表示失败
dataobject具体结果数据
msgstring结果说明
codeint结果码
结果码
0成功
10006参数错误
10015签名超时
20001数据状态错误
20002数据不存在
20003数据已经存在
20004用户名已经存在
40001身份验证错误
40005余额不足
40008至少需要开启一种安全策略
40009无权执行该操作
40010账户密码认证已被关闭
40011存在设置单独的用户名密码的未过期线路
40012动态流量余额不足，请购买动态代理流量包
40013超过可开启独立线路上限
40014产品尚未开放自主购买
40015非活动用户，不可领取
40016目标用户不在代理名下
40017超过可批量处理数据上限
60001请求过于频繁
80003库存不足
80004订单无效
80005支付失败
80006端口正在配置中
80007订单正在支付中，请勿重复提交
80008静态端口不允许手动释放
订单
地区查询

接口：/stock?g=父级地区id

该接口返回已上架地区，以及目前每个地区库存

如果返回数组长度为0，则表示购买时会在该父级地区下随机分配地区

请求参数
参数名类型描述示例
gint地区父级id1：获取所有静态代理可用国家
433：获取美国所有静态代理地区
[当前支持的代理类型]
cint是否获取次级地区列表[可选参数]1：获取，返回结构会新增属性child
结果数据

类型：对象数组 (地区库存)

属性类型描述示例
idint地区id433
namestring地区英文名US
cnnamestring地区中文名美国
stockbool库存状态true ：可用 / false：无库存
childarray次级地区以及库存状态 对象数组[附加参数] 只有请求时添加对应可选参数才会返回该字段同样包含 id，name，cnname，stock 4个属性
 
PHP示例: '/stock?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'g=1&ts=1609430400', '1234567ABCDEFG', false)).'&g=1&ts=1609430400'
示例结果: /stock?accessid=1&signature=YzVkMjQxYjVmNjA2MWExMjAwYWYxMzUxM2I1YTY4YWYyOWIxMzA5NA==&g=1&ts=1609430400
{"success":true,"data":[{"id":432,"name":"US","cnname":"美国","stock":true},{"id":11,"name":"CN","cnname":"中国","stock":true},{"id":501,"name":"SG","cnname":"新加坡","stock":false},{"id":444,"name":"DE","cnname":"德国","stock":false},{"id":504,"name":"PH","cnname":"菲律宾","stock":true}],"msg":"操作成功","code":0}
当前可用的代理类型ID

相关数据接口：[地区查询] [线路列表]

相关数据结构：[类型/地区对象 ]

ID描述
1静态数据中心
2动态家庭住宅
4静态ISP住宅
价格查询

接口：/price?g=地区id

该接口返回地区价格

请求参数
参数名类型描述示例
gint地区id433
结果数据

类型：对象 (地区价格)

属性类型描述示例
priceint价格，单位分1000
unitstring价格对应的套餐单位端口/30天
[套餐单位说明]
currencystring货币单位￥

套餐单位

代理类型描述示例
静态代理(数据中心/ISP住宅)端口/有效期端口/30天 : 按线路计费，线路有效期为30天
动态代理(住宅)GB(有效期)GB(30天) : 按流量每GB计费，线路有效期为30天
对于正式账户，有效期固定为30天;测试期可以联系管理员调整线路有效期
 
PHP示例: '/price?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'g=433&ts=1609430400', '1234567ABCDEFG', false)).'&g=433&ts=1609430400'
示例结果: /price?accessid=1&signature=ZDQyNmExY2FiOWZhNDdiMjAzNTYyYmFhZDZmMWIyNzM4N2FjM2JmMA==&g=433&ts=1609430400
{"success":true,"data":{"price":"1000","unit":"端口/30天","currency":"￥"},"msg":"操作成功","code":0}
新购

接口：/check?g=地区id&n=新购数量

该接口生成一张未支付新购订单，并返回订单费用信息

未支付订单的有效期为10分钟，10分钟后订单id会过期，不可进行支付确认

请求参数
参数名类型描述示例
gint地区id439
pstring协议socks5 / http
http=>http(s)协议
nint购买数量1
结果数据

类型：对象 (临时新购订单)

属性类型描述示例
orderidstring未支付订单id5283163557995843913770
priceint价格，单位分1000
unitstring价格对应的套餐单位端口/1天
[套餐单位说明]
currencystring货币单位￥
balanceint当前账户余额，单位分20000
uncountint账户余额中未扣除流量费，单位分0
costint支付订单需立即扣除金额，单位分1000
 
PHP示例: '/check?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'g=439&n=1&ts=1609430400', '1234567ABCDEFG', false)).'&g=439&n=1&ts=1609430400'
示例结果: /check?accessid=1&signature=MDJlZTBiMzQ3OGI1NDAzNGJlMzgyMjc0YzVkMWY1YWJhNGU5OWNhNQ==&g=439&n=1&ts=1609430400
{"success":true,"data":{"orderid":"5283163557995843913770","balance":548,"uncount":0,"price":20000,"unit":"GB(1天)","cost":20000,"currency":"￥"},"msg":"操作成功","code":0}
续订

接口：/checkr?p=线路id

接口生成一张未支付续订订单，并返回订单费用信息

未支付订单的有效期为10分钟，10分钟后订单id会过期，不可进行支付确认

只可以对未过期线路进行续订

请求参数
参数名类型描述示例
pint线路id2300790
结果数据

类型：对象 (临时续费订单)

属性类型描述示例
orderidstring未支付订单id5283163558121643316178
priceint价格，单位分1000
unitstring价格对应的套餐单位端口/1天
[套餐单位说明]
currencystring货币单位￥
balanceint当前账户余额，单位分20000
uncountint账户余额中未扣除流量费，单位分0
costint支付订单需立即扣除金额，单位分1000
daysint续订天数1
autorenewint该线路当前续订配置0：跟随用户全局续订策略
1：该线路强制自动续订
2：该线路强制关闭自动续订
 
PHP示例: '/checkr?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'p=2300790&ts=1609430400', '1234567ABCDEFG', false)).'&p=2300790&ts=1609430400'
示例结果: /checkr?accessid=1&signature=ZDI0ZjYxODI5MTIzMDViODY0ZTI0YWJhYzUxZDIwNGEyMjEwM2EzMw==&p=2300790&ts=1609430400
{"success":true,"data":{"orderid":"5283163558121643316178","balance":548,"uncount":0,"price":20000,"days":1,"unit":"GB(1天)","cost":20000,"currency":"￥","autorenew":0},"msg":"操作成功","code":0}
流量分发

接口：/checkt?to=目标用户ID&p=分发套餐&n=分发数量

该接口生成一张未处理的流量分发订单，并返回分发详细信息

流量分发订单不会产生费用，一旦支付，对应流量会从代理账户扣除，并增加到对应的子账户

未处理订单的有效期为10分钟，10分钟后订单id会过期，不可进行支付确认

仅代理账户可以调用该接口

请求参数
参数名类型描述示例
toint目标用户ID12345678
代理名下的账户ID
pint分发套餐1：1GB初级套餐
2：10GB进阶套餐
3：100GB高级套餐
100：100MB测试套餐
nint分发数量1
结果数据

类型：对象 (临时分发订单)

属性类型描述示例
orderidstring未处理订单id5283163557995843913770
packageobject
[流量包套餐对象 ]		流量包套餐对象{"id":1,"name":"初级套餐","traffic":1,"threads":30,"period":30,"rawprice":5800}
currencystring货币单位￥
amountint分发数量1

流量包套餐规格对象

属性类型描述示例
idint套餐id1
namestring套餐名称初级套餐
trafficfloat套餐包含的流量，单位GB1
threadsint套餐包含的独立线路数量限制30
periodint套餐有效期，单位天30
rawpriceint套餐原价，单位分5800
 
PHP示例: '/checkt?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'to=12345678&p=1&n=1&ts=1609430400', '1234567ABCDEFG', false)).'&to=12345678&p=1&n=1&ts=1609430400'
示例结果: /checkt?accessid=1&signature=ZmI0Nzk1NDFmYzgyZDUzNjg4ZjFiZTMxMzFkYmI5NzY1ODdiMTY1NQ==&to=12345678&p=1&n=1&ts=1609430400
{"success":true,"data":{"orderid":"2687711168327639650112287","package":{"id":1,"name":"初级套餐","traffic":1,"threads":30,"period":30,"rawprice":5800},"currency":"￥","amount":1},"msg":"操作成功","code":0}
支付

接口：/pay?o=未支付订单id

该接口对未支付订单进行支付确认

未支付订单在支付确认后会生成一张真实订单，并根据订单信息自动分配/续订线路

线路分配为异步操作，一般支付完成后3分钟内会完成线路分配

如果线路分配失败，订单已支付金额会退回账户余额

请求参数
参数名类型描述示例
ostring未支付订单id5283163557995843913770
结果数据

类型：int

描述：真实订单id

示例：462084126

PHP示例: '/pay?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'o=5283163557995843913770&ts=1609430400', '1234567ABCDEFG', false)).'&o=5283163557995843913770&ts=1609430400'
示例结果: /pay?accessid=1&signature=NTM5MWNmMGU5YmUwNjQ0ZTM5MmEzMmUyOTgxMjY3MTc0NGJlZjg2ZQ==&o=5283163557995843913770&ts=1609430400
{"success":true,"data":462084126,"msg":"操作成功","code":0}
订单信息

接口：/oi?o=订单id

接口返回订单信息

请求参数
参数名类型描述示例
oint订单id462084126
结果数据

类型：对象 (订单信息)

属性类型描述示例
orderidint订单id462084126
ordertypestring订单类型新购 / 续订
daysint订单对应产品天数1
typeobject
[类型/地区对象 ]		订单所选类型对象{"id":2,"name":"RESIDENTIAL","cnname":"住宅端口"}
geoobject
[类型/地区对象 ]		订单所选国家对象{"id":433,"name":"US","cnname":"美国"}
regionobject
[类型/地区对象 ]		订单所选地区对象{"id":0,"name":"","cnname":""}
sharestring订单对应线路共享模式dedicated / share
protocolstring订单对应线路协议socks5
priceint单价，单位分1000
unitstring价格对应的套餐单位端口/1天
[套餐单位说明]
currencystring货币单位￥
numint订单购买数量2
realnumint订单实际成功购买数量1
portsarray [int]订单对应线路id数组[2300790]
statusstring订单状态未支付/订单处理中/订单完成/订单退款
timestring订单添加时间戳1609430400

类型/地区对象

属性类型描述示例
idint类型/国家/地区id433
0：表示上级地区随机
namestring英文名US
cnnamestring中文名美国
 
PHP示例: '/oi?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'o=462084126&ts=1609430400', '1234567ABCDEFG', false)).'&o=462084126&ts=1609430400'
示例结果: /oi?accessid=1&signature=N2ZlYjg3ZGNmMjFlZDYzZjhmNmI3YWZiYzZlNDUwNjIzMmQ0ZTg4NA==&o=462084126&ts=1609430400
{"success":true,"data":{"orderid":462084126,"type":{"id":2,"name":"RESIDENTIAL","cnname":"住宅端口"},"geo":{"id":433,"name":"US","cnname":"美国"},"region":{"id":0,"name":"","cnname":""},"ordertype":"新购","protocol":"socks5","share":"dedicated","num":1,"realnum":1,"price":20000,"unit":"GB(1天)","currency":"￥","days":1,"ports":[2300790],"status":"订单完成","time":1635581109},"msg":"操作成功","code":0}
订单列表

接口：/ol?s=查询开始时间戳&e=查询结束时间戳&ot=订单类型&p=页码

接口返回订单信息列表

请求参数
参数名类型描述示例
sint查询开始时间戳1633017600
eint查询结束时间戳1633622399
otint订单类型0：不限 / 1：新购 / 2：续费
ststring订单状态
pending：未完成（未支付/订单处理中）
confirm：订单完成
refund：订单退款(购买失败/手动退款)
不传参默认返回全部状态
piint订单关联线路ID8888888
pint查询页码1
结果数据

类型：对象 (列表信息)

属性类型描述示例
pageint当前页码1
page_sizeint单页数据条数10
totalint总数据量13
total_pageint总分页数2
listarray 对象数组
[订单信息对象]		结果数据[{订单信息对象},{订单信息对象}...]
 
PHP示例: '/ol?accessid=1&signature='.base64_encode(hash_hmac("sha1", 's=1633017600&e=1633622399&ot=0&p=1&ts=1609430400', '1234567ABCDEFG', false)).'&s=1633017600&e=1633622399&ot=0&p=1&ts=1609430400'
示例结果: /ol?accessid=1&signature=ZjhjOGQ4OTRkMDEyOWVkMDU4YzA0NTFhOGVjYmQyM2NjN2E2MWIyNQ==&s=1633017600&e=1633622399&ot=0&p=1&ts=1609430400
{"success":true,"data":{"page":2,"page_size":10,"total":13,"total_page":2,"list":[{"orderid":897918527,"ordertype":"续订","protocol":"socks5","share":"dedicated","num":1,"realnum":0,"price":20000,"unit":"GB(3天)","currency":"￥","type":{"id":2,"name":"RESIDENTIAL","cnname":"住宅端口"},"geo":{"id":451,"name":"IT","cnname":"意大利"},"region":{"id":0,"name":"","cnname":""},"status":"订单退款","time":1635168701},{"orderid":864401537,"ordertype":"新购","protocol":"socks5","share":"dedicated","num":1,"realnum":1,"price":20000,"unit":"GB(3天)","currency":"￥","type":{"id":2,"name":"RESIDENTIAL","cnname":"住宅端口"},"geo":{"id":451,"name":"IT","cnname":"意大利"},"region":{"id":0,"name":"","cnname":""},"status":"订单完成","time":1635155600}]},"msg":"操作成功","code":0}
提取IP

该板块介绍快速提取动态家庭住宅IP的方法

提取模式：用户ID-安全策略用户名:安全策略密码-国家ISO码-随机session-IP轮转时间间隔@kookeey网关:1000

提取参数详细说明
参数名类型描述示例
用户IDint用户ID123456789
安全策略用户名string用户全局安全策略的用户名abcdefg
安全策略密码string用户全局安全策略的用户密码abcdefg1234
国家ISO码string国家标准ISO码US
global表示全球混播
随机sessionstring随机字符串，8位[可选参数]12345678
不传表示每次请求切换
IP轮转时间间隔string[可选参数]5m：5分钟自动轮转
1h：1小时自动轮转
不传表示粘性
kookeey网关stringgate.kookeey.info
可选kookeey网关
默认网关gate.kookeey.info
东亚用户优化网关gate-hk.kookeey.info
美加用户优化网关gate-us.kookeey.info
东南亚用户优化网关gate-sea.kookeey.info
欧洲用户优化网关gate-eu.kookeey.info
英国用户优化网关gate-gb.kookeey.info
澳洲用户优化网关gate-au.kookeey.info
日本用户优化网关gate-jp.kookeey.info
提取示例
US，每次请求切换：123456789-abcdef:12345678-US@gate.kookeey.info:1000
全球混播，每次请求切换：123456789-abcdef:12345678-global@gate.kookeey.info:1000
US，粘性使用：123456789-abcdef:12345678-US-71261427@gate.kookeey.info:1000
US，每5分钟自动切换：123456789-abcdef:12345678-US-86822206-5m@gate.kookeey.info:1000
US，每1小时自动切换：123456789-abcdef:12345678-US-86822206-1h@gate.kookeey.info:1000
线路
线路信息

接口：/pi?p=线路id

接口返回线路信息

请求参数
参数名类型描述示例
pint线路id462084126
saint是否附加每个线路账密认证信息[可选参数]1：是
不传参默认不返回每个线路账密认证信息
cint是否附加线路出口IP信息[可选参数]1：是
不传参默认不返回当前出口IP
结果数据

类型：对象 (线路信息)

属性类型描述示例
portidint线路id2300790
protocolstring线路协议socks5
proxyipstringip107.151.187.174
proxyportint端口64825
sharestring线路共享模式dedicated / share
rotate_modeintip切换模式1：粘性 / 2：30min / 3：10min / 4：5min
静态线路该值恒为 1
next_changeip_timeint动态线路允许手动切换IP的时间戳1609430400
静态线路该值恒为 -
typeobject
[类型/地区对象 ]		订单所选类型对象{"id":2,"name":"RESIDENTIAL","cnname":"住宅端口"}
geoobject
[类型/地区对象 ]		订单所选国家对象{"id":433,"name":"US","cnname":"美国"}
regionobject
[类型/地区对象 ]		订单所选地区对象{"id":0,"name":"","cnname":""}
statusstring线路状态正常/停用/已过期/余额不足/异常
autorenewint该线路当前续订配置0：跟随用户全局续订策略
1：该线路强制自动续订
2：该线路强制关闭自动续订
default_autorenewint该类型线路用户全局续订策略0：不自动续订
1：自动续订
add_timeint线路添加时间戳1609430400
expire_timeint线路过期时间戳1635667562
ipstring该线路当前出口IP
[附加参数] 只有请求时添加对应可选参数才会返回该字段		192.168.1.1
对于状态关闭或者过期的线路，该值恒为 -
defaultauthint该线路是否使用全局连接账密
[附加参数] 只有请求时添加对应可选参数才会返回该字段		0：否，线路使用独立账密
1：是
authstrstring该线路连接账密
[附加参数] 只有请求时添加对应可选参数才会返回该字段		连接用户名:连接密码(如：aaaaaaaa:bbbbbbbb)
对于状态关闭或者过期的线路，该值恒为 -
remarkstring该线路备注
[附加参数] 只有请求时添加对应可选参数才会返回该字段		测试用 
PHP示例: '/pi?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'p=462084126&ts=1609430400', '1234567ABCDEFG', false)).'&p=462084126&ts=1609430400'
示例结果: /pi?accessid=1&signature=NGRmMDMzYjljNDk0MWVjYTk4MWVhZjJkYTNhZWYyZmQ3YTAzM2IyZg==&p=462084126&ts=1609430400
{"success":true,"data":{"portid":462084126,"protocol":"socks5","proxyip":"107.151.187.174","proxyport":64825,"share":"dedicated","rotate_mode":1,"type":{"id":2,"name":"RESIDENTIAL","cnname":"住宅端口"},"geo":{"id":433,"name":"US","cnname":"美国"},"region":{"id":0,"name":"","cnname":""},"status":"正常","autorenew":0,"add_time":1635581163,"expire_time":1635667562,"default_renew":0},"msg":"操作成功","code":0}
线路列表

接口：/pl?t=线路类型&g=地区id&p=页码

接口返回线路信息列表

请求参数
参数名类型描述示例
tint线路类型2
[当前支持的代理类型]
gint地区id[可选参数]433
0 表示不限制
pint查询页码1
sint线路状态[可选参数]1：正常
2：手动停用
3：已过期
不传参默认全部状态
astring线路账密[可选参数]查询特定 用户名/密码 认证的线路，支持模糊搜索
oint关联订单id[可选参数]111111111，精确匹配
ipstring出口/线路 IP，支持模糊搜索[可选参数]1.2.3.4 / 1.2.3 ，支持模糊搜索
cint是否附加线路出口IP信息[可选参数]1：是
不传参默认不返回当前出口IP
saint是否附加每个线路账密认证信息[可选参数]1：是
不传参默认不返回每个线路账密认证信息
结果数据

类型：对象 (列表信息)

属性类型描述示例
pageint当前页码1
page_sizeint单页数据条数10
totalint总数据量2
total_pageint总分页数1
listarray 对象数组
[线路信息对象]		结果数据[{线路信息对象},{线路信息对象}...]
 
PHP示例: '/pl?accessid=1&signature='.base64_encode(hash_hmac("sha1", 't=2&g=0&p=1&ts=1609430400', '1234567ABCDEFG', false)).'&t=2&g=0&p=1&ts=1609430400'
示例结果: /pl?accessid=1&signature=NzQ0ZWY2ZDk2NjZhNjc2Njk5MzlmMzJmNGUwYzYyMDE2N2JmNjYzOA==&t=2&g=0&p=1&ts=1609430400
{"success":true,"data":{"page":1,"page_size":10,"total":2,"total_page":1,"list":[{"portid":2300790,"proxyip":"107.151.187.174","proxyport":64825,"protocol":"socks5","rotate_mode":1,"type":{"id":2,"name":"RESIDENTIAL","cnname":"住宅端口"},"geo":{"id":433,"name":"US","cnname":"美国"},"region":{"id":0,"name":"","cnname":""},"autorenew":0,"default_autorenew":0,"status":"正常","add_time":1635581163,"expire_time":1635667562,"shutdown_time":0},{"portid":5071261,"proxyip":"107.151.187.174","proxyport":5242,"protocol":"socks5","rotate_mode":1,"type":{"id":2,"name":"RESIDENTIAL","cnname":"住宅端口"},"geo":{"id":448,"name":"ES","cnname":"西班牙"},"region":{"id":0,"name":"","cnname":""},"autorenew":0,"default_autorenew":0,"status":"已过期","add_time":1635238742,"expire_time":1635497941,"shutdown_time":1635498001}]},"msg":"操作成功","code":0}
恢复/停用

接口：/toggle?p=线路id&s=切换到状态

该接口可以恢复/停用线路

停用操作只是临时限制线路连接，并不能延长线路的过期时间

修改后生效时间为3分钟

请求参数
参数名类型描述示例
pint线路id2300790
sint切换到状态1：开启
2：停用
结果数据

类型：string

描述：无

PHP示例: '/toggle?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'p=2300790&s=1&ts=1609430400', '1234567ABCDEFG', false)).'&p=2300790&s=1&ts=1609430400'
示例结果: /toggle?accessid=1&signature=NzczOWQ1Y2VmM2E1NWY5MDIyZWE1ZWYwMjBmZGIzMjk1Mjk1YzcyMQ==&p=2300790&s=1&ts=1609430400
{"success":true,"data":"","msg":"操作成功","code":0}
释放动态IP池

接口：/release?p=线路id

该接口可以提前释放未过期的动态IP池

按周期计费的线路，释放后会退回未消费的计费周期

动态IP池释放后，连接线路无法找回

仅对动态线路可用

修改后线路会被立刻释放

请求参数
参数名类型描述示例
pint线路id2300790
结果数据

类型：string

描述：无

PHP示例: '/release?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'p=462084126&ts=1609430400', '1234567ABCDEFG', false)).'&p=462084126&ts=1609430400'
示例结果: /release?accessid=1&signature=NGRmMDMzYjljNDk0MWVjYTk4MWVhZjJkYTNhZWYyZmQ3YTAzM2IyZg==&p=462084126&ts=1609430400
{"success":true,"data":"","msg":"操作成功","code":0}
批量释放动态IP池

接口：/batchrelease?ps=线路id,线路id,线路id,线路id

该接口可以提前释放未过期的动态IP池

按周期计费的线路，释放后会退回未消费的计费周期

动态IP池释放后，连接线路无法找回

仅对动态线路可用

修改后线路会被立刻释放

请求参数
参数名类型描述示例
psint,int,int,int线路id(英文逗号分隔，最多支持传50个ID）2300790,1323780,3295059,1503589
结果数据

类型：array [int]

描述：释放成功的线路id

PHP示例: '/batchrelease?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'ps=2300790,1323780,3295059,1503589&ts=1609430400', '1234567ABCDEFG', false)).'&ps=2300790,1323780,3295059,1503589&ts=1609430400'
示例结果: /batchrelease?accessid=1&signature=ZDMwNDIxNTU0OWMwNjdhNTNiNmJiODY0YzA0YTk5NjQzZGMxYTliOA==&ps=2300790,1323780,3295059,1503589&ts=1609430400
{"success":true,"data":[2300790,1323780,3295059,1503589],"msg":"操作成功","code":0}
修改ip切换周期

接口：/rotate?p=线路id&m=目标ip切换周期

该接口可以修改线路的IP切换周期

仅对动态线路可用

请求参数
参数名类型描述示例
pint线路id2300790
mint目标ip切换周期1：粘性 / 2：30min / 3：10min / 4：5min
结果数据

类型：string

描述：无

PHP示例: '/rotate?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'p=2300790&m=1&ts=1609430400', '1234567ABCDEFG', false)).'&p=2300790&m=1&ts=1609430400'
示例结果: /rotate?accessid=1&signature=ZTZjYWI5ZDkzN2Q1OWE2N2VlN2I4MjNlYTQ0MDc0OTc0YjlkOTk5NA==&p=2300790&m=1&ts=1609430400
{"success":true,"data":"","msg":"操作成功","code":0}
修改自动续费

接口：/prenew?p=线路id&s=目标续费模式

该接口可以修改线路自动续费模式

如果线路存在自动续费配置，则会覆盖用户全局续订策略

请求参数
参数名类型描述示例
pint线路id2300790
sint目标续费模式1：该线路强制自动续订
2：该线路强制关闭自动续订
结果数据

类型：string

描述：无

PHP示例: '/prenew?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'p=2300790&s=1&ts=1609430400', '1234567ABCDEFG', false)).'&p=2300790&s=1&ts=1609430400'
示例结果: /prenew?accessid=1&signature=NzczOWQ1Y2VmM2E1NWY5MDIyZWE1ZWYwMjBmZGIzMjk1Mjk1YzcyMQ==&p=2300790&s=1&ts=1609430400
{"success":true,"data":"","msg":"操作成功","code":0}
设置独立账密

接口：/changeauth?p=线路id&n=独立用户名&pwd=独立密码&del=删除独立账密

该接口可以设置某个线路的独立账密

如果线路存在独立账密配置，则会覆盖用户全局安全策略的账密设置

该设置只针对账密策略，添加了独立账密的线路，全局安全策略中的IP白名单依旧生效

如果账户中存在独立账密的线路，不允许关闭全局安全策略中的“账户密码认证”；同理，如果全局“账户密码认证”被关闭，则无法设置独立账密

修改后生效时间为3分钟

请求参数
参数名类型描述示例
pint线路id2300790
nstring验证用户名[可选参数]kookeey (6-16位数字或字母)
pwdstring验证密码[可选参数]12345678 (8-24位数字或字母)
delint删除独立账密[可选参数]1：删除该线路的独立账密，使用全局账密
del参数和n+pwd参数组合必须2选1
结果数据

类型：string

描述：无

PHP示例: '/changeauth?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'p=2300790&n=kookeey&pwd=12345678&ts=1609430400', '1234567ABCDEFG', false)).'&p=2300790&n=kookeey&pwd=12345678&ts=1609430400'
示例结果: /changeauth?accessid=1&signature=ZGU2OTUzM2VmOTE3Y2QyZmM2NGU2Y2QxNWVkY2ZlYjU5NDMxNjZlNg==&p=2300790&n=kookeey&pwd=12345678&ts=1609430400
{"success":true,"data":"","msg":"操作成功","code":0}
用量查询

接口：/pusage?p=线路id&d=查询日期

接口返回线路在查询日期内的每小时流量统计

统计数据延迟2小时

统计数据缓存时长为15分钟

请求参数
参数名类型描述示例
pint线路id2300790
dstring查询日期2021-10-01(系统采用东八时区)
结果数据

类型：对象 (小时统计)

属性类型描述示例
hourint小时1
countint流量统计，单位kb2365
feeint流量费用，单位分45
 
PHP示例: '/pusage?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'p=2300790&d=2021-10-01&ts=1609430400', '1234567ABCDEFG', false)).'&p=2300790&d=2021-10-01&ts=1609430400'
示例结果: /pusage?accessid=1&signature=ZTdmNWIxMzQ3NzBlMTk5NGIxZDE3NTVmZTI3OTI4NzY5MDViOTc5ZA==&p=2300790&d=2021-10-01&ts=1609430400
{"success":true,"data":[{"hour":0,"count":983,"fee":18},{"hour":1,"count":2365,"fee":45},{"hour":2,"count":3072,"fee":58},{"hour":3,"count":3061,"fee":58},{"hour":4,"count":40990,"fee":781},{"hour":5,"count":115650,"fee":2205},{"hour":6,"count":69478,"fee":1325},{"hour":7,"count":72161,"fee":1376},{"hour":8,"count":80046,"fee":1526},{"hour":9,"count":2283,"fee":43},{"hour":10,"count":128215,"fee":2445},{"hour":11,"count":119347,"fee":2276},{"hour":12,"count":82647,"fee":1576},{"hour":13,"count":95703,"fee":1825},{"hour":14,"count":80322,"fee":1532},{"hour":15,"count":74403,"fee":1419},{"hour":16,"count":66201,"fee":1262},{"hour":17,"count":105328,"fee":2008},{"hour":18,"count":54753,"fee":1044},{"hour":19,"count":0,"fee":0},{"hour":20,"count":0,"fee":0},{"hour":21,"count":0,"fee":0},{"hour":22,"count":0,"fee":0},{"hour":23,"count":0,"fee":0}],"msg":"操作成功","code":0}
批量切换动态IP

接口：/batchchangeip?ps=线路id,线路id,线路id,线路id

该接口可以申请主动切换批量线路的出口IP

单线路限制切换频率为1次/分钟

切换过程会有连接中断，一般为30s左右

请求参数
参数名类型描述示例
psint,int,int,int线路id(英文逗号分隔，最多支持传50个ID）2300790,1323780,3295059,1503589
结果数据

类型：array [int]

描述：切换成功的线路id

PHP示例: '/batchchangeip?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'ps=2300790,1323780,3295059,1503589&ts=1609430400', '1234567ABCDEFG', false)).'&ps=2300790,1323780,3295059,1503589&ts=1609430400'
示例结果: /batchchangeip?accessid=1&signature=ZDMwNDIxNTU0OWMwNjdhNTNiNmJiODY0YzA0YTk5NjQzZGMxYTliOA==&ps=2300790,1323780,3295059,1503589&ts=1609430400
{"success":true,"data":[2300790,1323780,3295059,1503589],,"msg":"操作成功","code":0}
设置线路备注

接口：/changeremark?p=线路id&r=备注内容

该接口可以设置某条线路的备注

备注长度为1-50个字符

请求参数
参数名类型描述示例
pint线路id2300790
rstring备注内容(空值表示删除线路备注)test
结果数据

无

PHP示例: '/changeremark?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'p=2300790&r=test&ts=1609430400', '1234567ABCDEFG', false)).'&p=2300790&r=test&ts=1609430400'
示例结果: /changeremark?accessid=1&signature=ODZkZjI5MGIyNzA0MGYxMzdiZmUyN2U1MTA2MDJhZTMwNjIyMDRmMQ==&p=2300790&r=test&ts=1609430400
{"success":true,"data":"","msg":"操作成功","code":0}
批量设置线路备注

接口：/batchchangeremark?ps=线路id,线路id,线路id,线路id&r=备注内容

该接口可以设置多条线路的备注

备注长度为1-50个字符

请求参数
参数名类型描述示例
psint,int,int,int线路id(英文逗号分隔，最多支持传50个ID）2300790,1323780,3295059,1503589
rstring备注内容(空值表示删除线路备注)helloworld
结果数据

无

PHP示例: '/batchchangeremark?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'ps=2300790,1323780,3295059,1503589&r=helloworld&ts=1609430400', '1234567ABCDEFG', false)).'&ps=2300790,1323780,3295059,1503589&r=helloworld&ts=1609430400'
示例结果: /batchchangeremark?accessid=1&signature=NzA0OTlhZGVjN2EyNjJiY2NiMDhhYjA2YWU5NWVkNjJlZmRlYTc0YQ==&ps=2300790,1323780,3295059,1503589&r=helloworld&ts=1609430400
{"success":true,"data":"","msg":"操作成功","code":0}
获取IP

接口：/ip?p=线路id

该接口可以获取某个线路的当前出口IP. 注意：本接口获取IP 有缓存，适合静态数据中心、静态住宅 ISP线路查询使用。

动态的线路要检验是否切换IP成功，建议使用 https://checkip.amazonaws.com/ 、 https://lumtest.com/myip.json 等第三方的 IP 查询网站。

请求参数
参数名类型描述示例
pint线路id2300790
结果数据

类型：string

描述：当前线路出口IP

示例：127.0.0.1

PHP示例: '/ip?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'p=2300790&ts=1609430400', '1234567ABCDEFG', false)).'&p=2300790&ts=1609430400'
/ip?accessid=1&signature=ZDI0ZjYxODI5MTIzMDViODY0ZTI0YWJhYzUxZDIwNGEyMjEwM2EzMw==&p=2300790&ts=1609430400
{"success":true,"data":"127.0.0.1","msg":"操作成功","code":0}
安全策略
获取

接口：/security?u=开发者ID

该接口返回用户当前的安全策略配置

请求参数
参数名类型描述示例
uint开发者ID1
结果数据

类型：对象

属性类型描述示例
openauthint账密验证1：开启 / 2：关闭
openwhiteipintip白名单验证1：开启 / 2：关闭
 
PHP示例: '/security?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'u=1&ts=1609430400', '1234567ABCDEFG', false)).'&u=1&ts=1609430400'
示例结果: /security?accessid=1&signature=YWJjNDkyM2M2YTYyOGEyZTIwMzAyOWIyNzliYTkzNmI5Zjg2NTJkZg==&u=1&ts=1609430400
{"success":true,"data":{"openauth":1,"openwhiteip":1},"msg":"操作成功","code":0}
设置

接口：/mod?i=验证模式&t=修改为状态

该接口可以修改安全策略

修改后生效时间为3分钟

请求参数
参数名类型描述示例
istring验证模式openauth：账密验证 / openwhiteip：ip白名单验证
tint修改为状态1：开启 / 2：关闭
结果数据

类型：string

描述：无

PHP示例: '/mod?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'i=openauth&t=1&ts=1609430400', '1234567ABCDEFG', false)).'&i=openauth&t=1&ts=1609430400'
示例结果: /mod?accessid=1&signature=NGY4ZWQzNDMxMzQxMzU4YjRmNDUzZDU4NzE3YTdmOWRjOTgyOGQzYQ==&i=openauth&t=1&ts=1609430400
{"success":true,"data":"","msg":"操作成功","code":0}
修改账密

接口：/auth?n=验证用户名&p=验证密码

该接口可以修改用户的全局账户密码

修改后生效时间为3分钟

请求参数
参数名类型描述示例
nstring验证用户名kookeey (6-16位数字或字母)
pstring验证密码12345678 (8-24位数字或字母)
结果数据

类型：string

描述：无

PHP示例: '/auth?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'n=kookeey&p=12345678&ts=1609430400', '1234567ABCDEFG', false)).'&n=kookeey&p=12345678&ts=1609430400'
示例结果: /auth?accessid=1&signature=YmJmMDhlMTg4Njc3YzA3ZTViNmE0MTNlNjRiZTI1MTVlZGYwNzcxZQ==&n=kookeey&p=12345678&ts=1609430400
{"success":true,"data":"","msg":"操作成功","code":0}
添加白名单

接口：/addwhite?ip=ipv4地址

该接口可以添加IP白名单

修改后生效时间为3分钟

请求参数
参数名类型描述示例
ipstringipv4地址192.168.1.1
结果数据

类型：string

描述：无

PHP示例: '/addwhite?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'ip=192.168.1.1&ts=1609430400', '1234567ABCDEFG', false)).'&ip=192.168.1.1&ts=1609430400'
示例结果: /addwhite?accessid=1&signature=ZTBlYTk4NTljMzViYzIzODE4M2QzMDU4ZTNhZDMwMmQ2OWZkMzMyNw==&ip=192.168.1.1&ts=1609430400
{"success":true,"data":"","msg":"操作成功","code":0}
移除白名单

接口：/delwhite?ip=ipv4地址

该接口可以把某个IP从白名单中移除

修改后生效时间为3分钟

请求参数
参数名类型描述示例
ipstringipv4地址192.168.1.1
结果数据

类型：string

描述：无

PHP示例: '/delwhite?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'ip=192.168.1.1&ts=1609430400', '1234567ABCDEFG', false)).'&ip=192.168.1.1&ts=1609430400'
示例结果: /delwhite?accessid=1&signature=ZTBlYTk4NTljMzViYzIzODE4M2QzMDU4ZTNhZDMwMmQ2OWZkMzMyNw==&ip=192.168.1.1&ts=1609430400
{"success":true,"data":"","msg":"操作成功","code":0}
账户
余额

接口：/info?u=开发者ID

该接口返回用户当前的余额信息

请求参数
参数名类型描述示例
uint开发者ID1
结果数据

类型：对象

属性类型描述示例
balanceint当前账户余额，单位分548
uncountint账户余额中未扣除流量费，单位分10
 
PHP示例: '/info?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'u=1&ts=1609430400', '1234567ABCDEFG', false)).'&u=1&ts=1609430400'
示例结果: /info?accessid=1&signature=YWJjNDkyM2M2YTYyOGEyZTIwMzAyOWIyNzliYTkzNmI5Zjg2NTJkZg==&u=1&ts=1609430400
{"success":true,"data":{"balance":548,"uncount":10},"msg":"操作成功","code":0}
动态套餐余量

接口：/package

该接口返回当前用户的动态套餐余额信息

请求参数
参数名类型描述示例
uint开发者ID1
结果数据

类型：对象

属性类型描述示例
packageobject
[流量包套餐对象 ]		流量包套餐对象{"id":1,"name":"初级套餐","traffic":1,"threads":30,"period":30,"rawprice":5800}
traffic_leftfloat当前剩余可用流量，单位GB1
traffic_totalfloat当前套餐下充值流量总额，单位GB1
用户套餐未过期时多次购买流量包，此数据会累加
thread_totalfloat当前套餐可用独立线路总额30
thread_leftint当前剩余可用独立线路限制30
expire_timeint套餐到期时间戳1685869185
 
PHP示例: '/package?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'u=1&ts=1609430400', '1234567ABCDEFG', false)).'&u=1&ts=1609430400'
示例结果: /package?accessid=1&signature=YWJjNDkyM2M2YTYyOGEyZTIwMzAyOWIyNzliYTkzNmI5Zjg2NTJkZg==&u=1&ts=1609430400
{"success":true,"data":{"package":{"id":1,"name":"初级套餐","traffic":1,"threads":30,"period":30,"rawprice":5800},"traffic_left":1,"traffic_total":1,"thread_total":30,"thread_left":30,"expire_time":1685869185},"msg":"操作成功","code":0,"debug_log":[]}
创建子账户

接口：/addaccount?n=用户名&e=用户邮箱&md5p=md5加密后的密码

该接口可以用于创建代理名下的子账户

创建完成的子账户默认为已激活状态，账密可以用于登录用户后台

用户名和邮箱参数会做系统排重，至少需要传一个

仅代理账户可以调用该接口

请求参数
参数名类型描述示例
nstring用户名[可选参数]testuser (6-32位数字或字母)
不传默认为用户邮箱
estring用户邮箱[可选参数]test@kookeey.com
不传默认为空
md5pstringmd5加密后的密码3b3e9bf9e01962fe4fb9ef658533392e
结果数据

类型：对象

属性类型描述示例
idint用户ID12345678
tokenstring用户的开发者token1234567ABCDEFG
 
PHP示例: '/addaccount?accessid=1&signature='.base64_encode(hash_hmac("sha1", 'u=testuser&e=test@kookeey.com&md5p=3b3e9bf9e01962fe4fb9ef658533392e&ts=1609430400', '1234567ABCDEFG', false)).'&u=testuser&e=test@kookeey.com&md5p=3b3e9bf9e01962fe4fb9ef658533392e&ts=1609430400'
示例结果: /addaccount?accessid=1&signature=NjkyNTdkNTRmODhhZDlhOWE2Y2U4ZDI2ZmVkYjkzOGJmOGYyMmYyNw==&u=testuser&e=test@kookeey.com&md5p=3b3e9bf9e01962fe4fb9ef658533392e&ts=1609430400
{"success":true,"data":{"id":12345678,"token":"1234567ABCDEFG"},"msg":"操作成功","code":0}
API版本更新
v2022.01.18

1、线路信息查询接口新增可选参数c

2、线路列表查询接口新增可选参数s和c

3、[线路信息对象] 结构新增附加属性ip (只针对添加可选参数c的请求，不新增参数时保持原结构不变)

4、新增动态线路释放方法

5、新增结果码80008

v2022.01.20

1、新增当前支持的代理类型列表说明

v2022.03.31

1、订单列表查询接口新增可选参数pi和st

2、线路列表查询接口新增可选参数o和ip

v2022.04.13

1、线路列表查询接口新增可选参数a和sa

2、[线路信息对象] 结构新增附加属性authstr和defaultauth (只针对添加可选参数sa的请求，不新增参数时保持原结构不变)

3、新增设置线路独立安全策略方法

4、新增结果码40010，40011

v2022.05.10

1、地区查询接口添加可选参数c

2、[地区查询接口返回对象] 结构新增附加属性child (只针对添加可选参数c的请求，不新增参数时保持原结构不变)

3、调整强制切换动态线路IP的响应

v2022.06.12

1、新增结果码 40012 、 40013 、 40014

v2022.08.11

1、新增动态线路批量释放方法

2、新增动态线路批量切换动态IP方法

3、新增结果码40017

4、[线路信息对象] 结构新增附加属remark (只针对添加可选参数sa的请求)

v2022.09.20

1、新增设置线路备注的方法

2、新增批量设置线路备注的方法

3、将该文档中，对单条独享代理的表述单位，由端口替换成线路

v2023.05.05

1、新增创建流量分发订单方法

2、新增创建子账户方法

3、新增动态IP提取说明

4、新增动态套餐余量查询方法

5、新增结果码 20004 、 20005 、 40015 、 40016