OG-Bilder in PHP & Laravel

Dieser Leitfaden behandelt OG-Bilder in PHP & Laravel mit FastOG – signieren Sie eine HMAC-URL auf Ihrem Backend, fügen Sie sie in ein Meta-Tag ein, und Ihre Blog-Beiträge erhalten automatisch dynamische Open-Graph-Bilder. Abonnementbasiert mit einem kostenlosen Konto (wählen Sie einen Dynamic-API-Plan; erstellen Sie Ihren API-Schlüssel im Dashboard); testen Sie den kostenlosen OG-Bild-Tester, um eine Vorlage zu prüfen, bevor Sie sie einbinden.

Vollständiger Leitfaden zur Implementierung HMAC-signierter OG-Bild-URLs in PHP und Laravel.

Schnellstart

1. Signer-Dienst erstellen

php

// app/Services/QuickogSigner.php
namespace App\Services;

class QuickogSigner
{
    public function generateSignedOgUrl(array $params, array $options = []): string
    {
        $baseUrl = $options['base_url'] ?? config('services.fastog.base_url', 'https://fastog.com/api/v1/og');
        $apiKey = $options['api_key'] ?? config('services.fastog.api_key');
        $hmacSecret = $options['hmac_secret'] ?? config('services.fastog.hmac_secret');

        if (!$apiKey || !$hmacSecret) {
            throw new \RuntimeException('Missing FASTOG_API_KEY or FASTOG_HMAC_SECRET');
        }

        // Canonical query: every param except `s`, including `key`
        $all = array_merge($params, ['key' => $apiKey]);

        $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]), '', '&', PHP_QUERY_RFC3986);
    }
}

Warum rawurlencode? Die kanonische Abfrage ist gemäß RFC-3986 prozentkodiert (Leerzeichen → %20, niemals +). rawurlencode entspricht diesem Format exakt — urlencode tut das nicht (es erzeugt +), was die Signatur bricht und invalid_signature zurückgibt. Die Übergabe von PHP_QUERY_RFC3986 an http_build_query hält die endgültige URL in derselben Kodierung.

2. Konfiguration

php

// config/services.php
return [
    // ...
    'fastog' => [
        'api_key' => env('FASTOG_API_KEY'),
        'hmac_secret' => env('FASTOG_HMAC_SECRET'),
        'base_url' => env('FASTOG_BASE_URL', 'https://fastog.com/api/v1/og'),
    ],
];

bash

# .env
FASTOG_API_KEY=sk_your_full_api_key_here
FASTOG_HMAC_SECRET=your_64_char_hex_secret_here

3. Als Singleton registrieren

php

// app/Providers/AppServiceProvider.php
use App\Services\QuickogSigner;

public function register(): void
{
    $this->app->singleton(QuickogSigner::class);
}

Laravel Blade

blade

{{-- resources/views/blog/show.blade.php --}}
@extends('layouts.app')

@section('head')
    <meta property="og:image" content="{{ $ogImageUrl }}" />
    <meta property="og:title" content="{{ $post->title }}" />
    <meta property="og:description" content="{{ $post->excerpt }}" />
@endsection

@section('content')
    <article>
        <h1>{{ $post->title }}</h1>
        <p>{{ $post->excerpt }}</p>
    </article>
@endsection

Controller

php

// app/Http/Controllers/BlogController.php
namespace App\Http\Controllers;

use App\Services\QuickogSigner;
use App\Models\Post;

class BlogController extends Controller
{
    public function show(Post $post, QuickogSigner $signer)
    {
        $ogImageUrl = $signer->generateSignedOgUrl([
            'template' => 'blog',
            'title' => $post->title,
            'subtitle' => $post->excerpt,
            'author' => $post->author->name,
        ]);

        return view('blog.show', compact('post', 'ogImageUrl'));
    }
}

API-Route

php

// routes/api.php
use App\Services\QuickogSigner;
use Illuminate\Http\Request;

