API
Documentazione dell'API REST del servizio SigCleaner.
Ogni richiesta \/api\/clean andata a buon fine scala 1 elaborazione dal saldo dell'account.
Metodo: rimozione sfondo
Autorizzazione
Parametri della richiesta
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
file |
multipart file | Uno dei due | Immagine PNG, JPG o PDF. Se il PDF è multipagina — viene elaborata solo la prima pagina. |
url |
string | Uno dei due | Link diretto all'immagine |
type |
string | No | json (predefinito) — restituisce un JSON con il link al filewebp — restituisce un file binario WebP con sfondo trasparentepng — restituisce un file binario PNG con sfondo trasparente |
extract |
string | No |
Estrazione di un elemento specifico. Vuoto per impostazione predefinita — rimozione standard dello sfondo.signature — mantiene solo la firma autografa, rimuovendo tutto il resto.stamp — mantiene solo l'impronta del timbro, rimuovendo tutto il resto.
|
aggressive |
boolean | No |
Rimozione aggressiva del testo. Se impostato su 1 (true), rimuove in modo aggressivo tutte le lettere stampate, i numeri e le linee nere dritte del modulo, lasciando solo l'elemento specificato.
|
mode |
string | No |
Modalità di elaborazione. Predefinita — standard.standard — modalità standard. Ideale per immagini di buona qualità. Il risultato è il più fedele possibile all'originale.advanced — modalità intelligente. Elaborazione più accurata; adatta per immagini di scarsa qualità o con molti elementi indesiderati.
|
name |
string | No | Nome del file visualizzato nell'elenco «I miei file». Viene salvato in caso di elaborazione riuscita. |
Risposta: type=json
Risposta: type=webp
Restituisce un file binario WebP con sfondo trasparente.
Content-Type: image/webp.
Risposta: type=png
Restituisce un file binario PNG con sfondo trasparente.
Content-Type: image/png.
Esempi cURL
Estrazione della firma con rimozione aggressiva delle scritte:
Modalità di elaborazione intelligente:
Scarica risultato
Metodo: elenco file
Restituisce un elenco di tutti i file elaborati con successo appartenenti all'utente corrente. I file sono disponibili tramite link /api/file/{uuid}.
Autorizzazione
Risposta
| Campo | Tipo | Descrizione |
|---|---|---|
uuid |
string | ID univoco del file |
name |
string | null | Nome del file visualizzato (dal parametro name in \/api\/clean o dopo la rinominazione) |
url |
string | Link diretto per il download del file (WebP) |
created_at |
string (ISO 8601) | Data e ora di creazione del file (UTC) |
expires_at |
string | null | Data di scadenza della conservazione (UTC). |
Esempio cURL
Metodo: eliminazione file
Elimina definitivamente il file dal server. Il file deve appartenere all'utente corrente.
Autorizzazione
Corpo della richiesta application\/json
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
uuid |
string | Sì | UUID del file dalla risposta \/api\/clean o \/api\/files. |
Risposta
Codici di errore
| Codice | Descrizione |
|---|---|
401 | Non autorizzato |
404 | File non trovato o non appartenente all'utente |
422 | uuid mancante o non valido |
Esempio cURL
Metodo: rinominazione file
Modifica il nome del file visualizzato. Il file deve appartenere all'utente corrente.
Autorizzazione
Corpo della richiesta application\/json
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
uuid |
string | Sì | UUID del file dalla risposta \/api\/clean o \/api\/files. |
name |
string | Sì | Nuovo nome del file visualizzato (fino a 255 caratteri). |
Risposta
Codici di errore
| Codice | Descrizione |
|---|---|
401 | Non autorizzato |
404 | File non trovato o non appartenente all'utente |
422 | uuid \/ name mancante o non valido |
Esempio cURL
Gestione chiavi API
Per gestire le chiavi è necessario accedere all'account.