Przejdź do głównej zawartości

API Reference

ReadyNextOS udostępnia RESTful API do integracji z zewnętrznymi systemami.

API używa tokenów Bearer (Sanctum):

Okno terminala
curl -X POST https://api.example.com/api/auth/login \
-H "Content-Type: application/json" \
-d '{"email": "user@example.com", "password": "secret"}'

Odpowiedź:

{
"token": "1|abc123...",
"user": { "id": "...", "name": "..." }
}

Użycie tokenu:

Okno terminala
curl https://api.example.com/api/documents \
-H "Authorization: Bearer 1|abc123..."
MetodaEndpointOpis
GET/api/documentsLista dokumentów
POST/api/documentsUtwórz dokument
GET/api/documents/{id}Pobierz dokument
PUT/api/documents/{id}Aktualizuj dokument
DELETE/api/documents/{id}Usuń dokument
MetodaEndpointOpis
GET/api/contactsLista kontaktów
POST/api/contactsUtwórz kontakt
GET/api/contacts/{id}Pobierz kontakt
MetodaEndpointOpis
GET/api/mail/accountsLista kont
GET/api/mail/foldersLista folderów
GET/api/mail/messagesLista wiadomości
POST/api/mail/sendWyślij wiadomość

Wszystkie listy wspierają paginację:

GET /api/documents?page=1&per_page=25
GET /api/documents?status=draft&created_after=2025-01-01
KodZnaczenie
200Sukces
201Utworzono
400Błąd walidacji
401Brak autoryzacji
403Brak uprawnień
404Nie znaleziono
500Błąd serwera