Catproxy Developer Documentation

Публичный API Catproxy предоставляет программный доступ ко всему, что доступно в дашборде: создание и настройка прокси, отслеживание использования, управление балансом и поиск геоданных - всё через HTTPS с JSON.

Интерактивный Swagger UI

Изучайте и тестируйте каждый эндпоинт прямо в браузере.

Коллекция Postman

Импортируйте готовую коллекцию и начните делать запросы за несколько минут.

Базовый URL

Все запросы к API отправляются на:

https://api.catproxy.io

Аутентификация

API использует API-ключи, передаваемые в заголовке запроса. Каждый запрос должен содержать:

X-API-Key: cat_YOUR_API_KEY

Как получить API-ключ:

Откройте Панель управления и перейдите в раздел API-ключи в боковом меню.
Нажмите Создать API‑ключ и выберите необходимые разрешения.
Скопируйте ключ - он отображается только один раз.

API-ключи являются секретными данными. Не коммитьте их в репозиторий и не используйте в клиентском коде. При утечке ключа немедленно его отзовите.

Разрешения

Каждый API-ключ содержит одно или несколько разрешений, ограничивающих доступ к группам эндпоинтов. Запрашивайте только те разрешения, которые нужны вашей интеграции.

Разрешение	Предоставляет доступ к
`proxies:read`	Просмотр списков прокси и их настроек
`proxies:write`	Создание, изменение и удаление прокси
`stats:read`	Просмотр статистики трафика и экспорт отчётов об использовании
`balance:read`	Просмотр баланса аккаунта, истории транзакций и доступных тарифов
`geo:read`	Доступ к геокаталогу (страны, штаты, города, ZIP‑коды)

proxies:write не включает proxies:read - разрешения независимы.

Формат запроса

Для эндпоинтов, принимающих тело запроса (POST, PUT), отправляйте JSON и указывайте заголовок Content-Type:

Content-Type: application/json

Формат ответа

Все ответы возвращаются в виде JSON со стандартной обёрткой:

{
  "result": true,
  "data": { ... },
  "error": "",
  "error_type": "",
  "meta": {}
}

Поле	Тип	Описание
`result`	boolean	`true` при успехе, `false` при ошибке
`data`	object / array	Полезная нагрузка ответа
`error`	string	Читаемое сообщение об ошибке (пустое при успехе)
`error_type`	string	Машиночитаемый код ошибки (пустой при успехе)
`meta`	object	Пагинация и прочие метаданные

Обработка ошибок

Ответы с ошибками используют стандартные HTTP-коды статуса:

{
  "result": false,
  "error": "API key not found or expired",
  "error_type": "unauthorized"
}

HTTP-статус	Значение
`400 Bad Request`	Некорректный запрос - проверьте тело запроса или параметры
`401 Unauthorized`	Отсутствующий или недействительный API-ключ
`403 Forbidden`	Действительный ключ, но недостаточно разрешений
`404 Not Found`	Запрошенный ресурс не существует

Быстрый пример

Получите список всех своих прокси одним запросом curl:

curl https://api.catproxy.io/v1/proxy \
  -H "X-API-Key: cat_YOUR_API_KEY"

Полный интерактивный справочник по всем эндпоинтам, включая схемы запросов и живые примеры ответов, доступен в Swagger UI.

Интерактивный Swagger UI

Коллекция Postman

​Базовый URL

​Аутентификация

​Разрешения

​Формат запроса

​Формат ответа

​Обработка ошибок

​Быстрый пример

Базовый URL

Аутентификация

Разрешения

Формат запроса

Формат ответа

Обработка ошибок

Быстрый пример