API
API 密钥与权限
API 密钥在所授予的权限范围内,从程序或 AI 客户端操作账户。密钥不能修改密码和邮箱、删除账户或创建其他密钥。
更新于 2026年11月22日
创建密钥#
在控制台打开 API 密钥
API 密钥,然后点击 创建密钥。
填写名称并选择权限
密钥可购买时须设置每日限额。可选设置有效期和允许的 IP 列表。
用账户密码确认
通过 Google 登录的账户使用发送到账户邮箱的 6 位验证码确认,验证码 10 分钟内有效。
复制密钥
密钥只显示一次。Proxya 只保存其哈希值,无法再次显示。
密钥以 proxya_ 开头,共 53 个字符。凭此前缀,密钥扫描工具可以识别误公开的密钥。
权限#
每个密钥拥有四种权限中的一种或多种。调用需要密钥所缺权限的接口时返回 403。
| 权限 | 开放内容 |
|---|---|
| read | 余额、订单、价格、库存、住宅流量、白名单与指纹状态。代理的用户名、密码和链接返回为空,订单带有 credentials_hidden: true。 |
| credentials | 所有可用于连接代理的内容:用户名、密码和链接,生成住宅代理,移动设备 VPN 配置,向 IP 白名单添加地址,以及移动设备的 IP 授权。 |
| purchase | 新订单、续费和恢复,在密钥每日限额内从余额扣款。 |
| manage | 不授予访问权的设置:更换代理密码(新密码仅对同时拥有 credentials 的密钥显示)、移动代理换 IP、系统指纹、订单备注、从白名单移除地址。 |
每日限额#
- 拥有 purchase 权限的密钥必须设置每日限额,范围 1 至 100 000 USD。
- 限额统计该密钥在任意 24 小时内的扣款金额。退款不会恢复限额。
- 超出限额的购买返回
400,不扣款。 - 在控制台的购买不计入任何密钥的限额。
有效期与允许的 IP#
- 有效期:30、90、180 或 365 天,或永久有效。过期后密钥返回
401。 - 允许的 IP:最多 20 个地址或 CIDR 子网,支持 IPv4 和 IPv6。来自其他地址的请求返回
403。 - 如果程序通过代理访问 API,API 看到的是代理的地址。请添加该地址,或不经代理访问 API。
通知与请求日志#
- 创建密钥时,账户会收到控制台通知和邮件,包含密钥名称、权限和创建时的地址。
- 密钥首次从新地址使用时,账户会收到控制台通知,每天最多 5 条。
- 每个使用密钥的请求都会记录时间、方法、路径、状态码和地址。日志在控制台的密钥行中查看,保留 90 天。
撤销密钥#
点击密钥行中的 撤销 后,密钥立即失效。正在执行的请求会完成,新请求返回 401。
在控制台修改密码、通过邮件链接重置密码或由客服重置密码时,账户的所有密钥会被自动撤销。通过 Google 登录的账户首次设置密码不会撤销密钥。
保管密钥#
- 将密钥保存在环境变量或密钥管理服务中,不要写入代码或代码仓库。
- 为每个程序单独创建密钥,只授予所需权限。
- 每日限额设为正常用量即可。
- 如果密钥可能已泄露,请撤销并创建新密钥。
每个账户最多 10 个有效密钥。
没有找到答案?
网站在线客服 24 小时回复。通过 Telegram 联系通常最快,提交工单会通过邮件回复。