General

Общие операции (профиль, заказы, справочники)

Создать и оплатить заказ

post

Покупка по имени продукта, локации и циклу. Для Datacenter/ISP — location обязателен. Для Standart Residential Proxy — location не требуется.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

or

or

or

or

Responses

200

Успешно

application/json

successbooleanRequiredExample: true

messagestringRequiredExample: Order paid successfully

order_idintegerRequired

400

Ошибка валидации/баланса/недостаток стока

application/json

401

Неавторизован

application/json

post

/user/api/orders/purchase

HTTPcURLJavaScriptPython

POST /user/api/orders/purchase HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "product": "Datacenter Proxy",
  "location": "DE",
  "cycle": "monthly",
  "quantity": 10,
  "auto_renewal": true
}

datacenterispresidentialStandardresidentialPremiumresidentialNewunmeteredResidentialmobile

{
  "success": true,
  "message": "Order paid successfully",
  "order_id": 1
}

Изменить биллинг-цикл заказа

post

Меняет цикл оплаты по названию цикла. Только для Datacenter & ISP прокси. Если промокод недоступен для выбранного цикла, он будет автоматически сброшен.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

order_idintegerRequired

Body

application/json

cyclestringRequiredExample: monthly

Responses

200

Успешно

application/json

successbooleanOptional

messagestringOptional

orderobjectOptional

400

Неверный продукт или цикл

application/json

401

Неавторизован

application/json

403

Цикл недоступен для этого пользователя

application/json

post

/user/api/orders/change-billing-cycle/{order_id}

HTTPcURLJavaScriptPython

POST /user/api/orders/change-billing-cycle/{order_id} HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "cycle": "monthly"
}

{
  "success": true,
  "message": "text",
  "order": {}
}

Изменить авто-продление заказа

post

Включить/выключить авто-продление. Только для Datacenter & ISP прокси.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

order_idintegerRequired

Query parameters

auto_renewalbooleanRequiredExample: true

Responses

200

Успешно

application/json

successbooleanOptional

messagestringOptional

400

Неверный продукт для операции

application/json

401

Неавторизован

application/json

post

/user/api/orders/edit-auto-renewal/{order_id}

HTTPcURLJavaScriptPython

POST /user/api/orders/edit-auto-renewal/{order_id}?auto_renewal=true HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "message": "text"
}

Получить продукты и их циклы

get

Возвращает продукты для API с названиями доступных циклов.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Список продуктов

application/json

successbooleanRequired

get

/user/api/proxies/products

HTTPcURLJavaScriptPython

GET /user/api/proxies/products HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Список продуктов

{
  "success": true,
  "products": [
    {
      "name": "text",
      "description": "text",
      "location": "text",
      "cycles": [
        "text"
      ]
    }
  ]
}

Узнать доступное количество прокси

get

Возвращает суммарное доступное количество для всех продуктов.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Успешно

application/json

countrystringRequired

productstringRequired

amountintegerRequired

get

/user/api/proxies/available-count

HTTPcURLJavaScriptPython

GET /user/api/proxies/available-count HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Успешно

[
  {
    "country": "text",
    "product": "text",
    "amount": 1
  }
]

Информация о пользователе

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Данные профиля

application/json

emailstringRequired

active_ordersintegerRequired

wallet_balanceintegerRequired

в центах

get

/user/api/me

HTTPcURLJavaScriptPython

GET /user/api/me HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Данные профиля

{
  "email": "text",
  "active_orders": 1,
  "wallet_balance": 1
}

Список заказов

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

statusstringRequired

active | on-hold | cancelled | all

offsetintegerOptional

Смещение выборки (по умолчанию 0)

Example: 0

limitinteger · min: 1 · max: 100Optional

Размер страницы (1..100, по умолчанию 20)

Example: 20

Responses

200

Список заказов

application/json

successbooleanRequired

countintegerOptional

Количество заказов в текущей выборке

prevstring · nullableOptional

URI предыдущей страницы

nextstring · nullableOptional

URI следующей страницы

get

/user/api/orders

HTTPcURLJavaScriptPython

GET /user/api/orders?status=text HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Список заказов

{
  "success": true,
  "orders": [
    {
      "order_id": 1,
      "product_id": 1,
      "product_name": "text",
      "cycle_id": 1,
      "cycle_name": "text",
      "expires_at": "text",
      "auto_renewal": true,
      "tag": "text"
    }
  ],
  "count": 1,
  "prev": "text",
  "next": "text"
}

Получить информацию о заказе

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Responses

200

Информация о заказе

application/json

successbooleanRequired

get

/user/api/orders/{id}

HTTPcURLJavaScriptPython

GET /user/api/orders/{id} HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Информация о заказе

{
  "success": true,
  "order": {
    "order_id": 1,
    "product_name": "text",
    "cycle_name": "text",
    "quantity": 1,
    "price_paid": 1,
    "status": "text",
    "created_at": "text",
    "expires_at": "text",
    "promo_code": "text",
    "auto_renewal": true,
    "tag": "text"
  }
}

Продлить заказ

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Responses

200

Успешно

application/json

successbooleanRequired

400

Недостаточный баланс/валидация

application/json

post

/user/api/orders/{id}/renew

HTTPcURLJavaScriptPython

POST /user/api/orders/{id}/renew HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true
}

Изменить тег заказа

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Body

application/json

tagstringRequiredExample: none

Responses

200

Успешно

application/json

successbooleanRequired

post

/user/api/orders/{id}/tag

HTTPcURLJavaScriptPython

POST /user/api/orders/{id}/tag HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "tag": "none"
}

200

Успешно

{
  "success": true
}