API

SigCleaner REST API Dokümantasyonu.

Her başarılı \/api\/clean isteği, hesap bakiyesinden 1 işlem hakkı düşer.

Metot: Arka plan kaldırma

      POST https://sigclean.io/api/clean
    

Yetkilendirme

Authorization: Bearer YOUR_API_KEY

İstek parametreleri

Parametre	Tür	Zorunlu	Açıklama
`file`	multipart file	İkisinden biri	PNG, JPG veya PDF görseli. PDF çok sayfalıysa — yalnızca ilk sayfa işlenir.
`url`	string	İkisinden biri	Doğrudan görsel bağlantısı
`type`	string	Hayır	`json` (varsayılan) — dosya bağlantısını içeren JSON döndürür `webp` — şeffaf arka planlı WebP ikili dosyası döndürür `png` — şeffaf arka planlı PNG ikili dosyası döndürür
`extract`	string	Hayır	Belirli bir öğeyi ayıklama. Varsayılan olarak boştur — standart arka plan kaldırma işlemi uygulanır. `signature` — diğer her şeyi silerek yalnızca el yazısı imzayı korur. `stamp` — diğer her şeyi silerek yalnızca kaşe izini korur.
`aggressive`	boolean	Hayır	Agresif yazı kaldırma. `1` (`true`) olarak ayarlandığında, tüm basılı harfleri, rakamları ve düz siyah form çizgilerini agresif bir şekilde silerek yalnızca belirtilen öğeyi bırakır.
`mode`	string	Hayır	İşleme modu. Varsayılan — `standard`. `standard` — standart mod. İyi kaliteli görsellerde başarılı sonuç verir. Sonuç orijinaline olabildiğince yakındır. `advanced` — akıllı mod. Daha detaylı işleme; düşük kaliteli veya çok sayıda istenmeyen öğe içeren görseller için uygundur.
`name`	string	Hayır	«Dosyalarım» listesinde görüntülenen dosya adı. Başarıyla işlendiğinde kaydedilir.

Yanıt: `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
}

Yanıt: `type=webp`

Şeffaf arka planlı ikili WebP dosyası döndürür. Content-Type: image/webp.

Yanıt: `type=png`

Şeffaf arka planlı ikili PNG dosyası döndürür. Content-Type: image/png.

cURL örnekleri

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

Agresif yazı silme ile imza ayıklama:

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

Akıllı işleme modu:

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

Sonucu indir

      GET https://sigclean.io/api/file/{uuid}
    

Metot: Dosya listesi

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

Mevcut kullanıcıya ait başarıyla işlenmiş tüm dosyaların listesini döndürür. Dosyalara bağlantı üzerinden erişilebilir /api/file/{uuid}.

Yetkilendirme

Authorization: Bearer YOUR_API_KEY

Yanıt

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

Alan	Tür	Açıklama
`uuid`	string	Benzersiz dosya kimliği
`name`	string \| null	Görüntülenen dosya adı (`\/api\/clean` işlemindeki `name` parametresinden veya yeniden adlandırma sonrasında)
`url`	string	Dosyayı indirmek için doğrudan bağlantı (WebP)
`created_at`	string (ISO 8601)	Dosya oluşturma tarihi ve saati (UTC)
`expires_at`	string \| null	Saklama süresi bitiş tarihi (UTC).

cURL örneği

curl https://sigclean.io/api/files \
  -H "Authorization: Bearer YOUR_KEY"

Metot: Dosya silme

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

Dosyayı sunucudan kalıcı olarak siler. Dosya mevcut kullanıcıya ait olmalıdır.

Yetkilendirme

Authorization: Bearer YOUR_API_KEY

İstek gövdesi `application\/json`

Parametre	Tür	Zorunlu	Açıklama
`uuid`	string	Evet	`\/api\/clean` veya `\/api\/files` yanıtından alınan dosya UUID'si.

Yanıt

{ "status": "ok" }

Hata kodları

Kod	Açıklama
`401`	Yetkisiz
`404`	Dosya bulunamadı veya kullanıcıya ait değil
`422`	`uuid` eksik veya geçersiz

cURL örneği

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

Metot: Dosya yeniden adlandırma

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

Görüntülenen dosya adını değiştirir. Dosya mevcut kullanıcıya ait olmalıdır.

Yetkilendirme

Authorization: Bearer YOUR_API_KEY

İstek gövdesi `application\/json`

Parametre	Tür	Zorunlu	Açıklama
`uuid`	string	Evet	`\/api\/clean` veya `\/api\/files` yanıtından alınan dosya UUID'si.
`name`	string	Evet	Yeni görüntülenen dosya adı (255 karaktere kadar).

Yanıt

{
  "status": "ok",
  "name": "stamp.jpg"
}

Hata kodları

Kod	Açıklama
`401`	Yetkisiz
`404`	Dosya bulunamadı veya kullanıcıya ait değil
`422`	`uuid` \/ `name` eksik veya geçersiz

cURL örneği

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 Anahtarı Yönetimi

Anahtarları yönetmek için hesabınıza giriş yapmalısınız.

API

Metot: Arka plan kaldırma

Yetkilendirme

İstek parametreleri

Yanıt: type=json

Yanıt: type=webp

Yanıt: type=png

cURL örnekleri

Sonucu indir

Metot: Dosya listesi

Yetkilendirme

Yanıt

cURL örneği

Metot: Dosya silme

Yetkilendirme

İstek gövdesi application\/json

Yanıt

Hata kodları

cURL örneği

Metot: Dosya yeniden adlandırma

Yetkilendirme

İstek gövdesi application\/json

Yanıt

Hata kodları

cURL örneği

API Anahtarı Yönetimi

Yanıt: `type=json`

Yanıt: `type=webp`

Yanıt: `type=png`

İstek gövdesi `application\/json`

İstek gövdesi `application\/json`