Skip to content
smallPict
無料で始める

REST API 概要とアーキテクチャ

OpenAPI 3.1 準拠のエンドポイント仕様、ベースURL、リクエスト標準。

SmallPict REST API は、OpenAPI 3.1に完全準拠した高性能Webサービスであり、開発者が分散画像最適化、フォーマット変換、エッジCDN配信パイプラインに直接アクセスできるようにします。

ベースURL

環境エンドポイントURL説明
本番環境 (Production)https://api.smallpict.app/v1グローバルAnycastルーティングを備えた本番ゲートウェイ
ローカルモックサーバーhttp://localhost:8080/v1単体テストおよびローカル開発用サンドボックス

主要APIエンドポイント

保護されたすべてのエンドポイントにはHMAC-SHA256認証ヘッダーが必要です（詳細は 認証仕様ガイド を参照）。

1. 画像の最適化と変換

  • エンドポイント: POST /v1/optimize (別名: POST /v1/convert)
  • 説明: 画像メタデータまたはバイナリを送信し、圧縮およびフォーマット変換（AVIF, WebP, JPEG, PNG）を実行します。

2. 非同期ジョブのステータス確認

  • エンドポイント: GET /v1/optimize/status?job_id={job_id}
  • 説明: 非同期画像変換ジョブの進捗、削減率、完了時のCDNダウンロードURLを照会します。

3. アカウントクォータと使用状況の取得

  • エンドポイント: GET /v1/quota
  • 説明: リアルタイムの処理済みバイト数、プランの月間上限、CDN帯域幅の消費量を返します。

4. エッジCDNキャッシュのパージ

  • エンドポイント: POST /v1/purge
  • 説明: 世界300以上のSmallPict Edge PoPノード全体で指定アセットのキャッシュを即時無効化します。

リクエスト・レスポンス標準

  • すべてのリクエストペイロードは原則として application/json 形式です（直接バイナリ送信時は multipart/form-data）。
  • すべてのレスポンスボディは標準化されたJSONを返し、日時はRFC3339国際規格に準拠します。
  • 状態を変更するエンドポイント（POST, DELETE, PATCH）は Idempotency-Key（UUID v4）ヘッダーに対応しており、ネットワーク再試行時にも二重課金は発生しません。