Documentation has been updated: Find all product details, Web Scraper API targets, and integrations in their dedicated sections
Ctrlk
Access Oxylabs dashboard
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Public API

通过 Public API 以编程方式管理移动代理子用户、设置流量限制并跟踪使用统计。

该 Public API 使您能够 以编程方式管理代理用户 无需使用仪表盘。您可以创建、删除和修改代理子用户，设置流量使用限制，并查看移动代理的当前和历史流量使用情况。

可用路径

基础端点： https://residential-api.oxylabs.io/v2

将基础端点与路径组合以执行特定操作：

方法
路径
说明

POST

/login

进行身份验证以获取访问令牌（JWT）。

GET

/users/{userId}/sub-users

检索所有活跃子用户

POST

/users/{userId}/sub-users

创建一个新的子用户。

GET

/users/{userId}/sub-users/{subUserId}

检索特定子用户的流量使用统计信息。

PATCH

/users/{userId}/sub-users/{subUserId}

修改子用户。

DELETE

/users/{userId}/sub-users/{subUserId}

删除子用户。

GET

/users/{userId}/sub-users/{subUserId}/target-stats

检索子用户按目标划分的流量使用统计信息。需要您指定日期（可用最近 30 天）。

GET

/users/{userId}/client-stats

检索当月总流量使用情况。

如何使用 Public API

通过 Web 界面测试

1. 授权您的主用户

如果您通过 Public API 界面测试该功能，请点击 授权 按钮。

接下来，在新打开的窗口中输入您的主代理用户凭据，然后再次选择 授权 。

主用户是 第一个子用户 在您的 用户列表.

2. 登录以生成 JWT

授权后，前往 POST /login 选项卡以生成完成授权所需的 JSON Web Token（JWT）。

然后，选择 试用 → 执行。保存 user_id 和 token 值以供后续使用。

JWT 在 1 小时后过期。之后，您需要生成一个新的。

如果您最近更改了主用户的密码，您会收到错误。要处理这种情况，您必须 使用您的原始密码 或 联系我们的 24/7 支持团队 通过 在线聊天 或 电子邮件.

3. 使用 JWT 完成授权

再次打开 授权 窗口，并将 粘贴令牌 从上一步获取的内容粘贴到 JWT Token 身份验证字段中。然后，点击 授权 按钮以保存。

4. 测试 Public API

您现在可以在浏览器中测试 Public API 端点。对于每个端点，您都需要输入 user_id，在步骤 2 中获取。

1

登录并生成 JWT

使用基本身份验证，使用您的主用户凭据（以 base64 编码）登录，以接收 JWT 令牌。

主用户是 第一个子用户 在您的 用户列表.

端点： https://residential-api.oxylabs.io/v2/login

请求头： Authorization: Basic base64(username:password)

curl -X "POST" \
  "https://residential-api.oxylabs.io/v2/login" \
  -H "accept: application/json" \
  -u "USERNAME:PASSWORD"

如果您最近更改了主用户的密码，您会收到错误。要处理这种情况，您必须 使用您的原始密码 或 联系我们的 24/7 支持团队 通过 在线聊天 或 电子邮件.

执行后，服务器将返回 两个重要的值 供后续步骤使用：

  • user_id 是 API 请求所需的唯一用户标识符。

  • token 是进一步授权所需的 JSON Web Token（JWT）。

输出示例：
{
  "user_id": "00000000-0000-0000-0000-000000000000",
  "token": "example token"
}

JWT 在 1 小时后过期。之后，您需要生成一个新的。

2

使用 token 和 user_id 发起请求

您现在可以查询 API 来管理用户并检查统计信息。所有后续请求都需要 JWT token 以及您的 user_id.

请求头： Authorization: Bearer {token}

例如，让我们检查当月总流量使用情况。

curl -X "GET" \
  "https://residential-api.oxylabs.io/v2/users/{userId}/client-stats" \
  -H "accept: application/json" \
  -H "Authorization: Bearer {token}"
输出示例
{
  "traffic": 1.2354839,
  "date_from": "2026-01-01",
  "date_to": "2026-01-15"
}

Backonnect 入口 IP

如果您想使用自己的 backconnect 入口节点 DNS 名称，您可以将您的子域名/域名指向我们的入口节点。为此，您需要添加一条 DNS CNAME 记录，并将 pr.oxylabs.io 设为目标。这是在 Cloudflare DNS 管理器中为 entry 子域名进行此类设置的样子：

Backconnect

如需更多信息，请联系 support@oxylabs.io 或您的客户经理。

上一页受限目标下一页响应代码

这有帮助吗？