API
Documentación de la API REST de SigCleaner.
Método: eliminación de fondo
POST https://sigclean.io/api/clean
Autorización
Authorization: Bearer YOUR_API_KEY
Parámetros de la solicitud
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
file |
multipart file | Uno de los dos | Imagen PNG, JPG o PDF |
url |
string | Uno de los dos | Enlace directo a la imagen |
type |
string | No | json (por defecto) — devolver JSON con enlacewebp — вернуть бинарный файл WebP с прозрачным фономpng — вернуть бинарный файл PNG с прозрачным фоном |
Respuesta: 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
}
Respuesta: type=webp
Возвращает бинарный файл WebP с прозрачным фоном.
Content-Type: image/webp.
Respuesta: type=png
Возвращает бинарный файл PNG с прозрачным фоном.
Content-Type: image/png.
Примеры cURL
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
Descargar resultado
GET https://sigclean.io/api/file/{uuid}
Método: lista de archivos
GET https://sigclean.io/api/files
Devuelve una lista de todos los archivos procesados correctamente que pertenecen al usuario actual. Los archivos están disponibles a través del enlace /api/file/{uuid}.
Autorización
Token Bearer o sesión activa (cookie). Sin autorización devuelve 401.
Authorization: Bearer YOUR_API_KEY
Respuesta
{
"status": "ok",
"files": [
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"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"
}
]
}
| Campo | Tipo | Descripción |
|---|---|---|
uuid |
string | Identificador único del archivo |
url |
string | Enlace directo para descargar el archivo (WebP) |
created_at |
string (ISO 8601) | Fecha y hora de creación del archivo (UTC) |
expires_at |
string | null | Fecha de caducidad del almacenamiento (UTC). null — el archivo se almacena indefinidamente (usuarios autorizados). Para invitados — created_at + 1 año. |
Ejemplo de cURL
curl https://sigclean.io/api/files \
-H "Authorization: Bearer YOUR_KEY"
Método: eliminar archivo
POST https://sigclean.io/api/files/delete
Elimina el archivo del servidor de forma permanente. El archivo debe pertenecer al usuario actual.
Autorización
Token Bearer o sesión activa (cookie). Sin autorización devuelve 401.
Authorization: Bearer YOUR_API_KEY
Cuerpo de la solicitud application/json
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
uuid |
string | Sí | UUID del archivo de la respuesta /api/clean o /api/files |
Respuesta
{ "status": "ok" }
Códigos de error
| Código | Descripción |
|---|---|
401 | No autorizado |
404 | Archivo no encontrado o no pertenece al usuario |
422 | No proporcionado o inválido uuid |
Ejemplo de cURL
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"}'
Gestión de claves API
Debes iniciar sesión para gestionar las claves.