제휴 API

제휴 기록, 추천, 수수료 및 지불을 읽고 지불 설정을 변경하고 지불을 요청합니다. 각 엔드포인트는 API 토큰을 소유한 제휴 계정에서 작동합니다.

엔드포인트 7 endpoints

기본 경로 /api/v1/affiliates

엔드포인트 및 토큰 범위

Account, Developers에서 토큰을 만들고 아래 엔드포인트가 필요로 하는 범위를 지정합니다. 제휴사가 아닌 계정은 등록을 제외한 모든 엔드포인트에서 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 이메일, Stripe 계정 또는 최소 지불 금액 변경 `min_payout_amount ≥ 10.00`
`POST /affiliates/request-payout/`	`affiliates:create`	최소 잔액에 도달하면 잔액의 지급을 요청하십시오. 한 번에 하나의 대기 지급만.
`POST /affiliates/signup/`	`affiliates:create`	제휴 프로그램에 가입. paypal_email 또는 stripe_account_id와 함께 payout_method (페이팔 또는 스트라이프)를 보내.

추천, 수수료, 지급 목록은 페이지화되어 있습니다: 각 응답은 count, next, previous, results를 가지고 있습니다. page 를 사용하여 페이지를 이동하고 page_size 를 사용하여 각 페이지에 있는 항목의 수를 변경합니다. 돈 값은 소수점 문자열로 반환됩니다. 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	이 계정은 아직 제휴사가 아닙니다.

OpenAPI 사양

이러한 항목을 포함한 각 엔드포인트에 대한 기계 판독 가능한 사양은 아래에 나와 있으며 API 참조 페이지에서 대화식으로 탐색할 수 있습니다.

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

계정당 속도 제한: 1000 / hour

VPS.org API