LVL UP REST API 0.70.docx

Spis treści
Spis treści
Wstęp
Informacje ogólne
Lista funkcji REST API
Autoryzacja
/api/auth/key
/api/auth/check
Usługa Minecraft
/api/mc/list
/api/mc/id/info
/api/mc/id/payments
/api/mc/id/payments/checksms
/api/mc/id/payments/sms
/api/mc/id/restart
/api/mc/id/on
/api/mc/id/off
/api/mc/id/force_off
Kody błędów
Przykładowy kod z użyciem API
Restart serwera przez link
Autorestart dla silnika spigot (bash)
Wstęp
Poniższa specyfikacja może ulec niezapowiedzianej zmianie, obecna wersja (0.73) ma
nadal charakter eksperymentalny i wszelkie opinie oraz uwagi są bardzo mile widziane:
[email protected]
Informacje ogólne
Wyniki zwracane są w formacie JSON.
W przypadku błędu wysyłany jest kod odpowiedzi HTTP inny niż 200.
Lista funkcji REST API
Autoryzacja
/api/auth/key
POST
●
●
login
password
Przykładowy poprawny wynik:
1
Copyright © 2013-2014 LVL UP tel. +48 91 831 00 44, email: [email protected]
{"user_id":"2568","key":"5iMCAjGLkWTNjFKlpyD2WVQ5Tmrs5FUs"}
Przykładowy błędny wynik:
{“error”:”1”,“msg”:”invalid user/password”}
Klucza (pole key) możemy użyć aby autoryzować dostęp do usług przez API.
Klucz do konta umożliwia dostęp do wszystkich usług na danym koncie.
/api/auth/check
POST
●
●
user_id
key
Przykładowy wynik gdy klucz dla użytkownika jest poprawny:
{“valid”:”1”}
Gdy klucz nie jest poprawny:
{“valid”:”0”}
Usługa Minecraft
/api/mc/list
GET
●
●
uid
key
Wypisuje wszystkie ID serwerów minecraft na koncie klienta.
Przykładowy wynik:
[
"5",
"224",
"226",
"3104",
"3853"
]
Opis:
uid: numer klienta
key: klucz api
/api/mc/id/info
GET
2
Copyright © 2013-2014 LVL UP tel. +48 91 831 00 44, email: [email protected]
●
●
uid
key
Zwraca informacje o danym serwerze.
Przykład wyniku dla wyłączonego serwera:
{
"name": "fajnycraft",
"active": "1",
"valid": "1388266693",
"running": "0"
}
oraz dla włączonego:
{
"name": "testcraft",
"active": "1",
"valid": "1388266693",
“bank”: “0.00”,
"running": "1",
"ram": "467",
"players": "0"
}
Opis:
name - nazwa serwera
active - serwer aktywny/nieaktywny, 0 jeśli serwer jeszcze nie był wcześniej aktywny
running - serwer jest włączony/wyłączony
valid - ważność serwera w unix timestamp, 0 jeśli serwer nie był jeszcze aktywny
bank - stan skarbonki serwera w zł
ram - pamięć RAM zużywana przez serwer w MB
players - liczba graczy na serwerze, odświeżane co ok. 1min (jeszcze niedostępne)
/api/mc/id/payments
GET
●
●
uid
key
Lista płatności serwera
Przykładowa treść zwrotna:
[
{
"id": "122",
3
Copyright © 2013-2014 LVL UP tel. +48 91 831 00 44, email: [email protected]
"desc": "Hosting WWW 30dni",
"type": "Opłata",
"amount": "5.00",
"time": "1385403875"
},
{
"id": "135",
"desc": "Janek",
"type": "Dotpay SMS",
"amount": "0.25",
"time": "1386755486",
"code": "7E58A37N"
}
]
Opis:
id: identyfikator płatności w LVL UP
desc: opis płatności, w przypadku zakupu z itemshopu jest to nick gracza
type: typ płatności np. Dotpay SMS lub Opłata
amount: kwota w PLN, w przypadku SMS jest to kwota która trafia na serwer
time: czas w unix timestamp
code: kod płatności np. kod zwrotny z SMS lub ID e-przelewu dotpay
/api/mc/id/payments/checksms
GET
●
●
●
code
number
desc (opcjonalnie)
Umożliwia wdrożenie własnego itemshopu.
Przykładowy wynik gdy kod SMS jeszcze nie został użyty:
{
"valid": 1
}
Gdy kod SMS nie jest ważny, został użyty wcześniej lub numer na który został wysłany się
nie zgadza:
{
"valid": 0
}
W obu przypadkach, jeśli kod nie został wcześniej użyty - skarbonka w lvlup.pro zostanie
doładowana, a opisem transakcji będzie wartość podana jako desc lub “API” w przypadku
gdy do pola nie będzie przekazana wartość.
4
Copyright © 2013-2014 LVL UP tel. +48 91 831 00 44, email: [email protected]
Opis:
code: kod zwrotny SMS
number: numer na który powinen być wysłany SMS
desc: opis płatności np. nick gracza
Przykład linku który sprawdza sms dla serwera o ID 22, na numer 70068 z opisem Kowal55:
https://lvlup.pro/api/mc/22/payments/checksms?number=70068&desc=Kowal55
/api/mc/id/payments/sms
GET
●
●
●
uid
key
code
Umożliwia sprawdzenie informacji o kodzie SMS o ile został już wykorzystany na koncie
serwera,
Przykładowa treść zwrotna gdy taki kod istnieje:
{
desc: "kowal99"
time: 1398628447
amount: 0.25
number: 70068
}
W przypadku gdy takiego kodu nie ma:
{
valid: 0
}
Opis:
code: kod zwrotny SMS
desc: opis płatności, w przypadku zakupu z itemshopu jest to nick gracza
time: czas w unix timestamp
amount: kwota w PLN, jest to kwota która trafia na serwer
number: numer na który został wysłany SMS
5
Copyright © 2013-2014 LVL UP tel. +48 91 831 00 44, email: [email protected]
/api/mc/id/restart
GET
●
●
uid
key
Restartuje serwer
/api/mc/id/on
GET
●
●
uid
key
Włącza serwer
/api/mc/id/off
GET
●
●
uid
key
Wyłącza serwer
/api/mc/id/force_off
GET
●
●
uid
key
Wyłącza serwer siłą zabijając proces z serwerem (może powodować utratę danych)
Powyższe polecenia (restart,on,off,force_off) zwracają w przypadku powodzenia:
{
“error”:0,
}
lub jeśli serwer jest nieaktywny:
{
“error”:1,
“error_code”:3,
}
6
Copyright © 2013-2014 LVL UP tel. +48 91 831 00 44, email: [email protected]
Kody błędów
1.
2.
3.
4.
5.
Niepoprawny lub nieważny klucz i/lub numer klienta
Zły login lub hasło
Serwer nieaktywny
Serwer włączony
Serwer wyłączony
Przykładowy kod z użyciem API
Restart serwera przez link
Dowolnym sposobem otwieramy taki link:
https://lvlup.pro/api/mc/id_serwera/restart?uid=numer_klienta&key=klucz_api
Autorestart dla silnika spigot (bash)
#!/bin/bash
wget -q --tries=1 -T 10 -O /dev/null https://lvlup.pro/api/mc/1111/restart?key=AAAAAAAAA\&uid=1
W pogrubione miejsca wstawiamy swoje dane czyli kolejno ID serwera,klucz oraz numer
klienta.
Kod zapisujemy pod nazwą pliku start.sh i umieszczamy w katalogu obok silnika spigot.
7
Copyright © 2013-2014 LVL UP tel. +48 91 831 00 44, email: [email protected]