概要
APIレスポンスの理解
ByByBG APIは、成功・エラー・アップロード制限・レート制限を示すために標準HTTPステータスコードを返します。
ヒント:
安定したユーザー体験を提供するため、本番環境では常に適切なエラーハンドリングを実装してください。
STATUS CODES
一般的なHTTPステータスコード
Code
Description
200
背景削除が正常に完了しました。
400
無効なリクエスト、または画像ファイルがありません。
401
APIキーが存在しないか無効です。
403
アクセスが拒否されました。
413
アップロードされた画像ファイルが大きすぎます。
415
対応していない画像形式です。
429
リクエストが多すぎます。レート制限を超えました。
500
内部サーバー処理エラー。
503
サービスは一時的に利用できません。
LIMITS
アップロード制限
- 最大画像サイズ: 10MB
- 対応形式: PNG、JPG、JPEG、WEBP
- 透過出力形式: PNG
- APIリクエストにはレート制限が適用される場合があります。
- 大きな画像は処理時間が長くなる可能性があります。
TROUBLESHOOTING
一般的な問題と解決策
無効なAPIキー
APIキーとリクエストヘッダーを確認してください。
画像サイズが大きすぎる
アップロード前に画像を圧縮してサイズを小さくしてください。
ネットワークエラー
インターネット接続とバックエンドサーバーの状態を確認してください。
レート制限
リクエスト頻度を下げるか、プランをアップグレードしてください。
BEST PRACTICES
本番環境向け推奨事項
- 失敗したリクエストには再試行処理を実装してください。
- 分かりやすいエラーメッセージを表示してください。
- 送信前にアップロードファイルを検証してください。
- 大きな画像は事前に圧縮してください。
- 可能な場合は成功レスポンスをキャッシュしてください。
- API利用状況とレート制限を監視してください。
ERROR RESPONSE
エラーJSONレスポンス例
{
"success": false,
"error": "Invalid API key"
}ドキュメント完了
これでByByBG APIをWebサイト、モバイルアプリ、SaaSプラットフォーム、および自動化システムへ統合する準備が整いました。