API

SigCleaner xizmatining REST API hujjatlari.

Har bir muvaffaqiyatli \/api\/clean so'rovi hisob balansidan 1 ta ishlov berishni yechib oladi.

Metod: fonni olib tashlash

POST https://sigclean.io/api/clean
Avtorizatsiya
Authorization: Bearer YOUR_API_KEY
So'rov parametrlari
ParametrTuriMajburiyTavsif
file multipart file Ikkisidan biri PNG, JPG yoki PDF tasvir.
Agar PDF ko'p sahifali bo'lsa — faqat birinchi sahifa qayta ishlanadi.
url string Ikkisidan biri Rasmga to'g'ridan-to'g'ri havola
type string Yo'q json (standart) — fayl havolasi bilan JSON qaytarish
webp — shaffof fonli WebP binar faylini qaytarish
png — shaffof fonli PNG binar faylini qaytarish
extract string Yo'q Muayyan elementni ajratib olish. Odatiy holatda bo'sh — fonni standart olib tashlash.
signature — qolgan barcha narsalarni o‘chirib, faqat qo‘lyozma imzoni saqlab qolish.
stamp — qolgan barcha narsalarni o‘chirib, faqat muhr izini saqlab qolish.
aggressive boolean Yo'q Yozuvlarni agressiv o‘chirish.
1 (true) qilib o‘rnatilganda, barcha bosma harflar, raqamlar va blankning to‘g‘ri qora chiziqlarini agressiv ravishda o‘chirib, faqat ko‘rsatilgan elementni qoldiradi.
mode string Yo'q Qayta ishlash rejimi. Odatiy holatda — standard.
basic — yengil tozalash. Faqat fonni olib tashlaydi, barcha ortiqcha narsalarni qoldiradi.
standard — oddiy tozalash (Ultra). Fon va ortiqcha elementlarni, masalan, yozuvlarni olib tashlaydi. Aksariyat hollarda mos keladi.
advanced — chuqur tozalash (Ultra). Intellektual algoritmlar yordamida tasvirga ishlov berish. Sifati past yoki ko'plab begona elementlarga ega fayllar uchun mos keladi. Bu rejimda ajratib olinadigan obyektni yoki begona elementlarni agressiv tozalashni tanlash mumkin.
name string Yo'q «Mening fayllarim» ro'yxatida ko'rsatiladigan fayl nomi. Muvaffaqiyatli qayta ishlanganida saqlanadi.
Javob: 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 }
Javob: type=webp

Shaffof fonli binar WebP faylini qaytaradi. Content-Type: image/webp.

Javob: type=png

Shaffof fonli binar PNG faylini qaytaradi. Content-Type: image/png.

cURL misollari
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

Yozuvlarni agressiv olib tashlagan holda imzoni ajratib olish:

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

Chuqur tozalash:

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
Natijani yuklab olish
GET https://sigclean.io/api/file/{uuid}

Metod: fayllar ro'yxati

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

Joriy foydalanuvchiga tegishli barcha muvaffaqiyatli qayta ishlangan fayllar ro'yxatini qaytaradi. Fayllar havola orqali mavjud /api/file/{uuid}.

Avtorizatsiya
Authorization: Bearer YOUR_API_KEY
Javob
{ "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" } ] }
MaydonTuriTavsif
uuid string Faylning noyob identifikatori
name string | null Ko'rsatiladigan fayl nomi (\/api\/clean dagi name parametridan yoki qayta nomlangandan so'ng)
url string Faylni yuklab olish uchun to'g'ridan-to'g'ri havola (WebP)
created_at string (ISO 8601) Fayl yaratilgan sana va vaqt (UTC)
expires_at string | null Saqlash muddati tugash sanasi (UTC).
cURL misoli
curl https://sigclean.io/api/files \ -H "Authorization: Bearer YOUR_KEY"

Metod: faylni o'chirish

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

Faylni serverdan butunlay o'chirib tashlaydi. Fayl joriy foydalanuvchiga tegishli bo'lishi kerak.

Avtorizatsiya
Authorization: Bearer YOUR_API_KEY
So‘rov tanasi application\/json
ParametrTuriMajburiyTavsif
uuid string Ha \/api\/clean yoki \/api\/files javobidagi fayl UUID'si.
Javob
{ "status": "ok" }
Xatolik kodlari
KodTavsif
401Avtorizatsiyadan o'tilmagan
404Fayl topilmadi yoki foydalanuvchiga tegishli emas
422uuid kiritilmagan yoki noto‘g‘ri
cURL misoli
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"}'

Metod: faylni qayta nomlash

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

Ko'rsatiladigan fayl nomini o'zgartiradi. Fayl joriy foydalanuvchiga tegishli bo'lishi kerak.

Avtorizatsiya
Authorization: Bearer YOUR_API_KEY
So‘rov tanasi application\/json
ParametrTuriMajburiyTavsif
uuid string Ha \/api\/clean yoki \/api\/files javobidagi fayl UUID'si.
name string Ha Yangi ko'rsatiladigan fayl nomi (255 belgacha).
Javob
{ "status": "ok", "name": "stamp.jpg" }
Xatolik kodlari
KodTavsif
401Avtorizatsiyadan o'tilmagan
404Fayl topilmadi yoki foydalanuvchiga tegishli emas
422uuid \/ name kiritilmagan yoki noto'g'ri
cURL misoli
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 kalitlarini boshqarish

Kalitlarni boshqarish uchun hisobingizga kirishingiz kerak.