Моделі та терміни

Довідник 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.