Dokumentacja REST API
Kompleksowa dokumentacja REST API do zarządzania serwerami, monitoringu, backupami, fakturami i wszystkimi zasobami w SKY-VM. Pełna kontrola nad infrastrukturą z poziomu kodu.
Szybki start
Uwierzytelnianie
Wszystkie żądania API wymagają klucza API w nagłówku Authorization. Klucz API możesz wygenerować w panelu użytkownika w sekcji Ustawienia → Klucze API.
Format nagłówka:
Authorization: Bearer YOUR_API_KEYWażne
Nigdy nie udostępniaj swojego klucza API publicznie. Traktuj go jak hasło i przechowuj bezpiecznie w zmiennych środowiskowych.
Przykłady użycia w różnych językach
curl -X GET "https://api.sky-vm.eu/v1/servers" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json"
Base URL
Wszystkie endpointy API są dostępne pod adresem:
https://api.sky-vm.eu/v1Endpointy API
Zarządzanie serwerami
Akcje serwera
Backup i przywracanie
Monitoring i metryki
Sieć i DNS
Faktury i płatności
Klucze API
Wsparcie techniczne
Kody błędów
API SKY-VM używa standardowych kodów statusu HTTP oraz własnych kodów błędów dla lepszej identyfikacji problemów:
UNAUTHORIZEDNieprawidłowy lub brakujący klucz API
FORBIDDENBrak uprawnień do wykonania tej operacji
NOT_FOUNDZasób nie został znaleziony
VALIDATION_ERRORNieprawidłowe dane wejściowe
RATE_LIMIT_EXCEEDEDPrzekroczono limit zapytań
INSUFFICIENT_FUNDSNiewystarczające środki na koncie
SERVER_RUNNINGOperacja niemożliwa - serwer jest uruchomiony
SERVER_OFFLINEOperacja niemożliwa - serwer jest wyłączony
ALREADY_RUNNINGSerwer jest już uruchomiony
ALREADY_STOPPEDSerwer jest już zatrzymany
BACKUP_IN_PROGRESSTrwa już tworzenie kopii zapasowej
BACKUP_NOT_ENABLEDFunkcja backupu nie jest włączona
MONITORING_NOT_ENABLEDMonitoring nie jest włączony
LIMIT_REACHEDOsiągnięto maksymalny limit zasobów
INTERNAL_ERRORWewnętrzny błąd serwera
Limity zapytań
Rate Limiting
API SKY-VM implementuje limity zapytań aby zapewnić stabilność i dostępność dla wszystkich użytkowników:
100 zapytań/minutę
dla standardowych endpointów (GET, LIST)
30 zapytań/minutę
dla operacji modyfikujących (POST, PUT, PATCH, DELETE)
10 zapytań/minutę
dla akcji serwera (start, stop, restart, reinstall)
2000 zapytań/godzinę
łączny limit dla wszystkich operacji
Nagłówki odpowiedzi
Każda odpowiedź API zawiera nagłówki informujące o limitach:
X-RateLimit-Limit: 100 - maksymalny limit zapytańX-RateLimit-Remaining: 87 - pozostałe zapytaniaX-RateLimit-Reset: 1706634000 - timestamp resetu limituPrzekroczenie limitów skutkuje odpowiedzią 429 Too Many Requests. Zalecamy implementację exponential backoff przy ponownych próbach.
Webhooks
Powiadomienia w czasie rzeczywistym
Webhooks pozwalają na otrzymywanie powiadomień o ważnych wydarzeniach w czasie rzeczywistym. Możesz skonfigurować webhooks w panelu użytkownika w sekcji Ustawienia → Webhooks.
Dostępne wydarzenia:
server.created- Utworzono nowy serwerserver.started- Uruchomiono serwerserver.stopped- Zatrzymano serwerserver.deleted- Usunięto serwerbackup.completed- Ukończono backupinvoice.created- Utworzono fakturęinvoice.paid- Opłacono fakturęPrzykładowy payload:
{
"event": "server.started",
"timestamp": "2025-01-01T16:00:00Z",
"data": {
"server_id": "srv_123456",
"name": "VPS-001",
"status": "running",
"ip": "185.123.45.67"
}
}Weryfikacja podpisu
Każdy webhook zawiera nagłówek X-Signature z HMAC SHA-256 podpisem payload. Zweryfikuj podpis aby upewnić się, że webhook pochodzi z SKY-VM.EU.
Najlepsze praktyki
Obsługa błędów
Zawsze sprawdzaj pole success w odpowiedzi. Implementuj retry logic z exponential backoff dla błędów 5xx i 429.
Paginacja
Używaj parametrów page i limit dla dużych zbiorów danych. Maksymalny limit to 100 elementów na stronę.
Caching
Cachuj odpowiedzi API lokalnie aby zmniejszyć liczbę zapytań. Używaj nagłówków ETag i If-None-Match.
Timeouty
Ustaw odpowiednie timeouty dla zapytań HTTP (zalecane: 30s dla GET, 60s dla POST). Długie operacje są asynchroniczne.