Klucz API

Klucz przekazuje się w nagłówku każdego żądania do API. Po nim usługa rozpoznaje, czyje to konto i na co program ma pozwolenie.

Klucz to takie samo hasło, tylko dla programów. Nie publikuje się go w kodzie na GitHubie ani nie przesyła na czatach. Jeśli klucz trafił w obce ręce, usuwa się go i tworzy nowy.

Prawie każde API ma ograniczenie liczby żądań na minutę na klucz – to ten sam rate limit.

W Prokso klucze tworzy się w panelu („Ustawienia” → „API”), maksymalnie 5 kluczy, i są pokazywane tylko raz. Limit to 60 żądań na minutę na klucz. Opis metod znajdziesz na stronie API.

Co możesz zrobić z kluczem Prokso

• odczytywać saldo, ceny i listę planów z pozostałym transferem;
• pobierać linie proxy dla planu, takie same jak w generatorze w panelu klienta;
• dodawać i usuwać adresy na białej liście IP planu;
• wstrzymywać plan, wznawiać go i zmieniać jego nazwę;
• kupować nowy plan lub dokupywać gigabajty do istniejącego, tylko z salda.

API wydaje tylko pieniądze, które już są na saldzie: doładowanie odbywa się w panelu klienta.

Jak przekazywać i przechowywać klucz

Klucz przekazuje się w nagłówku Authorization: Bearer YOUR_API_KEY lub w X-API-Key. Wszystkie adresy zaczynają się od /api/v1, na przykład żądanie do /api/v1/me zwraca dane konta i saldo. Trzymaj klucz w zmiennej środowiskowej, na przykład PROKSO_KEY, a nie w samym kodzie. Nie wstawiaj go do adresu żądania ani do frontendu strony: trafi wtedy do logów i do kodu strony.

Możesz mieć do 5 kluczy, więc daj każdemu skryptowi lub serwerowi własny klucz. Wtedy, jeśli jeden wycieknie, usuniesz tylko jego, a pozostałe integracje będą działać dalej.

Jak zmieścić się w 60 żądaniach na minutę

Powyżej limitu API odpowiada 429 z nagłówkiem Retry-After: odczekaj podaną liczbę sekund i powtórz żądanie. Nie odpytuj salda ani listy planów co sekundę; do monitorowania wystarczy raz na kilka minut.

Przy zakupach wysyłaj nagłówek Idempotency-Key z unikalną wartością. Jeśli połączenie się zerwie, a Ty powtórzysz żądanie z tym samym kluczem, zakup się nie zdubluje. Wszystkie metody z przykładami są na stronie API.