Dokumentacja API serwisu premium.pl

Dokumentacja API serwisu premium.pl
Wersja 11.09.23
Dokumentacja API serwisu premium.pl
1. Informacje podstawowe
3. Odpowiedź
4. Limity
5. Akcja “info”
6. Akcja “book”
7. Akcja “taste”
8. Akcja “future”
1. Informacje podstawowe
Każde zapytanie do API odbywa się poprzez wysłanie zapytania GET pod adres https://
premium.pl/api/query/[nazwa_akcji]/, przy czym wyróżniamy takie akcje jak:
○
○
○
○
info – pobieranie danych o domenie
book – rezerwacja domeny
taste – zakładanie testów na domenę
future – zakładanie opcji na domenę
Do każdego zapytania należy podać parametry dotyczące autoryzacji oraz specyficzne
parametry dla każdej z akcji.
Parametry autoryzacyjne:
○ uin – 32 znakowy kod dostępu, podany w panelu, w zakładce API
○ id – same cyfry, podany w panelu, w zakładce API
Przykład zapytania:
https://premium.pl/api/query/info/?uin=[uin]&id=[id]&domain=premium.pl
3. Odpowiedź
Odpowiedź na zapytanie powinna być w postaci dokumentu XML. Jeśli tak nie jest,
może to oznaczać, że zapytanie zostało źle sformułowane.
O powodzeniu wykonania operacji informuje nas element <status>wartość</status>.
Może on zawierać dwie wartości: success w przypadku powodzenia bądź error w przypadku
wystąpienia błędu.
Dodatkowe opisy błędów znajdują się w elementach <error id=”KOD_BŁĘDU”
msg=”OPIS_BŁĘDU” />.
4. Limity
Na każde konto w serwisie premium.pl nałożone są limity dotyczące ilości wysłanych
zapytań na dzień, oraz minimalnych odstępów między zapytaniami. Aktualne limity oraz ich
wykorzystanie można sprawdzić w panelu premium w zakładce API.
5. Akcja “info”
Akcja “info” służy do pobierania informacji o domenie.
Parametry akcji:
○ domain – nazwa domeny do sprawdzenia
Odpowiedź:
○ element <info> z parametrami:
■ “avail” - 1, gdy domena jest dostępna do rejestracji lub 0 w przypadku
niedostępności,
■ “reason” - powód niedostępności domeny do rejestracji
6. Akcja “book”
Akcja “book” służy do rezerwacji domeny.
Parametry akcji:
○ domain – nazwa domeny do zarezerwowania
Warunkiem wykonania tej operacji jest podanie prawidłowej nazwy
domeny, której stan pozwala na jej rezerwację.
7. Akcja “taste”
Akcja “taste” służy do zakładania testów na domeny.
Parametry akcji:
○ domain – nazwa domeny, na którą mają zostać założone testy
Warunkiem wykonania tej operacji jest podanie prawidłowej nazwy
domeny, której stan pozwala na założenie na nią testów oraz posiadanie
wystarczającej ilości środków na koncie w panelu premium.pl.
8. Akcja “future”
Akcja “future” służy do zakładania opcji na domeny.
Parametry akcji:
○ domain – nazwa domeny, na którą ma zostać założona opcja.
Warunkiem wykonania tej operacji jest podanie prawidłowej nazwy domeny, której stan
pozwala na założenie na nią opcji oraz posiadanie wystarczającej ilości środków na
koncie w panelu premium.pl.
9. Akcja “setprice”
Akcja “setprice” służy do ustawiania cen domen wystawionych na giełdzie.
Parametry akcji:
○ domain - nazwa domeny
○ value - cena wywoławcza, podawana w pełnych złotówkach
○ value_bn - cena “KupTeraz”, podawana w pełnych złotówkach
Warunkiem wykonania tej operacji jest podanie prawidłowej nazwy domeny, której stan
pozwala na zmianę ceny.