使用公共 API 编程化管理住宅代理子用户、设置流量限制并跟踪使用统计。
该 公共 APIarrow-up-right 使您能够 以编程方式管理代理用户 而无需使用仪表板。您可以创建、删除和修改代理子用户，设置流量使用限制，并查看当前和历史流量使用情况。
基础端点： https://residential-api.oxylabs.io/v2
https://residential-api.oxylabs.io/v2
将基础端点与路径组合以执行特定操作：
POST
/login
进行身份验证以获取访问令牌（JWT）。
GET
/users/{userId}/sub-users
检索所有活动子用户
创建新子用户。
/users/{userId}/sub-users/{subUserId}
检索特定子用户的流量使用统计。
PATCH
修改子用户。
DELETE
删除子用户。
/users/{userId}/sub-users/{subUserId}/target-stats
检索子用户按目标的流量使用统计。需要指定日期（可用最近 30 天）。
/users/{userId}/client-stats
检索当月的总流量使用情况。
如果您通过 公共 APIarrow-up-right 界面测试该功能，请点击 授权 按钮。
接下来，在新打开的窗口中输入您的主代理用户凭据并再次选择 授权 。
主用户是 您的第一个子用户 在您的 用户列表arrow-up-right.
授权后，导航到 POST /login 选项卡以生成用于完成授权的 JSON Web Token (JWT)。
然后，选择 试一试 → 执行。保存 user_id 和 token 值以备后用。
user_id
token
JWT 在 1 小时后过期。之后，您需要生成新的令牌。
如果您最近更改了主用户的密码，则会收到错误。为了解决此问题，您必须 使用原始密码 或 通过我们的 24/7 支持团队联系 通过 在线聊天 arrow-up-right或 电子邮件envelope.
再次打开 授权 窗口并 将上一步中的令牌粘贴到 JWT Token 身份验证字段。然后，点击 按钮以保存。 授权 4. 测试公共 API
，在步骤 2 中获取。 user_id登录并生成 JWT
端点：
https://residential-api.oxylabs.io/v2/login Header:
Header:
Authorization: Basic base64(username:password) curl -X "POST" \
curl -X "POST" \
"https://residential-api.oxylabs.io/v2/login" \ -H "accept: application/json" \ -u " USERNAME:PASSWORD替换为您的"
两个重要值 用于后续步骤： 是 API 请求所需的唯一用户标识符。
user_id 是进一步授权所需的 JSON Web Token (JWT)。
token 输出示例：
{ "token": "示例令牌" 在请求中使用 }
Authorization: Bearer {token} token 例如，让我们检查本月的总流量使用情况。 user_id.
Authorization: Basic base64(username:password) curl -X "GET" \
curl -X "GET" \
"https://residential-api.oxylabs.io/v2/users/
{userId} /client-stats" \-H "Authorization: Bearer{token} -u " 替换为您的 JWT 输出示例"
{ "date_to": "2026-01-15" Backonnect 入口 IP 如果您想使用您自己的 backconnect 入口节点 DNS 名称，您可以将您的子域/域指向我们的入口节点。为此，您需要添加一个 DNS }
记录，目标为 pr.oxylabs.io 。在 Cloudflare DNS 管理器中，此类设置在 入口 子域上的展示如下： Backconnect 如需更多信息，请联系
pr.oxylabs.io
入口
Backconnect
或您的客户经理。 或您的客户经理。envelope 或您的客户经理。
最后更新于9天前
这有帮助吗？