Route::get('/og', function (Request $request, QuickogSigner $signer) {
    $validated = $request->validate([
        'title' => 'required|string',
        'template' => 'nullable|string',
    ]);

    $ogImageUrl = $signer->generateSignedOgUrl([
        'template' => $validated['template'] ?? 'default',
        'title' => $validated['title'],
    ]);

    return response()->json(['ogImageUrl' => $ogImageUrl]);
});

E-Commerce-Beispiel

php

// app/Http/Controllers/ProductController.php
public function show(Product $product, QuickogSigner $signer)
{
    $ogImageUrl = $signer->generateSignedOgUrl([
        'template' => 'ecommerce',
        'title' => $product->name,
        'price' => $product->formatted_price,
        'image' => $product->image_url,
    ]);

    return view('products.show', compact('product', 'ogImageUrl'));
}

Blogbeitrag-Beispiel

php

// app/Http/Controllers/ProfileController.php
public function show(User $user, QuickogSigner $signer)
{
    $ogImageUrl = $signer->generateSignedOgUrl([
        'template' => 'blog',
        'title' => $user->name,
        'subtitle' => $user->bio,
        'author' => $user->name,
    ]);

    return view('profile.show', compact('user', 'ogImageUrl'));
}

Plain PHP (Ohne Framework)

php

// lib/fastog-signer.php
function generateSignedOgUrl(array $params, array $options = []): string
{
    $baseUrl = $options['base_url'] ?? 'https://fastog.com/api/v1/og';
    $apiKey = $options['api_key'] ?? $_ENV['FASTOG_API_KEY'];
    $hmacSecret = $options['hmac_secret'] ?? $_ENV['FASTOG_HMAC_SECRET'];

    $all = array_merge($params, ['key' => $apiKey]);

    $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]), '', '&', PHP_QUERY_RFC3986);
}

php

// index.php
require_once 'lib/fastog-signer.php';

$ogUrl = generateSignedOgUrl([
    'template' => 'blog',
    'title' => 'My Blog Post',
]);
?>
<!DOCTYPE html>
<html>
<head>
    <meta property="og:image" content="<?= htmlspecialchars($ogUrl) ?>" />
    <meta property="og:title" content="My Blog Post" />
</head>
<body>
    <h1>My Blog Post</h1>
</body>
</html>

Häufige Fehlerquellen

Die falsche Nachricht signieren

❌ Falsch: hash_hmac('sha256', 'GET/api/v1/og' . $canonical, $hmacSecret) — das Zeilenumbruch-Trennzeichen fehlt. ✅ Richtig: hash_hmac('sha256', 'GET/api/v1/og' . "\n" . $canonical, $hmacSecret) — Methode + Pfad, ein Zeilenumbruch, dann die kanonische Abfrage.

`key` aus der Signatur auslassen

❌ Falsch: Nur Ihre Inhalts-Parameter signieren und key anschließend an die URL anhängen. ✅ Richtig: key wird in die Parameter eingefügt, bevor die kanonische Abfrage erstellt wird, und erscheint in der endgültigen URL.

Wiederholte Parameter (Arrays)

Übergeben Sie Array-Werte an generateSignedOgUrl und lassen Sie http_build_query die URL schreiben: Es erzeugt Klammer-Schlüssel (features[0]=a&features[1]=b), während die kanonische Abfrage einfache wiederholte Schlüssel signiert (features=a&features=b). Bauen Sie features=a&features=b nicht manuell in die URL ein — PHP dekodiert wiederholte Schlüssel in einen Skalar (der letzte Wert gewinnt), sodass der Server eine andere kanonische Abfrage erstellt und mit invalid_signature ablehnt.

401 `missing_signature` / `invalid_signature`

missing_signature (401) bedeutet, dass key oder s in der URL fehlt. invalid_signature (401) bedeutet, dass die kanonische Abfrage nicht übereinstimmte — prüfen Sie den Zeilenumbruch in der signierten Nachricht, denselben hmac_secret auf beiden Seiten, rawurlencode (nicht urlencode) für jeden Schlüssel und Wert sowie Klammer-Schlüssel für wiederholte Parameter in der URL.

HMAC-Geheimnis offenlegen

Setzen Sie FASTOG_HMAC_SECRET niemals in Frontend-JavaScript oder öffentlichen Konfigurationsdateien ein.