API
SigCleaner REST API Dokümantasyonu.
Her başarılı \/api\/clean isteği, hesap bakiyesinden 1 işlem hakkı düşülür.
Metot: Arka plan kaldırma
Yetkilendirme
İ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ürwebp — şeffaf arka planlı WebP ikili dosyası döndürürpng — ş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.basic — hafif temizleme. Sadece arka planı kaldırır, gereksiz her şeyi bırakır.standard — normal temizleme (Ultra). Arka planı ve yazılar gibi gereksiz öğeleri kaldırır. Çoğu durum için uygundur.advanced — derin temizleme (Ultra). Akıllı algoritmalar kullanılarak görsel işleme. Düşük kaliteli veya çok sayıda yabancı öğe içeren dosyalar için uygundur. Bu modda, ayıklanacak nesneyi veya yabancı öğelerin agresif bir şekilde temizlenmesini seçebilirsiniz.
|
name |
string | Hayır | «Dosyalarım» listesinde görüntülenen dosya adı. Başarıyla işlendiğinde kaydedilir. |
Yanıt: type=json
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
Agresif yazı silme ile imza ayıklama:
Derin temizleme:
Sonucu indir
Metot: Dosya listesi
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
Yanıt
| 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
Metot: Dosya silme
Dosyayı sunucudan kalıcı olarak siler. Dosya mevcut kullanıcıya ait olmalıdır.
Yetkilendirme
İ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
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
Metot: Dosya yeniden adlandırma
Görüntülenen dosya adını değiştirir. Dosya mevcut kullanıcıya ait olmalıdır.
Yetkilendirme
İ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
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
API Anahtarı Yönetimi
Anahtarları yönetmek için hesabınıza giriş yapmalısınız.