PixSpeed API を使用すると、WebP、JPEG、PNG、AVIF などの形式で画像を圧縮および最適化できます。RESTful サービスとして設計された PixSpeed の API により、Web アプリケーション間で画像最適化をシームレスに統合できます。このページでは、コア HTTP API の詳細について説明します。さらに、PixSpeed API とのやり取りを簡素化するために、さまざまな言語でクライアント ライブラリを開発しています。
API はapi.pixspeed.comでホストされています。
PixSpeed API にアクセスするには、固有の API キーを入力する必要があります。名前とメール アドレスを入力してサインアップすると、API キーを取得できます。API キーは必ず秘密にしておいてください。
API による認証は、HTTP ヘッダーを通じて処理されます。すべてのリクエストには、key: YOUR_API_KEY形式の API キーを含む Authorization ヘッダーが必要です。ここで、 YOUR_API_KEYはアカウント ページで利用できるキーです。
セキュリティ上の理由から、送信中にデータを保護するために、すべてのリクエストは暗号化された HTTPS 接続を介して送信する必要があります。
PixSpeed API に WebP、JPEG、PNG 画像の URL を指定して圧縮することができます。PixSpeed は画像の種類を自動的に検出し、最適な圧縮を適用します。URL を指定するとすぐに圧縮が開始されます。
URL を使用した圧縮の例
PixSpeed を画像 URL で使用するには、 YOUR_API_KEY独自の API キー (PixSpeed アカウント ページにあります) に置き換え、次に示すように JSON 形式で画像 URL を指定します。
curl -X POST https://api.pixspeed.com/v1/url \
-H "Content-Type: application/json" \
-H "key: YOUR_API_KEY" \
-d '{"url": "https://example.com/path/to/your-image.jpg"}'
PixSpeed は指定された URL から画像を取得し、圧縮して、最適化されたバージョンの URL を応答で返します。
PixSpeed API を使用すると、画像を圧縮できるだけでなく、さまざまな形式に変換することもできます。PixSpeed は自動的に画像を最適化し、形式が指定されている場合は目的の種類に変換します。サポートされている形式には、 jpg 、 jpeg 、 png 、 webp 、およびavifがあります。形式が指定されていない場合、PixSpeed は画像の元の形式を保持します。
画像の URL と形式で cURL を使用する例
PixSpeed を使用して画像を最適化および変換するには、 YOUR_API_KEY独自の API キーに置き換え、以下に示すように、JSON 形式で画像の URL と目的の形式を指定します。形式は、サポートされている形式 ( jpg 、 jpeg 、 png 、 webp 、 avif ) のいずれかにすることができ、PixSpeed はそれに応じて画像を変換します。
curl -X POST https://api.pixspeed.com/v1/url \
-H "Content-Type: application/json" \
-H "key: YOUR_API_KEY" \
-d '{"url": "https://example.com/path/to/your-image.jpg", "format": "webp"}'
PixSpeed は、指定された URL から画像を最適化し、 webpに変換して、最適化されたバージョンの URL を応答で返します。