API

Дакументацыя REST API сэрвісу SigCleaner.

Кожны паспяховы запыт \/api\/clean спісвае 1 апрацоўку з балансу акаўнта.

Метад: выдаленне фону

POST https://sigclean.io/api/clean
Аўтарызацыя
Authorization: Bearer YOUR_API_KEY
Параметры запыту
ПараметрТыпАбавязковыАпісанне
file multipart file Адзін з двух PNG, JPG або PDF выява.
Калі PDF шматстаронкавы — апрацоўваецца толькі першая старонка.
url string Адзін з двух Прамая спасылка на выяву
type string Не json (па змаўчанні) — вярнуць JSON са спасылкай на файл
webp — вярнуць бінарны файл WebP з празрыстым фонам
png — вярнуць бінарны файл PNG з празрыстым фонам
extract string Не Вылучэнне пэўнага элемента. Па змаўчанні пуста — стандартнае выдаленне фону.
signature — захаваць толькі рукапісны подпіс, выдаліўшы ўсё астатняе.
stamp — захаваць толькі адбітак пячаткі, выдаліўшы ўсё астатняе.
aggressive boolean Не Агрэсіўнае выдаленне надпісаў.
Калі ўсталяваны ў 1 (true), агрэсіўна выдаляе ўсе надрукаваныя літары, лічбы і прамыя чорныя лініі бланка, пакідаючы толькі пазначаны элемент.
mode string Не Рэжым апрацоўкі. Па змаўчанні — standard.
standard — стандартны рэжым. Добра спраўляецца з выявамі добрай якасці. Вынік максімальна набліжаны да арыгінала.
advanced — інтэлектуальны рэжым. Больш дбайная апрацоўка; падыходзіць для выяў дрэннай якасці або з мноствам старонніх элементаў.
name string Не Імя файла для адлюстравання ў спісе «Мае файлы». Захоўваецца пры паспяховай апрацоўцы.
Адказ: 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 }
Адказ: type=webp

Вяртае бінарны файл WebP з празрыстым фонам. Content-Type: image/webp.

Адказ: type=png

Вяртае бінарны файл PNG з празрыстым фонам. Content-Type: image/png.

Прыклады 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

Вылучэнне подпісу з агрэсіўным выдаленнем надпісаў:

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

Інтэлектуальны рэжым апрацоўкі:

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
Спампаваць вынік
GET https://sigclean.io/api/file/{uuid}

Метад: спіс файлаў

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

Вяртае спіс усіх паспяхова апрацаваных файлаў, якія належаць бягучаму карыстальніку. Файлы даступныя па спасылцы /api/file/{uuid}.

Аўтарызацыя
Authorization: Bearer YOUR_API_KEY
Адказ
{ "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" } ] }
ПолеТыпАпісанне
uuid string Унікальны ідэнтыфікатар файла
name string | null Імя файла для адлюстравання (з параметра name пры \/api\/clean або пасля перайменавання)
url string Прамая спасылка для спампоўвання файла (WebP)
created_at string (ISO 8601) Дата і час стварэння файла (UTC)
expires_at string | null Дата заканчэння тэрміну захоўвання (UTC).
Прыклад cURL
curl https://sigclean.io/api/files \ -H "Authorization: Bearer YOUR_KEY"

Метад: выдаленне файла

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

Выдаляе файл з сервера незваротна. Файл павінен належаць бягучаму карыстальніку.

Аўтарызацыя
Authorization: Bearer YOUR_API_KEY
Цела запыту application\/json
ПараметрТыпАбавязковыАпісанне
uuid string Так UUID файла з адказу \/api\/clean або \/api\/files.
Адказ
{ "status": "ok" }
Коды памылак
КодАпісанне
401Не аўтарызаваны
404Файл не знойдзены або не належыць карыстальніку
422Не перададзены або некарэктны uuid
Прыклад 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"}'

Метад: перайменаванне файла

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

Змяняе імя файла для адлюстравання. Файл павінен належаць бягучаму карыстальніку.

Аўтарызацыя
Authorization: Bearer YOUR_API_KEY
Цела запыту application\/json
ПараметрТыпАбавязковыАпісанне
uuid string Так UUID файла з адказу \/api\/clean або \/api\/files.
name string Так Новае імя файла для адлюстравання (да 255 сімвалаў).
Адказ
{ "status": "ok", "name": "stamp.jpg" }
Коды памылак
КодАпісанне
401Не аўтарызаваны
404Файл не знойдзены або не належыць карыстальніку
422Не перададзены або некарэктны uuid \/ name
Прыклад 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"}'

Кіраванне ключамі API

Для кіравання ключамі неабходна ўвайсці ў акаўнт.