API
SigCleaner сервисінің REST API құжаттамасы.
Әдіс: фонды өшіру
POST https://sigclean.io/api/clean
Авторизация
Authorization: Bearer YOUR_API_KEY
Сұрау параметрлері
| Параметр | Түрі | Міндетті | Сипаттамасы |
|---|---|---|---|
file |
multipart file | Екеуінің бірі | PNG, JPG немесе PDF кескіні |
url |
string | Екеуінің бірі | Кескінге тікелей сілтеме |
type |
string | Жоқ | json (әдепкі бойынша) — сілтемесі бар JSON қайтаруwebp — вернуть бинарный файл WebP с прозрачным фономpng — вернуть бинарный файл PNG с прозрачным фоном |
Жауап: 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
}
Жауап: type=webp
Возвращает бинарный файл WebP с прозрачным фоном.
Content-Type: image/webp.
Жауап: 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
Нәтижені жүктеп алу
GET https://sigclean.io/api/file/{uuid}
Әдіс: файлдар тізімі
GET https://sigclean.io/api/files
Ағымдағы пайдаланушыға тиесілі, сәтті өңделген барлық файлдардың тізімін қайтарады. Файлдар сілтеме бойынша қолжетімді /api/file/{uuid}.
Авторизация
Bearer-токен немесе белсенді сессия (cookie). Авторизациясыз қайтарады 401.
Authorization: Bearer YOUR_API_KEY
Жауап
{
"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"
}
]
}
| Өріс | Түрі | Сипаттамасы |
|---|---|---|
uuid |
string | Файлдың бірегей идентификаторы |
url |
string | Файлды жүктеп алуға арналған тікелей сілтеме (WebP) |
created_at |
string (ISO 8601) | Файлдың жасалған күні мен уақыты (UTC) |
expires_at |
string | null | Сақтау мерзімінің аяқталу күні (UTC). null — файл мерзімсіз сақталады (авторизацияланған пайдаланушылар). Қонақтар үшін — created_at + 1 жыл. |
cURL мысалы
curl https://sigclean.io/api/files \
-H "Authorization: Bearer YOUR_KEY"
Әдіс: файлды жою
POST https://sigclean.io/api/files/delete
Файлды серверден біржолата жояды. Файл ағымдағы пайдаланушыға тиесілі болуы керек.
Авторизация
Bearer-токен немесе белсенді сессия (cookie). Авторизациясыз қайтарады 401.
Authorization: Bearer YOUR_API_KEY
Сұрау денесі application/json
| Параметр | Түрі | Міндетті | Сипаттамасы |
|---|---|---|---|
uuid |
string | Иә | Жауаптағы файлдың UUID-і /api/clean немесе /api/files |
Жауап
{ "status": "ok" }
Қате кодтары
| Код | Сипаттамасы |
|---|---|
401 | Авторизацияланбаған |
404 | Файл табылмады немесе пайдаланушыға тиесілі емес |
422 | Жіберілмеген немесе қате uuid |
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"}'
API кілттерін басқару
Кілттерді басқару үшін аккаунтқа кіру қажет.