APIインターフェイスの文書
1. 基本的な情報インターフェイス
1. 現在のユーザー情報の取得
**要求方法:**GET 要求パス:/api/users/me/info
要求変数 なし
退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"data": {
"username": "socks5", //パスワード
"email": "user@example.com", //メール
"api_key": "string", // api キー
"set_password_status": 0 //パスワードを設定するかどうか, 0: 設定されていない, 1: 設定, デフォルト 1
},
"message": "success" //リターン結果、 str のタイプ
}2. ウォレット情報の取得
**要求方法:**GET 要求パス:/api/users/wallet/info
要求変数 なし
退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"data": {
"dc_price": 200, //データセンター通信量単位の価格（セント）
"res_price": 533, //住宅交通ユニット価格(セント)
"mobile_price": 1104, //モバイルトラフィックユニットの価格(セント)
"total_recharge": 136300, //総再充電(セント)
"total_consume": 131300, //総消費量(セント)
"balance": 5000 //バランス(セント)
},
"message": "success" //リターン結果、 str のタイプ
}2. サブアカウント管理インターフェイス
1. サブアカウントの作成
**要求方法:**POST 要求パス:/api/users/subuser/create
要求変数
json
{
"username": "string", //サブアカウント名
"password": "string", //サブアカウントパスワード
"remark": "", //免責事項
"status": "active", //サブアカウントのステータスアクティブ: アクティブ無効: アクティブ
"res_traffic_limit": 0, //住宅のトラフィック制限(GB)、0は制限なし
"dc_traffic_limit": 0, //データセンター通信量の上限（GB）、0は無制限
"mobile_traffic_limit": 0 //モバイルデータ制限(GB)、0は制限なし
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"message": "success" //リターン結果、 str のタイプ
}2. サブアカウントリストを取得する
**要求方法:**GET 要求パス:/api/users/subuser/list
要求変数
json
{
"page": 1, //老化の索引、intのタイプ、任意、デフォルト1
"page_size": 10, //pagination項目、intのタイプ、任意、デフォルト10の数
"user_name": "", //パスワード
"status":"active" //サブアカウントのステータスアクティブ: アクティブ無効: アクティブ
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"data": {
"records": [
{
"id": 0, //サブアカウントID
"username": "string", //サブアカウント名
"password": "string", //サブアカウントパスワード
"remark": "", //免責事項
"status": "active", //サブアカウントのステータスアクティブ: アクティブ無効: アクティブ
"res_traffic_limit": 0, //住宅のトラフィック制限(GB)、0は制限なし
"dc_traffic_limit": 0, //データセンター通信量の上限（GB）、0は無制限
"mobile_traffic_limit": 0, //モバイルデータ制限(GB)、0は制限なし
"used_res_traffic": 0, //住宅交通利用(バイト)
"used_dc_traffic": 0, //使用済みデータセンター通信量（バイト）
"used_mobile_traffic": 0, //使用されるモバイルデータ(バイト)
"create_time": "2025-09-14 06:22:26", //制作時間
"update_time": "2025-09-14 06:22:26" //修正時間
}
],
"total": 0 //合計アイテム数
},
"message": "success" //リターン結果、 str のタイプ
}3. サブアカウントの更新
**要求方法:**POST 要求パス:/api/users/subuser/update
要求変数
json
{
"id": 0, //サブアカウントID、必須
"remark": "string", //注目、任意
"password": "string", //サブアカウントパスワード、オプション
"status": "active", //サブアカウントのステータスアクティブ: アクティブ無効: 起動しない、オプション
"res_traffic_limit": 0, //住宅のトラフィック制限(GB)、0は制限なし、オプションを使用
"dc_traffic_limit": 0, //コンピュータ部屋の交通限界(GB)を使用して下さい、0は任意限界を意味しません
"mobile_traffic_limit": 0 //モバイルデータ制限(GB)、0は制限なし、オプションを使用
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"message": "success" //リターン結果、 str のタイプ
}4. サブアカウント情報の取得
**要求方法:**GET 要求パス:/api/users/subuser/{subuser_id}
要求変数
json
{
"subuser_id": 0 //サブアカウントID、必須
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"data": {
"id": 0, //サブアカウントID
"username": "string", //サブアカウント名
"password": "string", //サブアカウントパスワード
"remark": "", //免責事項
"status": "active", //サブアカウントのステータスアクティブ: アクティブ無効: アクティブ
"res_traffic_limit": 0, //住宅のトラフィック制限(GB)、0は制限なし
"dc_traffic_limit": 0, //データセンター通信量の上限（GB）、0は無制限
"mobile_traffic_limit": 0, //モバイルデータ制限(GB)、0は制限なし
"used_res_traffic": 0, //住宅交通利用(バイト)
"used_dc_traffic": 0, //使用済みデータセンター通信量（バイト）
"used_mobile_traffic": 0, //使用されるモバイルデータ(バイト)
"create_time": "2025-09-14 06:22:26", //制作時間
"update_time": "2025-09-14 06:22:26" //修正時間
},
"message": "success" //リターン結果、 str のタイプ
}3. Whitelistの管理インターフェイス
1. ホワイトリストを入手
**要求方法:**GET 要求パス:/api/users/proxy/whitelist
要求変数
json
{
"page": 1, //老化の索引、intのタイプ、任意、デフォルト1
"page_size": 10, //pagination項目、intのタイプ、任意、デフォルト10の数
"ip": "127.0.0.1" //IPアドレス
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"data": {
"records": [
{
"id": 0, //ホワイトリストID
"ip": "127.0.0.1", //IPアドレス
"remark": "string", //免責事項
"create_time": "2025-09-14 06:49:12" //制作時間
}
],
"total": 0 //合計アイテム数
},
"message": "success" //リターン結果、 str のタイプ
}2. ホワイトリストの追加
**要求方法:**POST 要求パス:/api/users/proxy/add-whitelist
要求変数
json
{
"ip": "127.0.0.1", //必須メールアドレス
"remark": "string" //免責事項
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"message": "success" //リターン結果、 str のタイプ
}3. ホワイトリストの更新
**要求方法:**GET 要求パス:/api/users/proxy/update-whitelist
要求変数
json
{
"id": 1, //ホワイトリストID、必須
"remark": "" //備考, 必須
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"message": "success" //リターン結果、 str のタイプ
}4. ホワイトリストの削除
**要求方法:**GET 要求パス:/api/users/proxy/delete-whitelist
要求変数
json
{
"id":1, //ホワイトリストID、必須
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"message": "success" //リターン結果、 str のタイプ
}4. 交通管理インターフェイス
1. システムトラフィックパケットリストを取得する
**要求方法:**GET 要求パス:/api/users/traffic/packages
要求変数
json
{
"proxy_type":"residential", //通信タイプ、住宅:住宅、データセンター:データセンター、モバイル:モバイル
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"data": {
"additionalProp1": [
{
"id": 0, //交通パッケージID
"traffic_gb": 0, //トラフィック (GB)
"price": 0, //単価(セント)
"duration": 0, //購入時間(日)
"plan_type": "personal", //交通パッケージのタイプ、個人:個人、企業:企業、習慣:カスタマイズされる
"is_hot": false, //それは普及しています, 偽: いいえ, 真実: はい
"extra_add_traffic": 0, //追加の無料トラフィック(GB)
"plan_desc": "string", //交通パッケージの説明
"create_time": "2025-09-14 07:00:23", //制作時間
"update_time": "2025-09-14 07:00:23" //更新時間
}
],
},
"message": "success" //リターン結果、 str のタイプ
}2.システムトラフィックパッケージの購入
注意:ウォレットの控除のみがサポートされますので、十分な残高を確保してください!
**要求方法:**GET 要求パス:/api/users/traffic/packages/purchase
要求変数
json
{
"traffic_package_id":100, //交通パッケージID、必須
"payment_type":"wallet_only" //決済方法、wallet only:ウォレットの支払いが必要
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"message": "success" //リターン結果、 str のタイプ
}3. 購入したトラフィックパッケージを入手
**要求方法:**GET 要求パス:/api/users/traffic/packages/current
要求変数 なし
退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"data": {
"additionalProp1": {
"total_traffic": 0, //トラフィックパケットの合計トラフィック(バイト)
"cost_traffic": 0, //交通パッケージの消費(バイト)
"status": "active", //トラフィックパケットのステータス、アクティブ:有効、非アクティブ:無効
"expire_time": "2025-09-14:32:33", //交通パッケージの有効期限
"remark": "string", //免責事項
"strategy": {
"auto_remind": "inactive", //リマインダーをオンにするかどうか、非アクティブ:オフ、アクティブ:オン
"remind_gb": 1, //残りの残高のリマインダー(GB)
"remind_days": 1, //残り日数制限
"auto_rebuy": "inactive", //自動更新をオンにするかどうか、非アクティブ:オフ、アクティブ:オン
"rebuy_gb": 1, //更新履歴(GB)
"rebuy_days": 1, //リニューアル残り日
"rebuy_package_id": 0, //トラフィックパッケージIDを更新
"rebuy_traffic_gb": 0, //トラフィックパッケージトラフィックの更新(GB)
"rebuy_plan_type": "personal", //更新された交通パッケージのタイプ、個人:個人、企業:企業、習慣:カスタマイズされる
"rebuy_status": "normal" //更新状態、正常:正常、不十分な:不十分なバランス、失敗しました:更新は失敗しました
}
}
},
"message": "success" //リターン結果、 str のタイプ
}4. 過去30日間のメインアカウントのトラフィックの傾向を取得する
注意: 過去30日間のデータのみが取得されます。
**要求方法:**GET 要求パス:/api/users/traffic/trend
要求変数
json
{
"start_date":"2025-09-14", //開始時間、要求される
"end_date":"2025-09-14", //終了時間, 必須
"proxy_type":"residential" //通信タイプ、住宅:住宅、データセンター:データセンター、モバイル:モバイル（任意。未指定時はすべて取得）
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"data": {
"residential": [
{
"proxy_type": "residential", //通信タイプ、住宅:住宅、データセンター:データセンター、モバイル:モバイル
"package_traffic": 0, //交通パッケージの消費(バイト)
"wallet_traffic": 0, //ウォレット消費トラフィック(バイト)
"total_traffic": 0, //消費される総トラフィック(バイト)
"day": "2025-09-07", //新着情報
"remark": "" //免責事項
}
]
},
"message": "success" //リターン結果、 str のタイプ
}5. 過去30日間のサブユーザーのトラフィックの傾向を取得する
注意: 過去30日間のデータのみが取得されます。
**要求方法:**GET 要求パス:/api/users/traffic/{subuser_id}/trend
要求変数
json
{
"subuser_id": 100, //サブユーザーID、必須
"start_date":"2025-09-14", //開始時間、要求される
"end_date":"2025-09-14", //終了時間, 必須
"proxy_type":"residential" //通信タイプ、住宅:住宅、データセンター:データセンター、モバイル:モバイル（任意。未指定時はすべて取得）
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"data": {
"residential": [
{
"proxy_type": "residential", //通信タイプ、住宅:住宅、データセンター:データセンター、モバイル:モバイル
"package_traffic": 0, //交通パッケージの消費(バイト)
"wallet_traffic": 0, //ウォレット消費トラフィック(バイト)
"total_traffic": 0, //消費される総トラフィック(バイト)
"day": "2025-09-07", //新着情報
"remark": "" //免責事項
}
]
},
"message": "success" //リターン結果、 str のタイプ
}5. 静的なプロキシ インターフェイス
1。 静的な住宅の国リストを取得する
**要求方法:**GET 要求パス:/api/users/static/res/country
要求変数 なし
退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"data": [
{
"country_code": "hk", //国コード
"country_name": "Hong Kong" // 国または地域
}
],
"message": "success" //リターン結果、 str のタイプ
}2. 静的データセンターIPとIPv6の国一覧を取得
**要求方法:**GET 要求パス:/api/users/static/dc/country
要求変数
json
{
"ip_type": "ipv4" //IP のタイプ: ipv4/ipv6、必要なデフォルト ipv4、
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"data": [
{
"country_code": "hk", //国コード
"country_name": "Hong Kong" // 国または地域
}
],
"message": "success" //リターン結果、 str のタイプ
}3. 価格リストの取得
**要求方法:**GET 要求パス:/api/users/static/price/package
要求変数
json
{
"proxy_type": "res" //プロキシタイプ: res:静的住宅IP、dc:静的データセンターIP、ipv6: IPv6
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"data": [
{
"id": 0, //エージェントID
"proxy_type": "res", //エージェントタイプ
"count": 0, //数量
"discount": 0, //割引(0-100) 長い
"period": 0, //有効期間(単位:日)
"price": 0, //価格 (単位: cents)
"amount": 0 //数量(単位:cents)
}
],
"message": "success" //リターン結果、 str のタイプ
}4. 静的な順序を作成して下さい
注意:ウォレットの控除のみがサポートされますので、十分な残高を確保してください!
**要求方法:**POST 要求パス:/api/users/static/order/create
要求変数
json
{
"proxy_type": "res", //プロキシタイプ、res:住宅、dc:データセンター、ipv6:IPv6、必須
"country": "us", //国のコード、必須
"protocol": "http", //プロトコル、http、ソックス5、http/socks5、必須
"price_package_id": 0, //価格パッケージID、必須
"payment_type": "wallet_only" //支払いタイプ、wallet only:ウォレットの支払い、必要
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"message": "success" //リターン結果、 str のタイプ
}5. 静的な順序を更新して下さい
注意:ウォレットの控除のみがサポートされますので、十分な残高を確保してください!
**要求方法:**POST 要求パス:/api/users/static/order/rebuy
要求変数
json
{
"proxy_type": "res", //プロキシタイプ、res:住宅、dc:データセンター、ipv6:IPv6、必須
"proxy_ids": "10000,10001", //エージェントIDの更新
"payment_type": "wallet_only" //支払いタイプ、wallet only:ウォレットの支払い、必要
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"message": "success" //リターン結果、 str のタイプ
}6. 静的な住宅 IP のリストを得て下さい
**要求方法:**POST 要求パス:/api/users/static/res/list
要求変数
json
{
"page": 1, //老化の索引、intのタイプ、任意、デフォルト1
"page_size": 10, //pagination項目、intのタイプ、任意、デフォルト10の数
"protocol": "http", //プロトコル、http、socks5、http/socks5
"proxy_address": "127.0.0.1", //IPアドレス
"order_no": "16987AE6182", //注文番号
"expire_start": "2025-09-1412:50:06.43", //有効期限開始時刻
"expire_end": "2025-09-14 12:50:06.43" //有効期限終了時間
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"data": {
"records": [
{
"order_no": "16987AE6182", //注文番号
"order_status": "16987AE6182", //注文状況、保留:設定、完了:完了、返金:返金、変更:変更
"proxy_address": "127.0.0.1", //IPアドレス
"proxy_port": "8080", //ポート番号
"proxy_user": "socks5", //エージェントのユーザー名
"proxy_password": "socks5", //エージェントパスワード
"protocol": "http", //プロトコル、http、socks5、http/socks5
"country": "us", //国コード
"remark": "string", //免責事項
"auto_rebuy": "inactive", //自動更新、非アクティブ: いいえ、アクティブ: はい:
"rebuy_status": "normal", //更新状態、正常:正常、不十分な:不十分なバランス、失敗しました:更新は失敗しました
"expire_time": "2025-09-14 12:57:38.42", //有効期限
"create_time": "2025-09-14 12:57:38.42" //制作時間
}
],
"total": 0 //合計アイテム数
},
"message": "success" //リターン結果、 str のタイプ
}7. 静的データセンターIPとIPv6のプロキシ一覧を取得
**要求方法:**POST 要求パス:/api/users/static/dc/list
要求変数
json
{
"page": 1, //老化の索引、intのタイプ、任意、デフォルト1
"page_size": 10, //pagination項目、intのタイプ、任意、デフォルト10の数
"protocol": "http", //プロトコル、http、socks5、http/socks5
"proxy_address": "127.0.0.1", //IPアドレス
"order_no": "16987AE6182", //注文番号
"expire_start": "2025-09-14 12:50:06", //有効期限開始時刻
"expire_end": "2025-09-14 12:50:06" //有効期限終了時間
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"data": {
"records": [
{
"order_no": "16987AE6182", //注文番号
"order_status": "16987AE6182", //注文状況、保留:設定、完了:完了、返金:返金、変更:変更
"proxy_address": "127.0.0.1", //IPアドレス
"proxy_port": "8080", //ポート番号
"proxy_user": "socks5", //エージェントのユーザー名
"proxy_password": "socks5", //エージェントパスワード
"protocol": "http", //プロトコル、http、socks5、http/socks5
"country": "us", //国コード
"remark": "string", //免責事項
"auto_rebuy": "inactive", //自動更新、非アクティブ: いいえ、アクティブ: はい:
"rebuy_status": "normal", //更新状態、正常:正常、不十分な:不十分なバランス、失敗しました:更新は失敗しました
"expire_time": "2025-09-14 12:57:38.42", //有効期限
"create_time": "2025-09-14 12:57:38.42" //制作時間
}
],
"total": 0 //合計アイテム数
},
"message": "success" //リターン結果、 str のタイプ
}8. 自動更新スイッチを修正
**要求方法:**POST 要求パス:/api/users/static/auto-rebuy
要求変数
json
{
"id": 0, //自動更新ID、必須
"proxy_type": "res", //プロキシタイプ、res:住宅、dc:データセンター、ipv6:IPv6、必須
"auto_rebuy": "inactive" //自動更新スイッチ、非アクティブ:いいえ、アクティブ:はい
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"message": "success" //リターン結果、 str のタイプ
}9. IP の備考の変更
**要求方法:**POST 要求パス:/api/users/static/remark
要求変数
json
{
"id": 0, //必須ID
"proxy_type": "res", //プロキシタイプ、res:住宅、dc:データセンター、ipv6:IPv6、必須
"remark": "string" //備考, 必須
}退去結果
json
{
"code": 0, //ステータスコード、0:成功、その他の番号:失敗、intタイプ
"message": "success" //リターン結果、 str のタイプ
}