OpenAPI

Open API · SkyPlugins.ru
Добавить закладку

Документация открытого API

API сервиса SkyPlugins.ru для получения и генерации иконок Rust SkinID. Сервис возвращает информацию о подготовленном изображении, ссылку на файл, размер, формат и статус кэша. При первом запросе иконка может быть подготовлена автоматически, после чего будет отдаваться из локального кэша.

Обзор

Открытый API SkyPlugins.ru предназначен для работы с иконками предметов Rust по SkinID. Он позволяет получить информацию об иконке или напрямую получить готовый файл изображения.

Base URL

https://api.skyplugins.ru

Форматы

png, webp, jpg

Макс. размер

512 px

Все примеры ниже используют базовый адрес https://api.skyplugins.ru.

Быстрый старт

Пример запроса информации об иконке SkinID в стандартном формате PNG, размером 512px.

curl -X GET "https://api.skyplugins.ru/api/skins/2193149013?size=512&format=png"

Если нужен сам файл изображения, используйте endpoint /icon.

https://api.skyplugins.ru/api/skins/2193149013/icon?size=512&format=png

Методы API

GET /health

Проверка состояния сервиса. Метод удобно использовать для мониторинга и автоматических health-check проверок.

GET https://api.skyplugins.ru/health
{
  "ok": true,
  "service": "SkyOpenApi",
  "time": "2026-05-18T00:00:00+00:00"
}
GET /api/skins/{skinId}

Возвращает JSON с информацией об иконке: SkinID, размер, формат, ссылку на файл, размер файла и признак, был ли результат получен из кэша.

GET https://api.skyplugins.ru/api/skins/2193149013?size=512&format=png
GET /api/skins/{skinId}/icon

Возвращает готовый файл изображения. Ответ содержит корректный Content-Type и может отдаваться с долгим кэшированием.

GET https://api.skyplugins.ru/api/skins/2193149013/icon?size=512&format=png

Параметры запроса

Параметр Тип По умолчанию Описание
skinId integer обязательный Положительный SkinID предмета Rust.
size integer 512 Размер изображения в пикселях. Значение выше максимального может быть ограничено настройками сервиса.
format string png Формат изображения: png, webp, jpg или jpeg.
quality integer 75 Качество сжатия от 1 до 100. Обычно актуально для jpg и webp. Для PNG параметр может не влиять на итоговое качество изображения.

Пример успешного ответа

{
  "skinId": 2193149013,
  "size": 512,
  "format": "png",
  "quality": 75,
  "url": "https://api.skyplugins.ru/api/skins/2193149013/icon?size=512&format=png",
  "sizeBytes": 155140,
  "fromCache": true
}
fromCache: true — файл уже был подготовлен fromCache: false — файл создан при запросе url — ссылка на готовую иконку

Ошибки

Код Причина Пример ответа
400 Некорректный SkinID, формат или параметр запроса. {"error":"SkinID must be positive."}
404 Иконка не найдена или не может быть получена. {"error":"Not found."}
504 Истёк таймаут загрузки исходной иконки. {"error":"Request timeout."}
500 Внутренняя ошибка сервиса. {"error":"Internal server error."}

Кэширование и особенности

После генерации файл сохраняется в хранилище, а повторные запросы отдаются из кэша. Это снижает задержку и уменьшает нагрузку на источник данных.

Для файлов иконок может использоваться долгий Cache-Control, чтобы клиенты и CDN эффективнее переиспользовали уже подготовленные изображения.

Рекомендуется использовать стабильные параметры size, format и quality, чтобы эффективнее использовать кэш.
Назад
Сверху Снизу