API

SigCleaner сервисінің REST API құжаттамасы.

Әрбір сәтті \/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.
basic — жеңіл тазарту. Тек фонды алып тастап, барлық артық нәрселерді қалдырады.
standard — қалыпты тазарту (Ultra). Фонды және жазулар сияқты артық элементтерді жояды. Көп жағдайда жарамды.
advanced — терең тазарту (Ultra). Зияткерлік алгоритмдерді пайдаланып кескінді өңдеу. Сапасы төмен немесе бөгде элементтері көп файлдар үшін жарамды. Бұл режимде бөліп алынатын нысанды немесе бөгде элементтерді агрессивті түрде тазартуды таңдауға болады.
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 Көрсетілетін файл атауы (\/api\/clean кезіндегі name параметрінен немесе атауын өзгерткеннен кейін)
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 Иә \/api\/clean немесе \/api\/files жауабындағы файлдың UUID-і.
Жауап
{ "status": "ok" }
Қате кодтары
КодСипаттамасы
401Авторизацияланбаған
404Файл табылмады немесе пайдаланушыға тиесілі емес
422uuid берілмеген немесе қате
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 Иә \/api\/clean немесе \/api\/files жауабындағы файлдың UUID-і.
name string Иә Көрсетілетін жаңа файл атауы (255 таңбаға дейін).
Жауап
{ "status": "ok", "name": "stamp.jpg" }
Қате кодтары
КодСипаттамасы
401Авторизацияланбаған
404Файл табылмады немесе пайдаланушыға тиесілі емес
422uuid \/ 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 кілттерін басқару

Кілттерді басқару үшін аккаунтқа кіру қажет.