API SmartCawi

401 Token nie został przesłany

{
    "code": "401",
    "message": "JWT Token not found"
}

401 Token utracił ważność

{
    "code": "401",
    "message": "Expired JWT Token"
}

401 Nieprawidłowy token

{
    "code": "401",
    "message": "Invalid JWT Token"
}

first_name string required

Imię

last_name string required

Nazwisko

email string required

Adres email

password string required

Hasło powiązane z adresem email

password_confirmation string required

Potwierdzenie hasła

201 Sukces. Użytkownik został utworzony

Użytkownik został pomyślnie utworzony, a email weryfikacyjny wysłany.

{
    "message": "User registered successfully. Verification email sent.",
    "user_id": 123
}

422 Błąd walidacji

Wybrane pola nie spełniają warunków walidacji.

{
    "last_name": "This field is required.",
    "email": "Email already in use.",
    "password": "The password confirmation does not match."
}

201 Sukces. Organizacja została utworzona

Organizacja została pomyślnie utworzona.

{
    "message": "Organization exists, user added"
}

400 Błąd zapytania

Niektóre pola nie spełniają warunków walidacji.

{
    "detail": "Cannot create an instance of ... from serialized data because its constructor requires the following parameters to be present: '$parameter'."
}

500 Użytkownik już istnieje

Użytkownik o podanym adresie email już istnieje w systemie.

{
    "detail": "User already exists"
}

email string required

Adres email

password string required

Hasło powiązane z adresem email

200 Sukces logowania bez 2FA

Użytkownik został poprawnie uwierzytelniony. Otrzymuje token autoryzacyjny.

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

200 Wymagana dodatkowa weryfikacja (2FA)

Użytkownik został wstępnie uwierzytelniony, ale wymagana jest dodatkowa weryfikacja dwuskładnikowa.

{
    "status": "2FA_REQUIRED",
    "userId": "12345",
    "methods": [
        "sms",
        "email"
    ]
}

401 Użytkownik nie istnieje

{
    "status": "ERROR",
    "message": "User not found"
}

403 Konto użytkownika nie jest aktywne

{
    "status": "ERROR",
    "message": "User account is not active"
}

refresh_token string required

Aktualny refresh token

200 Nowy token i refresh_token

Użytkownik został poprawnie uwierzytelniony. Otrzymuje nowy token i refresh token autoryzacyjny.

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

401 Użytkownik nie istnieje

{
    "code": "401",
    "message": "JWT Refresh Token Not Found"
}

email string required

Adres email

202 Mail został wysłany

Mail z linkiem do resetu hasła został wysłany na podany adres email.

{
    "message": "The email message has been sent"
}

401 Użytkownik nie istnieje

{
    "error": "User not found"
}

500 Mail nie został wysłany

Mail z linkiem do resetu hasła nie został wysłany na podany adres email.

{
    "message": "The email message has not been sent"
}

token string required

Token przesłany w mailu z linkiem do resetu hasła

password string required

Nowe hasło

202 Hasło zostało zresetowane

Hasło zostało pomyślnie zresetowane

{
    "message": "Password has been successfully reset"
}

400 Token jest nieprawidłowy, lub utracił ważność

oken jest nieprawidłowy, lub utracił ważność. Ważność tokena do resetu hasła wynosi 60 minut

{
    "message": "Invalid or expired reset token"
}

userId integer required

ID użytkownika

method string required

Wybrana metoda uwierzytelnienia dwuskładnikowego

200 Wysłanie kodu 2FA

Kod uwierzytelnienia dwuskładnikowego został wysłany wybrana metodą

{
    "status": "CODE_SENT",
    "method": "email"
}

401 User not found

{
    "status": "ERROR",
    "message": "User not found."
}

userId integer required

ID użytkownika

code string required

Kod uwierzytelnienia dwuskładnikowego przekazany użytkownikowi wybraną przez niego metodą

200 Sukces logowania z 2FA

Użytkownik został poprawnie uwierzytelniony. Otrzymuje token autoryzacyjny.

