Модели и термины

Справочник API — источник истины для типов полей и примеров. Здесь описаны связи между моделями.

Основные модели

Модель	Назначение
User	Авторизованный аккаунт, баланс, лимиты, скидка и настройки
UserPreferences	VPN-хост, прокси-хост и протокол по умолчанию
Plan	Доступный продукт со страной, остатками, VPN и вариантами тарификации
PlanTarification	Длительность в секундах, трафик в МБ и цена в центах
Port	Мобильный прокси, статус, IP, тариф, доступ и учетные данные
PortPlan	Тариф, примененный к конкретному порту
PortCredentials	Список разрешенных IP и пары логин/пароль
GeoIP	Локация и провайдер текущего IP порта
PortLog	Действие, причина, источник, детали и время события
PaymentHistoryRecord	Статус и изменение баланса аккаунта в центах
Server	Имя сервера и код страны
Error	Читаемая строка error

Важные единицы

• Деньги передаются целыми центами.
• Трафик измеряется в мегабайтах.
• Срок тарифа и интервал автосброса измеряются в секундах.
• Время передается строками в стиле RFC 3339.
• Страны задаются кодами; сохраняйте значение из API.

Статусы порта

Контракт v2 перечисляет active, reset, suspended, disconnected и outoftraffic. Клиент должен безопасно показывать новое неизвестное значение, а не отклонять весь объект.

Статус описывает текущий снимок порта, но сам по себе не подтверждает завершение запрошенной смены IP. Сравнивайте ip или обрабатывайте события port.ip_changed.

Идентификаторы и токены

Значение	Где использовать
Port.port	Передавайте этот публичный номер порта как {id} в маршрутах /ports/{id}
{id}	Параметр пути; в публичных маршрутах портов содержит Port.port
resetToken	Передавайте только как {token} в GET /tokens/{token}
Внутренний ObjectID или ID услуги	Не используйте в публичных маршрутах портов

Все маршруты остаются ограничены авторизованным аккаунтом. Ни номер порта, ни resetToken не заменяют bearer API-токен.