APIドキュメント - 圧縮インターフェース完全説明

SmartSlim圧縮APIの完全なOpenAPI 3.0仕様ドキュメント、すべてのインターフェース説明、パラメータ定義、エラーコードリファレンスとレート制限戦略を含む

認証方式

SmartSlim圧縮APIはBearer Token方式で認証を行います

Bearer Token

API KeyはHTTPリクエストヘッダー Authorization で送信、フォーマットは Bearer YOUR_API_KEY。すべてのインターフェースリクエストはこのヘッダーの携帯が必要、欠落または無効の場合は401エラーを返します。

転送安全

すべてのAPIリクエストはHTTPS暗号化転送経由、HTTP平文プロトコルでの呼び出しは行わないでください、転送プロセス中のAPI Keyとファイルデータの安全性を保証。

API Key 管理

API Keyはデベロッパーコンソールのアプリ管理で確認、リセットと無効化が可能。異なる環境（開発/テスト/本番）に対して独立したアプリの作成を推奨、分離と監査に便利。

# 認証リクエストヘッダーサンプル
Authorization: Bearer YOUR_API_KEY

インターフェースリスト

SmartSlim圧縮APIはファイル圧縮、タスク管理、バッチ処理と使使用量統計など完全なインターフェースを提供

POST /v1/compress

ファイル圧縮：アップロード単个ファイルおよび実行圧縮。

  • file（必填）：待圧縮ファイル
  • quality：圧縮質量、オプションで low / medium / high
  • format：出力フォーマット
  • password（オプションで）：暗号化圧縮密码

GET /v1/tasks/{task_id}

タスク状態照会：タスクに基づき ID 取得圧縮タスクの現在の状態与結果情報。

  • 返します status：pending / processing / completed / failed

GET /v1/tasks/{task_id}/download

圧縮ファイルダウンロード：タスク完了後、このインターフェースで圧縮結果ファイルをダウンロード、ファイルストリームを返します。

POST /v1/batch/compress

バッチ圧縮：一次アップロード複数ファイル実行バッチ圧縮処理。

  • files[]（必填）：待圧縮ファイル数组
  • quality：圧縮質量
  • format：出力フォーマット
  • callback_url（オプションで）：任務完了コールバックURL

GET /v1/usage

使使用量統計照会：取得現在のアカウントの使使用量データ、今月の呼び出し回数を含む、圧縮ファイル総量、ストレージ使用量等。

DELETE /v1/tasks/{task_id}

删除任務：タスクに基づき ID 删除指定的圧縮任務及その結果ファイル、释放ストレージ空間。

ファイル圧縮インターフェースリクエストサンプル

POST /v1/compress HTTP/1.1
Host: api.uglypear.com
Authorization: Bearer YOUR_API_KEY
Content-Type: multipart/form-data; boundary=----FormBoundary

------FormBoundary
Content-Disposition: form-data; name="file"; filename="document.pdf"
Content-Type: application/pdf

(ファイル二进制コンテンツ)
------FormBoundary
Content-Disposition: form-data; name="quality"

high
------FormBoundary
Content-Disposition: form-data; name="format"

pdf
------FormBoundary--

タスク状態照会レスポンスサンプル

{
 "task_id": "task_8f3c2a1b9e7d4c5f",
 "status": "completed",
 "download_url": "https://api.uglypear.com/v1/tasks/task_8f3c2a1b9e7d4c5f/download",
 "original_size": 5242880,
 "compressed_size": 1572864,
 "compression_ratio": "70.0%",
 "created_at": "2026-08-05T10:00:00Z",
 "completed_at": "2026-08-05T10:00:08Z"
}

エラーコードリファレンス

インターフェース呼び出しプロセス中に返される可能性のあるHTTPステータスコードとその意味の説明、トラブルシューティングと異常処理に便利

HTTP ステータスコード 名称 説明
200 成功 リクエスト処理成功、期待される結果データを返します。
400 リクエストパラメータエラー リクエストパラメータ欠落、フォーマット不正確または超出限制、请検査リクエスト体与パラメータ。
401 API Key 无效または過期 未携帯 Authorization 頭、API Key 无效または已過期、请重新取得効果的に密钥。
403 权限不足 現在のAPI Keyには当該リソースまたは操作へのアクセス権限がありません、プラン権限とリソース帰属を確認してください。
429 リクエスト频率超限 リクエスト频率超出現在套餐的限流阈值、请削減呼び出し频率またはアップグレード套餐。
500 サービス器内部エラー サーバー側処理プロセス中に異常が発生、後ほど再試行またはテクニカルサポートに連絡してください。
503 サービス暂時不利用可能 サービスはメンテナンス中または一時過負荷、後ほど再試行してください。

エラーレスポンスサンプル

{
 "error": {
  "code": 429,
  "message": "リクエスト频率超限、現在套餐限制为 60 次/分钟",
  "request_id": "req_a1b2c3d4e5f6"
 }
}

限流戦略

不同套餐対応不同的リクエスト频率上限、超限に返します 429 エラー、请基づきビジネス量級選定合適套餐

10

無料版
次/分钟

60

ベーシック版
次/分钟

300

プロ版
次/分钟

無制限

エンタープライズ版
オンデマンド設定

レート制限はAPI Keyを単位として統計、スライディングウィンドウアルゴリズムで毎分リクエスト数を計算。レート制限トリガー時、レスポンスヘッダーに X-RateLimit-Limit、X-RateLimit-Remaining 与 X-RateLimit-Reset フィールド、クライアントのバックオフリトライ戦略実装に便利。

サポート的ファイルフォーマット

SmartSlim圧縮APIはドキュメント、画像、動画、オーディオなど複数タイプのファイルフォーマットをカバー、多様な圧縮ニーズを満たす

ドキュメントフォーマット

PDF、OFD、DOCX、XLSX、PPTX

画像フォーマット

JPG、PNG、TIFF、GIF、BMP

動画フォーマット

MP4、AVI、MOV

オーディオフォーマット

MP3、WAV

各フォーマットがサポートする圧縮品質、出力オプションとサイズ制限には差異が存在する可能性、詳細はコンソールと実際のインターフェースレスポンスを基準。他のフォーマットのサポートが必要な場合、営業チームに連絡してカスタムソリューションをご相談ください。

オンラインデバッガー

基づく Swagger UI 的オンライン API デバッグ工具、即座にに上線

ビジュアルデバッグ

オンラインデバッガーはビジュアルなインターフェースパラメータ入力とリクエスト送信機能を提供、コードを記述せずにインターフェースの動作とレスポンス構造を迅速に検証可能。

OpenAPI 3.0 仕様

完全な遵循 OpenAPI 3.0 仕様、サポートエクスポート仕様ファイル、可能直接導入 Postman、Apifox 等工具実行ローカルデバッグ。

即座にに上線

Swagger UIオンラインデバッガーは開発中、公開後はブラウザ上で直接完全なインターフェースデバッグフローを体験可能。それまでクイックスタートのコード例を参照できます。

確認クイックスタート

今すぐAPIを利用開始

アカウントを登録してAPI Keyを取得、SmartSlim圧縮機能をお客様のアプリに迅速に統合

クイックスタート 理解 API サービス コンサルティングビジネス

関連ページ

クイックスタート SDKダウンロード コード例 更新ログ