公共 API

使用公共 API 编程化管理移动代理子用户、设置流量限制并跟踪使用统计。

该 公共 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

检索当前月份的总流量使用。

如何使用公共 API

通过网页界面测试

1. 授权您的主用户

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

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

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

2. 登录以生成 JWT

授权后，导航到 POST /login 选项卡以生成完成授权所需的 JSON Web 令牌（JWT）。

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

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

如果你最近更改了主用户的密码，会收到错误。为了解决此问题，你必须 使用原始密码 或 通过我们的 24/7 支持团队联系 通过实时聊天或电子邮件.

3. 使用 JWT 完成授权

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

4. 测试公共 API

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

登录并生成 JWT

使用 Basic Authentication 以主用户的凭据登录（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"

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

user_id 是 API 请求所需的唯一用户标识符。
token 是后续授权所需的 JSON Web Token (JWT)。

输出示例：

{
  "user_id": "00000000-0000-0000-0000-000000000000",
  "token": "example token"
}

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

使用 `token` 和 `user_id` 使用 requests

您现在可以查询 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 管理器中此类设置的示例，适用于 入口 子域：

如需更多信息，请联系 [email protected] 或您的客户经理。

最后更新于7天前

这有帮助吗？

早上好

hashtag可用路径

hashtag如何使用公共 API

hashtag1. 授权您的主用户

hashtag2. 登录以生成 JWT

hashtag3. 使用 JWT 完成授权

hashtag4. 测试公共 API

hashtag登录并生成 JWT

hashtag使用 token 和 user_id 使用 requests

hashtagBackonnect 入口 IP

可用路径

如何使用公共 API

1. 授权您的主用户

2. 登录以生成 JWT

3. 使用 JWT 完成授权

4. 测试公共 API

登录并生成 JWT

使用 `token` 和 `user_id` 使用 requests

Backonnect 入口 IP