Dokumentacja API
Typy problemów
Każdy błąd zwracany przez API Kleora to dokument problemu RFC 9457, wysyłany jako application/problem+json. Jego type to adres jednej z tych stron, a slug na jego końcu jest tym, po czym należy rozróżniać błędy: jest stały, a title i detail to tekst, który może się zmienić.
Poza type, title i status dokument może zawierać detail (opis tego konkretnego wystąpienia, po angielsku), instance (ścieżkę żądania) i request_id, zgodny z nagłówkiem X-Request-Id odpowiedzi — podaj go, gdy pytasz nas o konkretne żądanie. API hostowanych stron i API konta dodają code, czyli slug zapisany w snake_case.
400Bad Request
401Unauthorized
402Payment Required
403Forbidden
404Not Found
409Conflict
- Osiągnięto limit kont
- Przestrzeń robocza należy do konta
- Już jest członkiem
- Klucza API nie da się zrotować
- Domyślny klient
- Klient nie ma sekretu
- Konflikt
- Domyślna przestrzeń robocza
- Adres jest już zajęty
- Żądanie idempotentne w toku
- Zaproszenie już istnieje
- Ostatni sposób logowania
- Ostatni właściciel
- Drugi składnik już dodany
- To nie jest sandbox
- Uwierzytelniacz już zarejestrowany
- Uprawnienie już istnieje
- Chronione przez platformę
- Tożsamość u dostawcy już powiązana
- Dostawca tożsamości w użyciu
- Slug roli zajęty
- Ustawienie już zdefiniowane
- Konflikt typu ustawienia
- Członkostwo stałe w trybie single
- Slug zarezerwowany
- Slug zajęty
- Zarezerwowane uprawnienie zarządcze
- Rola utworzona przez platformę
- Uzupełnianie członkostw wciąż trwa
- Środowisko w trybie single
- Nie można przełączyć na tryb single
- Użytkownik usunięty
- Endpoint webhooka wyłączony
415Unsupported Media Type
422Unprocessable Content
- Pola nie da się wyczyścić
- Klucz idempotencji użyty ponownie
- Nieznany typ zdarzenia
- Nieprawidłowy zakres klucza API
- Przekroczony limit
- Hasło znalezione w wycieku
- Hasło odrzucone przez politykę
- Zarezerwowane uprawnienie
- Roli nie da się przypisać
- Ten sam użytkownik
- Slug zarezerwowany
- Żądanie nie przeszło walidacji
- Adres webhooka odrzucony