API
Dokumentasi REST API layanan SigCleaner.
Setiap permintaan \/api\/clean yang berhasil akan memotong 1 pemrosesan dari saldo akun.
Metode: penghapusan latar belakang
Otorisasi
Parameter permintaan
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
file |
multipart file | Salah satu dari dua | Gambar PNG, JPG, atau PDF. Jika PDF memiliki banyak halaman — hanya halaman pertama yang diproses. |
url |
string | Salah satu dari dua | Tautan langsung ke gambar |
type |
string | Tidak | json (default) — mengembalikan JSON dengan tautan ke filewebp — mengembalikan file biner WebP dengan latar belakang transparanpng — mengembalikan file biner PNG dengan latar belakang transparan |
extract |
string | Tidak |
Ekstraksi elemen tertentu. Kosong secara default — penghapusan latar belakang standar.signature — hanya menyimpan tanda tangan tulisan tangan, menghapus semua bagian lainnya.stamp — hanya menyimpan cap stempel, menghapus semua bagian lainnya.
|
aggressive |
boolean | Tidak |
Penghapusan teks secara agresif. Jika diatur ke 1 (true), secara agresif menghapus semua huruf cetak, angka, dan garis hitam lurus pada formulir, hanya menyisakan elemen yang ditentukan.
|
mode |
string | Tidak |
Mode pemrosesan. Default — standard.standard — mode standar. Berfungsi dengan baik untuk gambar berkualitas bagus. Hasilnya akan semirip mungkin dengan aslinya.advanced — mode cerdas. Pemrosesan yang lebih teliti; cocok untuk gambar berkualitas rendah atau dengan banyak elemen pengganggu.
|
name |
string | Tidak | Nama file yang ditampilkan dalam daftar «File Saya». Disimpan saat pemrosesan berhasil. |
Respons: type=json
Respons: type=webp
Mengembalikan file biner WebP dengan latar belakang transparan.
Content-Type: image/webp.
Respons: type=png
Mengembalikan file biner PNG dengan latar belakang transparan.
Content-Type: image/png.
Contoh cURL
Ekstraksi tanda tangan dengan penghapusan teks agresif:
Mode pemrosesan cerdas:
Unduh hasil
Metode: daftar file
Mengembalikan daftar semua file yang berhasil diproses milik pengguna saat ini. File tersedia melalui tautan /api/file/{uuid}.
Otorisasi
Respons
| Bidang | Tipe | Deskripsi |
|---|---|---|
uuid |
string | ID unik file |
name |
string | null | Nama file yang ditampilkan (dari parameter name pada \/api\/clean atau setelah penggantian nama) |
url |
string | Tautan langsung untuk mengunduh file (WebP) |
created_at |
string (ISO 8601) | Tanggal dan waktu pembuatan file (UTC) |
expires_at |
string | null | Tanggal kedaluwarsa penyimpanan (UTC). |
Contoh cURL
Metode: penghapusan file
Menghapus file dari server secara permanen. File harus milik pengguna saat ini.
Otorisasi
Isi permintaan application\/json
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
uuid |
string | Ya | UUID file dari respons \/api\/clean atau \/api\/files. |
Respons
Kode error
| Kode | Deskripsi |
|---|---|
401 | Tidak diotorisasi |
404 | File tidak ditemukan atau bukan milik pengguna |
422 | uuid tidak diberikan atau tidak valid |
Contoh cURL
Metode: penggantian nama file
Mengubah nama file yang ditampilkan. File harus milik pengguna saat ini.
Otorisasi
Isi permintaan application\/json
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
uuid |
string | Ya | UUID file dari respons \/api\/clean atau \/api\/files. |
name |
string | Ya | Nama file baru yang ditampilkan (hingga 255 karakter). |
Respons
Kode error
| Kode | Deskripsi |
|---|---|
401 | Tidak diotorisasi |
404 | File tidak ditemukan atau bukan milik pengguna |
422 | uuid \/ name tidak diberikan atau tidak valid |
Contoh cURL
Manajemen kunci API
Untuk mengelola kunci, Anda harus masuk ke akun.