API-ключ

Ключ передають у заголовку кожного запиту до API. За ним сервіс розуміє, чий це акаунт і що програмі дозволено.

Ключ — це той самий пароль, тільки для програм. Його не публікують у коді на GitHub і не пересилають у чатах. Якщо ключ потрапив до чужих рук, його видаляють і створюють новий.

Майже кожне API має обмеження на кількість запитів за хвилину на ключ — це той самий rate limit.

У Prokso ключі створюються в кабінеті («Налаштування» → «API»), до 5 ключів, і показуються один раз. Ліміт — 60 запитів за хвилину на ключ. Опис методів — на сторінці API.

Що можна робити з ключем Prokso

• читати баланс, ціни й список планів із залишком трафіку;
• отримувати рядки проксі для плану — такі самі, як у генераторі в особистому кабінеті;
• додавати й прибирати адреси в доступі за IP (білому списку) плану;
• ставити план на паузу, відновлювати й перейменовувати його;
• купувати новий план або докуповувати гігабайти до наявного — лише з балансу.

API витрачає тільки гроші, що вже є на балансі: поповнення робиться в особистому кабінеті.

Як передавати і зберігати ключ

Ключ передають у заголовку Authorization: Bearer YOUR_API_KEY або в X-API-Key. Усі адреси починаються з /api/v1, наприклад запит до /api/v1/me повертає дані акаунта й баланс. Тримайте ключ у змінній середовища, скажімо PROKSO_KEY, а не в самому коді. Не вставляйте його в адресу запиту чи у фронтенд сайту: там він потрапить у журнали й у код сторінки.

Ключів можна мати до 5, тож дайте кожному скрипту чи серверу власний ключ. Тоді, якщо один витече, ви видалите лише його, а інші інтеграції працюватимуть далі.

Як вкластися в 60 запитів на хвилину

Понад ліміт API відповідає 429 із заголовком Retry-After: почекайте вказану кількість секунд і повторіть запит. Не опитуйте баланс чи список планів щосекунди — для моніторингу досить разу на кілька хвилин.

Для покупок надсилайте заголовок Idempotency-Key з унікальним значенням. Якщо з'єднання обірветься і ви повторите запит з тим самим ключем, покупка не задвоїться. Усі методи з прикладами — на сторінці API.