API GAMEMONITORING
REST API GAMEMONITORING zwraca dane JSON o serwerach, graczach, wpisach, historii online i głosach. Ta strona opisuje podstawy integracji i pierwsze żądanie. Parametry i testowanie żądań są dostępne na stronach metod.
Wersje API
Wersję API można wybrać za pomocą opcjonalnego parametru zapytania v. Obecna wersja to 1.0.0. Wersja określa dostępne ścieżki, pola żądania i format odpowiedzi.
Bez v używana jest najniższa obsługiwana wersja. Po jej wycofaniu kolejna najniższa wersja staje się domyślna. Podaj v, aby zachować ustalony kontrakt. Nieprawidłowa, powtórzona lub nieobsługiwana wersja zwraca HTTP 400; dla nieobsługiwanej wersji dostępne wartości są w error.data.supported_versions.
Wybierz metodę
Na stronie metody znajdziesz wymagane parametry, schematy odpowiedzi, przykłady dla różnych języków i test żądania. Dodanie serwera wykonuje rzeczywistą operację; publiczne metody odczytu zwracają dane.
Dodaje serwer na podstawie adresu połączenia lub zwraca istniejący serwer.
Zwraca publiczne dane serwera.
Zwraca listę graczy serwera.
Zwraca publiczne posty z widoczną wzmianką o wskazanym serwerze.
Zwraca wykres liczby graczy z minimum, średnią i maksimum dla każdego przedziału.
Zwraca listę głosów na wskazany serwer.
Zwraca liczbę głosów według dni.
Zwraca użytkowników z największą liczbą głosów.
Zwraca minimalną, średnią i maksymalną łączną liczbę graczy na serwerach projektu w każdym przedziale.
Zwraca głosy na projekt. Bez uwierzytelniania dostępne są tylko projekty publiczne.
Zwraca dzienną liczbę głosów na projekt. Bez uwierzytelniania dostępne są tylko projekty publiczne.
Zwraca użytkowników z największą liczbą głosów na projekt. Bez uwierzytelniania dostępne są tylko projekty publiczne.
Zwraca informacje o głosie według jego ID.
Oznacza głos jako przetworzony. Dostępne dla właściciela serwera lub projektu.
Zwraca dane profilu użytkownika.
Aby potwierdzić własność konta GAMEMONITORING, użytkownik pobiera kod w sekcji „Integracja”. Kod jest ważny przez 5 minut od wydania. Po udanej weryfikacji API zwraca identyfikator konta, dla którego wydano kod, i oznacza kod jako wykorzystany.
Przekazywanie parametrów
- Parametry URL
- ID podaje się w ścieżce: server_id i project_id to numeryczne ID GAMEMONITORING, a vote_id identyfikuje głos. Zastąp parametry w nawiasach klamrowych konkretnymi wartościami.
- Parametry zapytania
- Filtry, okresy i paginację podaje się po ? w URL. Koduj wartości przez URLSearchParams lub funkcję swojej biblioteki, szczególnie nicki i tekst wyszukiwania.
- Parametry treści żądania
- Aby dodać serwer, wyślij JSON z Content-Type: application/json. connect to publiczny host:port, a steam_app_id to Steam App ID gry. query jest potrzebny, gdy port zapytań różni się od portu połączenia.
Format danych
HTTP 200 umieszcza wynik w response: obiekt, tablicę lub obiekt z items zależnie od metody. Sprawdź schemat metody; pusta lista sama w sobie nie jest błędem.
Pola mogą być null lub nie występować. To nie to samo co 0, false czy pusty tekst; obsłuż brak danych osobno.
created_at, expires_at i last_update używają czasu Unix w sekundach. Dla JavaScript Date pomnóż przez 1000; dla filtrów podziel Date.now() przez 1000 i zaokrąglij w dół.
Przechowuj 64-bitowe identyfikatory Steam jako tekst. Konwersja na JavaScript Number może utracić precyzję. ID serwera GAMEMONITORING i Steam App ID gry to różne identyfikatory.
Błędy i ponawianie żądań
Sprawdzaj status HTTP i obiekt error: code zawiera kod, message opis, a data dodatkowe dane, jeśli są dostępne. Tekst zależy od regionu i może się zmieniać; nie używaj go jako warunku w kodzie.
- 400
- Nieprawidłowe parametry lub JSON. Sprawdź typy, wymagane pola i dozwolone wartości.
- 403
- Dostęp zabroniony: adres jest zablokowany lub projekt nie jest publiczny.
- 404
- Żądany zasób nie istnieje.
- 405
- Sprawdź metodę HTTP i ścieżkę; ta operacja nie jest obsługiwana.
- 429
- Odczekaj i uwzględnij Retry-After, jeśli nagłówek jest dostępny. Natychmiastowe powtórzenie nie znosi limitu.
- 500 / 503 / 504
- Ponawiaj chwilowo nieudane odczyty ograniczoną liczbę razy z rosnącym odstępem. Po timeout dodania serwera najpierw sprawdź wynik; żądanie mogło się zakończyć.
Przed ponowieniem popraw parametry lub uprawnienia. Obsłuż też błędy sieci i odpowiedzi proxy, które mogą nie zawierać JSON.
Dane pochodzą z ostatniego zapytania do serwera i mogą być buforowane. Sprawdzaj last_update, stosuj rozsądny odstęp odświeżania i buforuj wynik w integracji. Częste pytania do API nie przyspieszają aktualizacji serwera gry.
Głosowanie i Webhook
Skonfiguruj Webhook projektu, aby reagować na nowy głos. Sprawdź signature, pomiń testy is_test=true i użyj event_id jako vote_id do pobrania głosu z API. Sprawdź entity_type i entity_id, a zdarzenie przetwarzaj raz według pary event_type + event_id. Potwierdzaj zdarzenia testowe odpowiedzią 2xx bez przyznawania nagrody.