クイックスタート — 最初のOG画像を生成する
このFastOGクイックスタートでは、最初の動的なOpen Graph画像を数分で公開できます。サインアップは無料です。その後、レンダリング枠のためにDynamic APIプランを選択します。APIキーとHMACシークレットは、ダッシュボードで必要に応じて作成します。すべてのレンダリングはクリーンで、どのプランでも透かしは入りません。無料のテスターも含まれます。無料のOG画像テスター(Free OG Image Tester)でパイプラインの動作を確認し、以下の手順で自分のURLに署名してください。
仕組み — アーキテクチャ
FastOGはオンデマンドのOG画像向けに構築されています。ウェブサイトはページレンダリング時にURLに署名し、クローラーがそれを取得し、FastOGがPNGを一度だけレンダリングし、Cloudflareがそれをキャッシュするため、以降の取得はすべて即座に、かつ無料で行われます。
sequenceDiagram
participant You as You share a link
participant Crawler as Social crawler
participant Site as Your website
participant FastOG as FastOG API
participant Edge as Edge cache
You->>Crawler: share a link to your post
Crawler->>Site: GET the page without JavaScript
Site->>Site: sign the og:image URL at render time
Site-->>Crawler: HTML with signed og:image URL
Crawler->>Edge: fetch the og:image URL
Edge->>FastOG: cache miss, first time
FastOG->>FastOG: verify the HMAC covers the exact params
FastOG-->>Edge: render PNG, counts 1 toward monthly quota, cached for 1 year
Edge-->>Crawler: PNG
Crawler-->>You: image shown in the post preview
Note over Edge, Crawler: identical params and URL mean a cache hit with no render
「そのまま機能する」ための3つのルール
- 時刻ではなくコンテンツに署名する。 署名はすべてのパラメータ(タイトル、テンプレートなど)を対象とします。同一のパラメータは常に同一のURLを生成します。これがエッジキャッシュを機能させる仕組みです。同じコンテンツ → 同じURL → キャッシュヒットが永続します。
- 画像は最初のレンダリング後に永続化される。 署名は_最初の_レンダリングのみを制限します。画像が一度レンダリングされると、FastOGのエッジはコンテンツパラメータをキーとして1年間保持します。同じパラメータでの以降のリクエストはエッジから配信され、レンダラーには到達しません(クォータにカウントされません)。キャッシュ済みコンテンツに対する不正な署名でも、キャッシュされたPNGが返されます(レスポンスはどの階層が応答したかを報告します:
X-FastOG-Worker-Cache: HITまたはR2)。401が返されるのはキャッシュミスの場合のみです。 - 唯一の障害モード。 改ざんされたURL(誰かが
title/templateを変更した場合)は、キャッシュミス時にFastOGで401が返されます。そのため、クォータを消費するために使用されることは決してありません。正規のURLは期限切れになりません。キーのHMACシークレットをローテーションするまで有効です。
1. APIキーとHMACシークレットを取得する
-
FastOGダッシュボード → APIキー に移動します
-
「新しいAPIキーを作成」 をクリックします
-
名前を付けます(例:「本番サイト」)
-
両方の値をコピーします(一度だけ表示されます):
- APIキー:
sk_...(プレフィックス後の32文字) - HMACシークレット: 64文字の16進数文字列
- APIキー:
-
環境変数に保存します:
env
# Your website backend .env
FASTOG_API_KEY=sk_your_full_api_key
FASTOG_HMAC_SECRET=a1b2c3d4e5f6... # 64 chars
FASTOG_API_URL=https://fastog.com/api/v1/og
2. URL署名関数の実装
複数のフレームワークとパターンを用いた完全なチュートリアルについては、以下を参照してください:
- Next.js App Router
- Next.js Pages Router
- React
- SvelteKit
- Vue / Nuxt
- Astro
- Express
- Vanilla Node.js
- JavaScript
- PHP / Laravel
- Python
- Ruby / Rails
Node.js / Next.js
javascript
// lib/fastog-signer.js
import crypto from "crypto";
// RFC-3986 encode (encodeURIComponent leaves !'()* unencoded).
const enc = (s) =>
encodeURIComponent(s).replace(
/[!'()*]/g,
(c) => "%" + c.charCodeAt(0).toString(16).toUpperCase(),
);
export function generateOgImageUrl(params) {
const baseUrl = process.env.FASTOG_API_URL;
const apiKey = process.env.FASTOG_API_KEY;
const hmacSecret = process.env.FASTOG_HMAC_SECRET;
const all = { ...params, key: apiKey };
// Canonical: every param (except s), sorted, RFC-3986 encoded, joined with "&".
const pairs = [];
for (const [k, v] of Object.entries(all)) {
for (const vv of Array.isArray(v) ? v : [v])
pairs.push(`${enc(k)}=${enc(vv)}`);
}
pairs.sort();
const canonical = pairs.join("&");
// Content-signed: message = path + canonical query. No timestamp.
const signature = crypto
.createHmac("sha256", hmacSecret)
.update(`GET/api/v1/og\n${canonical}`)
.digest("hex");
const url = new URL(baseUrl);
for (const [k, v] of Object.entries(all)) {
for (const vv of Array.isArray(v) ? v : [v])
url.searchParams.append(k, vv);
}
url.searchParams.set("s", signature);
return url.toString();
}
PHP (Laravel)
php
// app/Services/QuickogSigner.php
function generateOgImageUrl(array $params): string
{
$baseUrl = config('services.fastog.api_url', 'https://fastog.com/api/v1/og');
$apiKey = config('services.fastog.api_key');
$hmacSecret = config('services.fastog.hmac_secret');
$all = array_merge($params, ['key' => $apiKey]);
// Canonical: every param except s, keys sorted (array values sorted too),
// RFC-3986 encoded, joined with '&'. Content-signed — no timestamp.
$pairs = [];
foreach ($all as $k => $v) {
$values = is_array($v) ? $v : [$v];
sort($values, SORT_STRING);
foreach ($values as $vv) {
$pairs[] = rawurlencode((string) $k) . '=' . rawurlencode((string) $vv);
}
}
sort($pairs, SORT_STRING);
$canonical = implode('&', $pairs);
$signature = hash_hmac('sha256', 'GET/api/v1/og' . "\n" . $canonical, $hmacSecret);
return $baseUrl . '?' . http_build_query(array_merge($all, ['s' => $signature]));
}
Python (Django/FastAPI)
python
# utils/fastog.py
import hmac
import hashlib
import os
from urllib.parse import quote, urlencode
def _enc(s):
return quote(str(s), safe='-._~') # RFC-3986: only unreserved chars
def generate_og_image_url(params: dict) -> str:
base_url = os.environ['FASTOG_API_URL']
api_key = os.environ['FASTOG_API_KEY']
hmac_secret = os.environ['FASTOG_HMAC_SECRET']
all_params = {**params, 'key': api_key}
# Canonical: every param except s, sorted, RFC-3986 encoded, joined with '&'.
pairs = []
for k, v in all_params.items():
for vv in sorted(v if isinstance(v, list) else [v]):
pairs.append(f"{_enc(k)}={_enc(vv)}")
canonical = '&'.join(sorted(pairs))
# Content-signed: message = path + canonical query. No timestamp.
signature = hmac.new(
hmac_secret.encode(),
f"GET/api/v1/og\n{canonical}".encode(),
hashlib.sha256,
).hexdigest()
return f"{base_url}?{urlencode({**all_params, 's': signature})}"
3. ブログ/ウェブサイトでの利用
Next.js App Router
tsx
// app/blog/[slug]/page.tsx
import { generateOgImageUrl } from "@/lib/fastog-signer";
export async function generateMetadata({ params }) {
const post = await getPost(params.slug);
const ogImageUrl = generateOgImageUrl({
template: "blog",
title: post.title,
subtitle: post.excerpt,
author: post.author.name,
});
return {
title: post.title,
description: post.excerpt,
openGraph: {
images: [ogImageUrl],
},
};
}
Laravel Blade
blade
{{-- resources/views/blog/show.blade.php --}}
@php
$ogImageUrl = generateOgImageUrl([
'template' => 'blog',
'title' => $post->title,
'subtitle' => $post->excerpt,
'author' => $post->author->name,
]);
@endphp
<head>
<meta property="og:image" content="{{ $ogImageUrl }}" />
<meta property="og:title" content="{{ $post->title }}" />
<meta property="og:description" content="{{ $post->excerpt }}" />
</head>
Django テンプレート
django
{# blog/post_detail.html #}
{% load fastog_tags %}
<head>
<meta property="og:image" content="{% generate_og_image_url post %}" />
<meta property="og:title" content="{{ post.title }}" />
<meta property="og:description" content="{{ post.excerpt }}" />
</head>
4. 実装をテストする
bash
# Generate a test URL
node -e "
const { generateOgImageUrl } = require('./lib/fastog-signer');
console.log(generateOgImageUrl({ title: 'Test', template: 'default' }));
"
# Test with curl
curl "https://fastog.com/api/v1/og?title=Test&key=sk_quick_123abc&s=<sig>"
期待される結果:
- ✅ 有効な署名 → OG画像を返す
- ❌ 改ざんされたパラメータ(例:
titleを変更)→{"code": "invalid_signature"} - ❌ 無効な署名 →
{"code": "invalid_signature"}
5. セキュリティチェックリスト
- [ ] HMACシークレットを環境変数に保存している(コード内に直接記述しない)
- [ ] すべてのリクエストでHTTPSを使用している
- [ ] シークレットをクライアントサイドのJavaScriptで公開していない
- [ ] 署名検証の失敗を監視している
6. エラーの処理
javascript
if (response.status === 401) {
const error = await response.json();
switch (error.code) {
case "missing_signature":
// URL is missing `key` or `s` — re-generate it with your signer.
break;
case "invalid_signature":
// A param changed after signing, or the secret doesn't match.
// Re-sign the URL after any content change; verify the secret on both sides.
break;
}
}
次のステップ
- ウェブサイトのバックエンドで署名を実装します(チュートリアルを参照)
- FastOG API でテストします
- 署名失敗の試行についてログを監視します
- 繰り返しの失敗に対するアラートを設定します
完全なドキュメントについては、HMAC 署名ガイド を参照してください。