API

Umožňuje komunikaci a výměnu dat. S rozhraním API můžete komunikovat prostřednictvím požadavků HTTP z libovolného jazyka.

Co API umí?

• Zobrazení všech veřejně dostupných informací o serveru

• Seznam hráčů hlasujících pro server za posledních 30 dní

• Aktuální počet hlasů

• Status a další informace serveru (ip adresa, port, motd, verze, mód, hráči/sloty)

• Detailní statistiky - https://mcservery.eu/stats

Nikomu nesdělujte ani neposílejte svůj API klíč. V případě vyzrazení vygenerujte nový – původní přestane být funkční.

Jak API používat?

Získání klíče

Pro používání api je nutné vygenerovat api key který vám zajistí přístup k informacím pro server se kterým je klíč navázaný. Klíč vygenerujete po přihlášení k účtu který je spojený s daným serverem. Je nutné být přihlášený na http://mcservery.eu/login.php

Pro vygenerování klíče si po přihlášení k Vašemu zobrazte detail Vámi přidaného serveru.

Pod popisem serveru naleznete box s názvem „Upravit server“. Zde stačí kliknout na tlačítko vygenerovat api key.

Rate limit

Rate limit je maximální počet API volání, které aplikace nebo uživatel může v určitém časovém období provést. Pokud je tento limit překročen, dojde k zablokování požadavků.

Proč limitujeme počty požadavků?

Je to běžnou praxí pro API a limity jsou zavedeny z několika důvodů:

• Pomáhají chránit API proti zneužití nebo nesprávnému použití. Například útočník by mohl zaplavit API požadavky v pokusu o přetížení serveru.

• Limity pomáhají zajistit, že každý má spravedlivý přístup k API. Pokud jedna osoba nebo aplikace provede nadměrný počet požadavků, mohlo by to zpomalit API pro všechny ostatní.

Jaké limity jsou nastaveny?

Maximum je 10 požadavků během 10 vteřin.

Co se stane pokud limit překročím?

Dojde k blokaci IP adresy ze které jsou požadavky odesílaný. Blokace trvá 10 vteřin.

Pokud narazíte na chybu 429 nebo 1015, znamená to, že jste v krátkém časovém období provedli příliš mnoho požadavků a API odmítá plnit další požadavky, dokud neuplyne stanovené časové období.

Stejné limity se vztahují i na přístup na web, tedy ne jen na API požadavky jako takové.

API reference

Základní informace o serveru

Hlasování

Hlasující hráči za posledních 30 dní

GET http://api.mcservery.eu/players/?api_key=

Zobrazí jednotlivé hlasy podle uživatelského jména a času kdy byl hlas udělen.

Query Parameters

Name	Type	Description
api_key*	String	Klíč pro daný server

200: OK Code 1: Je vyžadován API key

{
    'code'    => 1,
    'message' => 'Je vyžadován API key, dokumentaci naleznete na: https://github.com/McServery/API-Dokumentace'
}

200: OK Code 2: API key je neplatný

{
    'code'    => 2,
    'message' => 'API key je neplatný'
}

200: OK

{ 
  "username": "ArtyomCZ", "time": "2020-08-25 18:38:00"
}

429: Too Many Requests Rate limit

Počet hlasů

GET http://api.mcservery.eu/votes/?api_key=

Zobrazí počet hlasů pro daný server.

Query Parameters

Name	Type	Description
api_key*	String	Klíč pro daný server

200: OK

{
    "Votes": "1"
}

200: OK Code 2: API key je neplatný

{
    'code'    => 2,
    'message' => 'API key je neplatný'
}

200: OK Code 1: Je vyžadován API key

{
    'code'    => 1,
    'message' => 'Je vyžadován API key, dokumentaci naleznete na: https://github.com/McServery/API-Dokumentace'
}

429: Too Many Requests Rate limit

McServery API: Žebříček hlasujících na Váš webmcservery.eu/blog

Pomocí endpointu /players/ lze vytvořit žebříček hlasujících pro Váš server.

Status serveru

Status serveru

GET http://api.mcservery.eu/status/?api_key=

Query Parameters

Name	Type	Description
api_key*	String

200: OK Zobrazí aktuální status serveru

200: OK Code 1: Je vyžadován API key

{
    'code' => 1, 
    'message' => 'Je vyžadován API key, dokumentaci naleznete na: https://github.com/McServery/API-Dokumentace'
}

200: OK Code 2: API key je neplatný

{
    'code' => 2,
    'message' => 'API key je neplatný'
}

200: OK Code 3: Server offline

{
    'code' => 3,
    'message' => 'Server offline'
}

429: Too Many Requests Rate limit

Související články

Přidání nového serveru

Něco nám uniklo?

Nebojte se! Rádi poradíme na Discordu nebo [email protected] ✌️