API

Dokumentacja REST API serwisu SigCleaner.

Każde pomyślne żądanie /api/clean pobiera 1 przetworzenie z salda konta.

Metoda: usuwanie tła

POST https://sigclean.io/api/clean
Autoryzacja
Authorization: Bearer YOUR_API_KEY
Parametry żądania
ParametrTypWymaganyOpis
file multipart file Jeden z dwóch Obraz w formacie PNG, JPG lub PDF.
Jeśli plik PDF jest wielostronicowy — przetwarzana jest tylko pierwsza strona.
url string Jeden z dwóch Bezpośredni link do obrazu
type string Nie json (domyślnie) — zwraca JSON z linkiem do pliku
webp — zwraca plik binarny WebP z przezroczystym tłem
png — zwraca plik binarny PNG z przezroczystym tłem
extract string Nie Wyodrębnianie konkretnego elementu. Domyślnie puste — standardowe usuwanie tła.
signature — zachowuje tylko odręczny podpis, usuwając całą resztę.
stamp — zachowuje tylko odcisk pieczątki, usuwając całą resztę.
aggressive boolean Nie Agresywne usuwanie napisów.
Gdy ustawiono na 1 (true), agresywnie usuwa wszystkie wydrukowane litery, cyfry i proste czarne linie formularza, pozostawiając tylko wskazany element.
mode string Nie Tryb przetwarzania. Domyślnie — standard.
basic — lekkie czyszczenie. Usuwa tylko tło, pozostawiając całą resztę.
standard — standardowe czyszczenie (Ultra). Usuwa tło i zbędne elementy, np. napisy. Odpowiednie w większości przypadków.
advanced — głębokie czyszczenie (Ultra). Przetwarzanie obrazu z wykorzystaniem inteligentnych algorytmów. Odpowiednie dla plików niskiej jakości lub z wieloma zbędnymi elementami. W tym trybie można wybrać obiekt do wyodrębnienia lub agresywne czyszczenie zbędnych elementów.
name string Nie Wyświetlana nazwa pliku na liście „Moje pliki”. Zapisywana po pomyślnym przetworzeniu.
Odpowiedź: type=json
{ "status": "ok", "uuid": "550e8400-e29b-41d4-a716-446655440000", "url": "https://sigclean.io/api/file/550e8400-e29b-41d4-a716-446655440000", "remaining": 9, "limit": 10 }
Odpowiedź: type=webp

Zwraca plik binarny WebP z przezroczystym tłem. Content-Type: image/webp.

Odpowiedź: type=png

Zwraca plik binarny PNG z przezroczystym tłem. Content-Type: image/png.

Przykłady cURL
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=json"
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=png" \ --output result.png
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=webp" \ --output result.webp

Wyodrębnianie podpisu z agresywnym usuwaniem napisów:

curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@document.jpg" \ -F "type=png" \ -F "extract=signature" \ -F "aggressive=1" \ --output signature.png

Głębokie czyszczenie:

curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=png" \ -F "mode=advanced" \ --output result.png
Pobierz wynik
GET https://sigclean.io/api/file/{uuid}

Metoda: lista plików

GET https://sigclean.io/api/files

Zwraca listę wszystkich pomyślnie przetworzonych plików należących do bieżącego użytkownika. Pliki są dostępne pod linkiem /api/file/{uuid}.

Autoryzacja
Authorization: Bearer YOUR_API_KEY
Odpowiedź
{ "status": "ok", "files": [ { "uuid": "550e8400-e29b-41d4-a716-446655440000", "name": "stamp.jpg", "url": "https://sigclean.io/api/file/550e8400-e29b-41d4-a716-446655440000", "created_at": "2026-07-01T10:00:00Z", "expires_at": "2027-07-01T10:00:00Z" } ] }
PoleTypOpis
uuid string Unikalny identyfikator pliku
name string | null Wyświetlana nazwa pliku (z parametru name przy /api/clean lub po zmianie nazwy)
url string Bezpośredni link do pobrania pliku (WebP)
created_at string (ISO 8601) Data i czas utworzenia pliku (UTC)
expires_at string | null Data wygaśnięcia przechowywania (UTC).
Przykład cURL
curl https://sigclean.io/api/files \ -H "Authorization: Bearer YOUR_KEY"

Metoda: usuwanie pliku

POST https://sigclean.io/api/files/delete

Trwale usuwa plik z serwera. Plik musi należeć do bieżącego użytkownika.

Autoryzacja
Authorization: Bearer YOUR_API_KEY
Ciało żądania application/json
ParametrTypWymaganyOpis
uuid string Tak UUID pliku z odpowiedzi /api/clean lub /api/files.
Odpowiedź
{ "status": "ok" }
Kody błędów
KodOpis
401Brak autoryzacji
404Nie znaleziono pliku lub nie należy on do użytkownika
422Brakujący lub nieprawidłowy uuid
Przykład cURL
curl -X POST https://sigclean.io/api/files/delete \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"uuid":"550e8400-e29b-41d4-a716-446655440000"}'

Metoda: zmiana nazwy pliku

POST https://sigclean.io/api/files/rename

Zmienia wyświetlaną nazwę pliku. Plik musi należeć do bieżącego użytkownika.

Autoryzacja
Authorization: Bearer YOUR_API_KEY
Ciało żądania application/json
ParametrTypWymaganyOpis
uuid string Tak UUID pliku z odpowiedzi /api/clean lub /api/files.
name string Tak Nowa wyświetlana nazwa pliku (do 255 znaków).
Odpowiedź
{ "status": "ok", "name": "stamp.jpg" }
Kody błędów
KodOpis
401Brak autoryzacji
404Nie znaleziono pliku lub nie należy on do użytkownika
422Brakujący lub nieprawidłowy uuid / name
Przykład cURL
curl -X POST https://sigclean.io/api/files/rename \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"uuid":"550e8400-e29b-41d4-a716-446655440000","name":"stamp.jpg"}'

Zarządzanie kluczami API

Aby zarządzać kluczami, musisz się zalogować.