{
    "status": "AUTHENTICATED",
    "auth_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

401 Niepoprawny kod

Użytkownik przesłał niepoprawny kod uwierzytelnienia dwuskładnikowego.

{
    "status": "ERROR",
    "message": "Invalid verification code."
}

404 Użytkownik nie istnieje

Użytkownik przesłał ID nieistniejącego użytkownika.

{
    "status": "ERROR",
    "message": "User not found."
}

410 Kod wygasł

Użytkownik przesłał kod po upływie czasu ważności kodu.

{
    "status": "ERROR",
    "message": "Verification code expired."
}

refresh_token string required

Refresh token do unieważnienia

200 Wylogowano

Wylogowanie użytkownika zakończone sukcesem. Wszystkie wygasłe refresh tokeny zostały usunięte

{
    "code": 200,
    "message": "The supplied refresh_token has been invalidated."
}

200 Lista urządzeń zaufanych

Lista urządzeń zaufanych zalogowanego użytkownika

{
    "devices": [
        {
            "id": "a89558d2c9583093b55a7903c085cf52c6d46890da8365cf23ac034916d6cc73",
            "user": "/api/users/me",
            "deviceName": "Laptop HP",
            "createdAt": "2025-03-27T09:18:01+00:00"
        },
        {
            "id": "d0bdfcb8502aae4c6e6fb25713f7c8b102c5f3fa4dc3be90c99c318601a9ef9b",
            "user": "/api/users/me",
            "device_name": "iPhone Marka",
            "createdAt": "2025-03-29T09:00:21+00:00"
        }
    ]
}

device_name string required

Nazwa urządzenia zaproponowana przez użytkownika

user_agent string required

Fingerprint: Informacja o przeglądarce i systemie operacyjnym użytkownika (navigator.userAgent)

hardware_concurrency string required

Fingerprint: Liczba rdzeni procesora dostępnych w urządzeniu (navigator.hardwareConcurrency)

language string required

Fingerprint: Preferowany język przeglądarki użytkownika (navigator.language)

platform string required

Fingerprint: Nazwa platformy/systemu operacyjnego (navigator.platform)

201 Urządzenie zostało dodane

Urządzenie zostało zapisane jako urządzenie zaufane pod wybraną nazwą

{
    "id": "a89558d2c9583093b55a7903c085cf52c6d46890da8365cf23ac034916d6cc73",
    "user": "/api/users/me",
    "deviceName": "Laptop HP",
    "createdAt": "2025-03-27T09:18:01+00:00"
}

500 Urządzenie już jest zaufane

Urządzenie już istnieje w bazie jako urządzenie zaufane

{
    "detail": "Device already trusted"
}

user_agent string required

Fingerprint: Informacja o przeglądarce i systemie operacyjnym użytkownika (navigator.userAgent)

hardware_concurrency string required

Fingerprint: Liczba rdzeni procesora dostępnych w urządzeniu (navigator.hardwareConcurrency)

language string required

Fingerprint: Preferowany język przeglądarki użytkownika (navigator.language)

platform string required

Fingerprint: Nazwa platformy/systemu operacyjnego (navigator.platform)

200 Urządzenie jest zaufane

Urządzenie zostało rozpoznane jako urządzenie zaufane

{
    "device_name": "Device name"
}

404 Urządzenie nie jest zaufane

Urządzenie nie zostało rozpoznane jako urządzenie zaufane

{
    "error": "Trusted device not found"
}

204 Urządzenie zostało usunięte

Urządzenie zostało usunięte z listy urządzeń zaufanych

"no content"

404 Urządzenie zaufane nie zostało znalezione

Urządzenie zaufane nie zostało znalezione lub nie należy do użytkownika

{
    "detail": "Not Found"
}

204 Urządzenia zostały usunięte

Wszystkie urządzenia zaufane zalogowanego użytkownika zostały usunięte

"no content"

200 Zalogowany użytkownik

Zwraca aktualnie zalogowanego użytkownika

{
    "id": 8,
    "email": "example@smartcawi.pl",
    "firstName": "Jan",
    "lastName": "Kowalski",
    "roles": [
        "ROLE_USER",
        "ROLE_OKF"
    ],
    "canOrderSurvey": true,
    "canAcceptSurvey": false,
    "twoFactorAuth": false,
    "notificationSmartcawi": true,
    "notificationPp": false,
    "status": "active",
    "trustedDevices": [
        {
            "id": "a89558d2c9583093b55a7903c085cf52c6d46890da8365cf23ac034916d6cc73",
            "deviceName": "Laptop HP",
            "createdAt": "2025-03-27T09:18:01+00:00"
        },
        {
            "id": "d0bdfcb8502aae4c6e6fb25713f7c8b102c5f3fa4dc3be90c99c318601a9ef9b",
            "device_name": "iPhone Marka",
            "createdAt": "2025-03-29T09:00:21+00:00"
        }
    ]
}