Обзор
Понимание ответов API
API ByByBG использует стандартные HTTP-коды состояния для обозначения успешных операций, ошибок, ограничений загрузки и лимитов запросов.
Совет:
Всегда реализуйте корректную обработку ошибок в продакшен-среде для обеспечения стабильной работы пользователей.
STATUS CODES
Распространённые HTTP-коды
Code
Description
200
Удаление фона успешно завершено.
400
Неверный запрос или отсутствует файл изображения.
401
API-ключ отсутствует или недействителен.
403
Доступ запрещён.
413
Загруженный файл изображения слишком большой.
415
Неподдерживаемый формат изображения.
429
Слишком много запросов. Превышен лимит запросов.
500
Внутренняя ошибка обработки на сервере.
503
Сервис временно недоступен.
LIMITS
Лимиты загрузки
- Максимальный размер изображения: 10 МБ
- Поддерживаемые форматы: PNG, JPG, JPEG, WEBP
- Формат прозрачного результата: PNG
- API-запросы могут быть ограничены лимитами частоты.
- Обработка больших изображений может занимать больше времени.
TROUBLESHOOTING
Распространённые проблемы и решения
Недействительный API-ключ
Проверьте ваш API-ключ и заголовки запроса.
Слишком большое изображение
Сожмите или уменьшите изображение перед загрузкой.
Сетевая ошибка
Проверьте интернет-соединение и статус backend-сервера.
Превышен лимит запросов
Уменьшите частоту запросов или обновите тарифный план.
BEST PRACTICES
Рекомендации для продакшена
- Реализуйте автоматические повторные попытки для неудачных запросов.
- Показывайте пользователям понятные сообщения об ошибках.
- Проверяйте загружаемые файлы перед отправкой.
- Предварительно сжимайте большие изображения.
- Используйте кэширование успешных ответов, когда это возможно.
- Отслеживайте использование API и лимиты запросов.
ERROR RESPONSE
Пример JSON-ответа с ошибкой
{
"success": false,
"error": "Invalid API key"
}Документация завершена
Теперь вы готовы интегрировать API ByByBG в веб-сайты, мобильные приложения, SaaS-платформы и системы автоматизации.