Authentication account

Create sub user

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/subAccount/add

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Create a new sub user

Request Example:

{
  "authAccount": "",
  "authPassword": "",
  "ipType": 1,
  "remark": "",
  "useLimit": 0,
  "account": "xx123456@gmail.com",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p"
}

Request Parameters:

Response Status:

Response Parameter:

Not available yet

Response Example:

"success"

Update sub user

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/subAccount/edit

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Update password or traffic limit of specified sub user

Request Example:

{
  "authAccount": "",
  "authPassword": "",
  "account": "xx123456@gmail.com",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p",
  "useLimit": 0,
  "remark": ""
}

Request Parameters:

Response Status:

Response Parameter:

Not available yet

Response Example:

"success"

Delete sub user

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/subAccount/delete

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Delete specified sub user

Request Example:

{
  "authAccount": "",
  "account": "xx123456@gmail.com",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p"
}

Request Parameters:

Response Status:

Response Parameter:

Not available yet

Response Example:

"success"

White List

Add whitelisted IPs

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/ipWhite/add

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Whitelist your IPs here (When allSuccess is true, all IPs are added successfully, allSuccess part is added successfully, repeatIpSelf: own repeat IP, repeatIpOther: repeat IP belonging to others)

Request Example:

{
  "clientIpSet": [],
  "account": "xx123456@gmail.com",
  "remark": "",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p"
}

Request Parameters:

Response Status:

Response Parameter:

Response Example:

{
  "allSuccess": true,
  "repeatIpOther": [],
  "repeatIpSelf": []
}

Get whitelisted IPs

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/ipWhite/page

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Get a list of whitelisted IPs

Request Example:

{
  "account": "xx123456@gmail.com",
  "pageParam": {
    "currentPage": 0,
    "pageSize": 10,
    "param": {
      "clientIp": ""
    }
  },
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p"
}

Request Parameters:

Response Status:

Response Parameter:

Response Example:

{
  "currentPage": 0,
  "data": [
    {
      "addTime": "",
      "clientIp": "",
      "id": "",
      "remark": ""
    }
  ],
  "pageSize": 0,
  "totalCount": 0,
  "totalPage": 0
}

Delete whitelisted IP

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/ipWhite/delete

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Delete a specified whitelisted IP

Request Example:

{
  "clientIpSet": [],
  "account": "xx123456@gmail.com",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p"
}

Request Parameters:

Response Status:

Response Parameter:

Not available yet

Response Example:

boolean

Traffic Query

User account traffic

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/staticMeal/trafficInformation

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Total traffic of user package, used, remaining available

Request Example:

{
  "account": "xx123456@gmail.com",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p"
}

Request Parameters:

Response Status:

Response Parameter:

Response Example:

[
  {
    "autoFlowRenewStatus": 0,
    "autoRenewStatus": 0,
    "beginTime": "",
    "cfpId": "",
    "customerMealNum": "",
    "endTime": "",
    "mealName": "",
    "mealNum": 0,
    "mealTraffic": "",
    "nextTime": "",
    "payment": 0,
    "showTotalFlow": "",
    "showUseFlow": "",
    "totalFlow": 0,
    "useFlow": 0,
    "ipType": 1,
    "webCustomerFlowAddVOList": [
      {
        "payment": "",
        "showTraffic": "",
        "state": 0
      }
    ]
  }
]

Certified Account Traffic

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/certified/traffic

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Authentication account traffic information

Request Example:

{
  "account": "xx123456@gmail.com",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p",
  "pageParam": {
    "currentPage": 0,
    "pageSize": 10,
    "param": {
      "authAccount": ""
    }
  }
}

Request Parameters:

Response Status:

Response Parameter:

Response Example:

{
  "currentPage": 0,
  "data": [
    {
      "authAccount": "",
      "authPassword": "",
      "mainFlag": true,
      "useFlow": 0,
      "useLimit": 0,
      "ipType": 1
    }
  ],
  "pageSize": 10,
  "totalCount": 0,
  "totalPage": 0
}

Authentication account traffic usage

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/useInfo

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Authentication account traffic usage records

Request Example:

{
  "authAccounts": ["xxxxxxxx12"],
  "account": "xx123456@gmail.com",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p",
  "useEndTime": 1666713600000,
  "useStartTime": 1665504000000
}

Request Parameters:

Response Status:

Response Parameter:

Response Example:

{
  "list": [
    {
      "flow": "",
      "useTime": ""
    }
  ],
  "total": ""
}

IP Query

