API
Documentația REST API a serviciului SigCleaner.
Fiecare cerere reușită \/api\/clean deduce 1 procesare din soldul contului.
Metodă: eliminare fundal
Autorizare
Parametrii cererii
| Parametru | Tip | Obligatoriu | Descriere |
|---|---|---|---|
file |
multipart file | Unul din două | Imagine PNG, JPG sau PDF. Dacă fișierul PDF are mai multe pagini — este procesată doar prima pagină. |
url |
string | Unul din două | Link direct către imagine |
type |
string | Nu | json (implicit) — returnează JSON cu linkul către fișierwebp — returnează fișierul binar WebP cu fundal transparentpng — returnează fișierul binar PNG cu fundal transparent |
extract |
string | Nu |
Extragerea unui element specific. Implicit este gol — eliminare standard a fundalului.signature — păstrează doar semnătura olografă, eliminând restul.stamp — păstrează doar amprenta ștampilei, eliminând restul.
|
aggressive |
boolean | Nu |
Eliminarea agresivă a textului. Când este setat la 1 (true), elimină agresiv toate literele tipărite, cifrele și liniile negre drepte ale formularului, lăsând doar elementul specificat.
|
mode |
string | Nu |
Mod de procesare. Implicit — standard.standard — mod standard. Procesează excelent imaginile de calitate bună. Rezultatul este cât mai fidel originalului.advanced — mod inteligent. Procesare mai amănunțită; potrivită pentru imagini de calitate slabă sau cu multe elemente nedorite.
|
name |
string | Nu | Numele afișat al fișierului în lista „Fișierele mele”. Este salvat la procesarea cu succes. |
Răspuns: type=json
Răspuns: type=webp
Returnează fișierul binar WebP cu fundal transparent.
Content-Type: image/webp.
Răspuns: type=png
Returnează fișierul binar PNG cu fundal transparent.
Content-Type: image/png.
Exemple cURL
Extragerea semnăturii cu eliminarea agresivă a textului:
Mod inteligent de procesare:
Descarcă rezultatul
Metodă: listă fișiere
Returnează o listă cu toate fișierele procesate cu succes care aparțin utilizatorului curent. Fișierele sunt disponibile prin link /api/file/{uuid}.
Autorizare
Răspuns
| Câmp | Tip | Descriere |
|---|---|---|
uuid |
string | Identificator unic al fișierului |
name |
string | null | Numele afișat al fișierului (din parametrul name la \/api\/clean sau după redenumire) |
url |
string | Link direct pentru descărcarea fișierului (WebP) |
created_at |
string (ISO 8601) | Data și ora creării fișierului (UTC) |
expires_at |
string | null | Data expirării stocării (UTC). |
Exemplu cURL
Metodă: ștergere fișier
Șterge definitiv fișierul de pe server. Fișierul trebuie să aparțină utilizatorului curent.
Autorizare
Corpul cererii application\/json
| Parametru | Tip | Obligatoriu | Descriere |
|---|---|---|---|
uuid |
string | Da | UUID-ul fișierului din răspunsul \/api\/clean sau \/api\/files. |
Răspuns
Coduri de eroare
| Cod | Descriere |
|---|---|
401 | Neautorizat |
404 | Fișierul nu a fost găsit sau nu aparține utilizatorului |
422 | uuid lipsă sau invalid |
Exemplu cURL
Metodă: redenumire fișier
Modifică numele afișat al fișierului. Fișierul trebuie să aparțină utilizatorului curent.
Autorizare
Corpul cererii application\/json
| Parametru | Tip | Obligatoriu | Descriere |
|---|---|---|---|
uuid |
string | Da | UUID-ul fișierului din răspunsul \/api\/clean sau \/api\/files. |
name |
string | Da | Noul nume afișat al fișierului (până la 255 de caractere). |
Răspuns
Coduri de eroare
| Cod | Descriere |
|---|---|
401 | Neautorizat |
404 | Fișierul nu a fost găsit sau nu aparține utilizatorului |
422 | uuid \/ name lipsă sau invalid |
Exemplu cURL
Gestionarea cheilor API
Pentru a gestiona cheile, trebuie să vă conectați la cont.