Dokumentacja API

Zasady integracji projektów z portalem, format danych i ścieżka do zostania twórcą.

Zostań Twórcą
Zaloguj się, aby złożyć zgłoszenie o zostanie Twórcą lub zarządzać swoimi projektami.
Dokumentacja API

Po co jest to API?

Jeśli przygotujesz endpoint API i podasz go w swoim projekcie jako źródło danych, nasz system będzie cyklicznie pobierał z tego endpointu informacje takie jak newsy i statystyki gry (dla API w formacie JSON), co pozwoli innym lepiej ją poznać.

System automatycznie wykrywa typ Twojego API (JSON, RSS lub HTML) i regularnie pobiera najnowsze dane zgodnie z ustawionym interwałem (od 5 minut do miesiąca). Wszystkie pobrane informacje są wyświetlane na stronie Twojego projektu, dzięki czemu użytkownicy portalu mogą na bieżąco śledzić aktualności i statystyki Twojej gry bez konieczności odwiedzania bezpośrednio Twojej strony.

Dzięki integracji z naszym portalem, Twoja gra zyskuje większą widoczność w społeczności graczy RPG, a użytkownicy mają łatwy dostęp do najważniejszych informacji o Twoim projekcie w jednym miejscu.

Format JSON

System obsługuje trzy formaty danych: JSON, RSS i HTML. Poniżej znajdziesz przykładowy format JSON, który pozwala na przekazanie zarówno newsów, jak i statystyk gry.

{
  "game": {
    "title": "Nazwa gry",
    "url": "https://example.com",
    "description": "Opis gry",
    "tags": ["mmorpg", "postapo"],
    "stats": {
      "registered": 1000,
      "online": 50
    }
  },
  "news": [
    {
      "title": "Tytuł newsa",
      "pubDate": "2025-01-15 12:00:00",
      "description": "<p>Opis w formacie HTML</p>",
      "coverImage": "https://example.com/image.jpg"
    }
  ]
}

Format RSS

System może również pobierać dane z RSS feed. RSS powinien zawierać standardowe pola:

  • title - Tytuł newsa
  • pubDate - Data publikacji
  • description lub content - Treść (HTML)
  • image lub enclosure - Obrazek

Uwaga: W przypadku RSS system pobiera tylko newsy, bez danych o grze i statystykach.

Format HTML

System może również pobierać newsy bezpośrednio ze strony HTML poprzez scrapowanie. Wymaga to skonfigurowania selektorów CSS, które wskazują na odpowiednie elementy strony zawierające tytuły, treści, daty i obrazy newsów.

Uwaga: W przypadku HTML system pobiera tylko newsy, bez danych o grze i statystykach. Scrapowanie HTML wymaga ręcznej konfiguracji selektorów CSS w panelu edycji projektu.

Interwały pobierania danych

Jako twórca projektu możesz ustawić częstotliwość pobierania danych z Twojego API. System automatycznie sprawdza, czy minął ustawiony interwał i pobiera najnowsze dane. Dostępne interwały:

  • 5 minut - dla projektów wymagających bardzo częstych aktualizacji
  • 15 minut - dla projektów z regularnymi aktualizacjami
  • 30 minut - dla projektów z umiarkowaną częstotliwością aktualizacji
  • Godzina - domyślny interwał, odpowiedni dla większości projektów
  • Dzień - dla projektów z codziennymi aktualizacjami
  • Tydzień - dla projektów z cotygodniowymi aktualizacjami
  • Miesiąc - dla projektów z rzadkimi aktualizacjami

Interwał można zmienić w dowolnym momencie w panelu administracyjnym projektu.

Wymagania

  • URL musi być dostępny publicznie (bez autoryzacji)
  • Dane muszą być w formacie UTF-8
  • Dla JSON: wszystkie pola są wymagane
  • Dla RSS: format zgodny ze standardem RSS 2.0
  • System automatycznie wykrywa typ API na podstawie odpowiedzi

Tip: Jeśli jesteś twórcą i chcesz dodać swój projekt, zaloguj się i przejdź do Panelu Twórcy, a następnie wybierz zakładkę Projekty.