Static residential (ISP) IP list

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/ispIpList

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Static Residential (ISP) IP Information

Request Example:

{
  "customerMealNum": 20221026092733022,
  "account": "xx123456@gmail.com",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p"
}

Request Parameters:

Response Status:

Response Parameter:

Response Example:

[
  {
    "account": "fg89fg5g",
    "cbiId": 1585080658883244034,
    "ip": "10.10.73.3",
    "password": "dx154sg9",
    "port": 40010,
    "ipKind": 1
  }
]

Datacenter IP List

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/datIpList

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Datacenter IP Information

Request Example:

{
  "customerMealNum": 20221026092733022,
  "account": "xx123456@gmail.com",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p"
}

Request Parameters:

Response Status:

Response Parameter:

Response Example:

[
  {
    "account": "fg89fg5g",
    "cbiId": 1585080658883244034,
    "ip": "10.10.73.3",
    "password": "dx154sg9",
    "port": 40010
  }
]

Automatic Renewal

Residential extension

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/checkBalance

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Increased traffic after renewal of dynamic residential package and increased package usage time

Request Example:

{
  "customerMealNum": 20221026092733022,
  "account": "xx123456@gmail.com",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p"
}

Request Parameters:

Response Status:

Response Parameter:

Not available yet

Response Example:

true

Traffic recharge

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/addFlow

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Dynamic residential package traffic recharge

Request Example:

{
  "buyFlow": 10,
  "customerMealNum": 20221012103411116,
  "account": "xx123456@gmail.com",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p"
}

Request Parameters:

Response Status:

Response Parameter:

Not available yet

Response Example:

true

Renew by IP

Renew by IP

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/renew/ip

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:After purchasing a static residential ISP or data center package, choose IP renewal within the package.

Request Example:

{
  "account": xx123456@gmail.com,
  "ips": ["10.10.73.3", "10.10.73.4"],
  "mealId": 96,
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p"
}

Request Parameters:

Package ID:

Response Status:

Response Parameter:

Not available yet

Response Example:

true

Get orders

Get Residential Proxies orders

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/queryMain

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Residential Proxies orders Information

Request Example:

{
  "account": "xx123456@gmail.com",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p",
  "pageParam": {
    "currentPage": 0,
    "pageSize": 10,
    "param": {
      "mealType": "1"
    }
  }
}

Request Parameters:

Response Status:

Response Parameter:

Response Example:

{
  "currentPage": 0,
  "data": [
    {
      "customerMealNum": "20221025102345424",
      "mealOrderId": "1584732415862390786",
      "orderTime": "1666664625423",
      "orderType": "1",
      "ipType": 1,
      "payTime": "1666664671413",
      "payment": "100.00",
      "state": "1"
    }
  ],
  "pageSize": 10,
  "totalCount": 0,
  "totalPage": 0
}

Get Static Residential Proxies (ISP) orders

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/queryMain

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Static Residential Proxies (ISP) orders Information

Request Example:

{
  "account": "xx123456@gmail.com",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p",
  "pageParam": {
    "currentPage": 0,
    "pageSize": 10,
    "param": {
      "mealType": "2"
    }
  }
}

Request Parameters:

Response Status:

Response Parameter:

Response Example:

{
  "currentPage": 0,
  "data": [
    {
      "mealOrderId": "1584732415862390786",
      "orderTime": "1666664625423",
      "orderType": "1",
      "payTime": "1666664671413",
      "payment": "100.00",
      "state": "1"
    }
  ],
  "pageSize": 10,
  "totalCount": 0,
  "totalPage": 0
}

Get Datacenter Proxies orders

Interface Address:https://api.okeyproxy.com/ipglobal-api/api/queryMain

Request Method:POST

Request Data Type:application/json

Response Data Type:*/*

Interface Description:Datacenter Proxies orders Information

Request Example:

{
  "account": "xx123456@gmail.com",
  "token": "3ccpa01bxz5aed0de1uvenpzqaq78p",
  "pageParam": {
    "currentPage": 0,
    "pageSize": 10,
    "param": {
      "mealType": "3"
    }
  }
}

Request Parameters:

Response Status:

Response Parameter:

Response Example:

{
  "currentPage": 0,
  "data": [
    {
      "mealOrderId": "1584732415862390786",
      "orderTime": "1666664625423",
      "orderType": "1",
      "payTime": "1666664671413",
      "payment": "100.00",
      "state": "1"
    }
  ],
  "pageSize": 10,
  "totalCount": 0,
  "totalPage": 0
}