HTTP API

Goxy udostępnia publiczne HTTP API pod adresem api.goxy.pl dla zewnętrznych integracji. Korzystaj z niego w dowolnym backendzie, bocie, dashboardzie lub skrypcie, który ma czytać lub kontrolować dane sieci - bez uruchamiania pluginu Minecraft.

↔️Szukasz wbudowanego Java SDK?

Ta strona opisuje HTTP API. Jeśli piszesz plugin Bukkit/Spigot/Paper/Velocity działający wewnątrz serwera Minecraft, użyj Plugin API (Java SDK) - daje bezpośredni dostęp bez przechodzenia przez HTTP.

Co jest dostępne

Styl	Endpoint	Najlepsze do
REST	https://api.goxy.pl/	Proste request/response, jednorazowe odczyty, zapisy w stylu komend
GraphQL	https://api.goxy.pl/graphql	Pobieranie dokładnie tych pól, których potrzebujesz, mniej round-tripów, typowany schemat

Oba style udostępniają te same dane - wybierz to, co lepiej pasuje do Twojego stacku.

Interaktywna dokumentacja

Pełna referencja jest dostępna jako żywa, przeglądalna dokumentacja:

Narzędzie	URL	Uwagi
Swagger UI	api.goxy.pl/swagger-ui.html	Klasyczny eksplorator REST z try-it-out
Redoc	api.goxy.pl/docs/redoc.html	Dokumentacja REST w stylu referencji, dobra do czytania
Rapidoc	api.goxy.pl/docs/rapidoc.html	Kompaktowa alternatywa dla viewera REST
GraphiQL	api.goxy.pl/docs/graphiql.html	Interaktywny playground GraphQL z introspekcją schematu

🧪Sprawdź zanim zaczniesz pisać

Zacznij od GraphiQL lub Swagger UI, żeby przejrzeć schemat i zbudować pierwsze zapytanie zanim podepniesz je do swojego kodu.

Kiedy czego użyć

• Użyj Plugin API (Java SDK), gdy jesteś wewnątrz pluginu serwera Minecraft - działa szybciej (in-process), jest mocno typowany i daje dostęp do zdarzeń.
• Użyj HTTP API do wszystkiego, co działa poza serwerem gry: boty Discord, własne dashboardy, integracje billing/CRM, aplikacje mobilne, skrypty monitorujące itd.
• Użyj custom webhooka, jeśli potrzebujesz tylko kontrolować, gdzie gracz trafia przy dołączaniu - to lżejsza alternatywa dla pełnego HTTP API.

Linki

🌐 Nasza strona jest dostępna pod adresem goxy.io

🖥️ Panel Goxy znajdziesz tutaj

⏳ Podejrzewasz awarię? Zajrzyj na naszą stronę statusu

💬 Chcesz wiedzieć więcej o Goxy? Wejdź na Discord

🤩 Zobacz naszą awesome listę

📘 Przeczytaj dokumentację API