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

Parametr	Turi	Majburiy	Tavsif
`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`. `standard` — standart rejim. Sifatli tasvirlarni yaxshi qayta ishlaydi. Natija asl nusxaga maksimal darajada yaqin bo'ladi. `advanced` — intellektual rejim. Yana-da puxta ishlov berish; sifati past yoki ko'plab ortiqcha elementlarga ega tasvirlar uchun mos keladi.
`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

Intellektual ishlov berish rejimi:

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"
    }
  ]
}

Maydon	Turi	Tavsif
`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`

Parametr	Turi	Majburiy	Tavsif
`uuid`	string	Ha	`\/api\/clean` yoki `\/api\/files` javobidagi fayl UUID'si.

Javob

{ "status": "ok" }

Xatolik kodlari

Kod	Tavsif
`401`	Avtorizatsiyadan o'tilmagan
`404`	Fayl topilmadi yoki foydalanuvchiga tegishli emas
`422`	`uuid` 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`

Parametr	Turi	Majburiy	Tavsif
`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

Kod	Tavsif
`401`	Avtorizatsiyadan o'tilmagan
`404`	Fayl topilmadi yoki foydalanuvchiga tegishli emas
`422`	`uuid` \/ `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.

API

Metod: fonni olib tashlash

Avtorizatsiya

So'rov parametrlari

Javob: type=json

Javob: type=webp

Javob: type=png

cURL misollari

Natijani yuklab olish

Metod: fayllar ro'yxati

Avtorizatsiya

Javob

cURL misoli

Metod: faylni o'chirish

Avtorizatsiya

So‘rov tanasi application\/json

Javob

Xatolik kodlari

cURL misoli

Metod: faylni qayta nomlash

Avtorizatsiya

So‘rov tanasi application\/json

Javob

Xatolik kodlari

cURL misoli

API kalitlarini boshqarish

Javob: `type=json`

Javob: `type=webp`

Javob: `type=png`

So‘rov tanasi `application\/json`

So‘rov tanasi `application\/json`