Dokumentacja API

Obsługa Błędów

Standardowe kody błędów, nagłówki limitów i rozwiązywanie problemów.

Ostatnia aktualizacja:

Obsługa błędów

Wszystkie odpowiedzi błędów mają spójny format z kodem błędu i komunikatem czytelnym dla człowieka:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Description of what went wrong"
  }
}

Kody błędów

HTTP StatusCodeDescription
400VALIDATION_ERRORNieprawidłowe lub brakujące parametry żądania
401UNAUTHORIZEDBrakujący lub nieprawidłowy klucz API
402PAYMENT_REQUIREDNiewystarczająca liczba kredytów
403FORBIDDENDostęp do API wymaga planu Business lub działanie jest niedozwolone
403LIMIT_EXCEEDEDOsiągnięto limity planu (projekty, buildy itp.)
404NOT_FOUNDZasób nie został znaleziony lub jest niedostępny
409CONFLICTKonflikt zasobu (wdrożenie w toku, zajęta domena itp.)
429RATE_LIMITEDZbyt wiele żądań — sprawdź nagłówki limitu szybkości
500INTERNAL_ERRORBłąd serwera — spróbuj ponownie lub skontaktuj się z pomocą techniczną

Nagłówki limitu szybkości

Każda odpowiedź zawiera te nagłówki:

  • X-RateLimit-Remaining — Liczba pozostałych żądań w bieżącym oknie
  • X-RateLimit-Reset — Sekundy do zresetowania okna limitu szybkości

Po otrzymaniu odpowiedzi 429 poczekaj liczbę sekund wskazaną przez X-RateLimit-Reset przed ponowieniem próby.

Koszty kredytów

Akcje API, które zużywają kredyty:

ActionCredits
Tworzenie projektu (wstępny build)5
Ulepszenie1
Edycja kodu1
Ponowne wdrożenie1
Cofnięcie wdrożenia1
Klonowanie2
Reaktywacja1
Pytanie do doradcy1

Administratorzy są zwolnieni z opłat w kredytach.

Rozwiązywanie problemów

  • 401 Unauthorized — Sprawdź, czy klucz API zaczyna się od flp_ i jest przekazany jako token Bearer
  • 403 Forbidden — Upewnij się, że konto ma aktywną subskrypcję Business
  • 409 Conflict przy wdrożeniu — Poczekaj na zakończenie bieżącego wdrożenia lub najpierw je anuluj
  • Błędy subdomeny — Subdomeny muszą być pisane małymi literami, mieć 3–63 znaki i zawierać tylko litery, cyfry oraz myślniki