API 附属公司

阅读您的子公司记录、转介、佣金和付款,修改您的付款设置,并要求支付。在拥有 API 凭证的子公司账户上,每端点都采取行动。

终点 7 endpoints

基本路径 /api/v1/affiliates

终点和调制大小

在账户中创建一个标记, 然后开发者, 并给它下面的端点所需的范围。账户中不是子的, 除了签名之外, 在每个端点上都会收到 404 个。

终点	范围	说明
`GET /affiliates/me/`	`affiliates:read`	联系记录、平衡和转案联系
`GET /affiliates/referrals/`	`affiliates:read`	通过您的链接注册的账户
`GET /affiliates/commissions/`	`affiliates:read`	转介金收入的佣金
`GET /affiliates/payouts/`	`affiliates:read`	要求支付和支付的付款
`PATCH /affiliates/settings/`	`affiliates:update`	更改付款方法、 PayPal email、平方帐户或最低付款额 `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	余额达到最低限额后,要求支付余额。一次只支付一个待付款。
`POST /affiliates/signup/`	`affiliates:create`	加入子程序。以 paypal_ email 或 strase_ account_ id 发送付款_ ethod ( paypal 或 strape) 。

查询、佣金和付款列表都固定下来: 每一个回复都计算, 下一个、之前和结果。使用页面进行移动, 并使用页面大小来改变每页有多少项目。货币值以小数字符串返回。 page_size: 25 (default), 100 (max)

得到 /api/v1/affiliates/me/

获取您的附属记录

示例请求

cURL

Python

JavaScript

curl -X GET "https://admin.vps.org/api/v1/affiliates/me/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests

headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
base = "https://admin.vps.org/api/v1/affiliates"

me = requests.get(f"{base}/me/", headers=headers).json()
print(me["balance"], me["total_earned"])

# Walk every page of commissions
url = f"{base}/commissions/?page_size=100"
while url:
    page = requests.get(url, headers=headers).json()
    for c in page["results"]:
        print(c["created_at"], c["amount"], c["status"])
    url = page["next"]

const res = await fetch('https://admin.vps.org/api/v1/affiliates/me/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});
const me = await res.json();
console.log(me.balance, me.referral_url);

示例回复

{
  "uuid": "9f2c4e7a1b3d4c5e8f6a7b8c9d0e1f2a",
  "user_email": "you@example.com",
  "referral_code": "AB12CD34",
  "referral_url": "https://vps.org/?ref=AB12CD34",
  "status": "active",
  "commission_rate": "20.00",
  "cookie_days": 90,
  "payout_method": "paypal",
  "paypal_email": "you@example.com",
  "stripe_account_id": null,
  "min_payout_amount": "10.00",
  "balance": "42.50",
  "total_earned": "142.50",
  "total_paid": "100.00",
  "created_at": "2026-09-01T12:00:00Z"
}

响应字段

外地	类型	说明
`status`	string	只有活跃子公司才能要求付款。
`commission_rate`	decimal string	占委员会的百分比,不是一小部分 `20.00 = 20%`
`cookie_days`	integer	点击您链接多少天被记住
`balance`	decimal string	收入已赚取但尚未支付
`total_earned` / `total_paid`	decimal string	终身佣金收入和支付终生支付额

转案、委员会和付款

成果中每个项目都有这些领域:

终点	外地
`/affiliates/referrals/`	`uuid, referred_email, status, created_at`
`/affiliates/commissions/`	`uuid, referred_email, amount, rate, original_amount, status, created_at`
`/affiliates/payouts/`	`uuid, amount, method, status, created_at, processed_at, error_message`

移交地位有待处理、正在处理或取消;委员会地位有待处理、核准、支付或取消;付款地位有待处理、完成或失败。

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "3b1e9c0d2a4f4e6b8c7d5e4f3a2b1c0d",
      "referred_email": "customer@example.com",
      "amount": "2.00",
      "rate": "20.00",
      "original_amount": "10.00",
      "status": "approved",
      "created_at": "2026-09-20T08:15:00Z"
    }
  ]
}

响应状态码

200	成功
403	遗失或无效 API 牌标牌, 或者该牌牌缺少必需的许可
404	这个账户还不是子账户

OpenAPP 指定

包括这些点在内的每个端点的机器可读图在下面, 您可以在 API 参考页上交互浏览。

https://admin.vps.org/api/v1/schema/

每一账户的利率限制 : 1000 / hour

VPS.org API