OG-afbeeldingen in PHP & Laravel

Deze handleiding behandelt OG-afbeeldingen in PHP & Laravel met FastOG — onderteken een HMAC-URL op je backend, plaats deze in een meta-tag, en je blogposts krijgen automatisch dynamische Open Graph-afbeeldingen. Op abonnementsbasis met een gratis account (kies een Dynamic API-plan; maak je API-sleutel aan in het dashboard); probeer de gratis OG Image Tester om een template te bekijken voordat je het aansluit.

Volledige handleiding voor het implementeren van HMAC-ondertekende OG-afbeeldings-URL's in PHP en Laravel.

Snel aan de slag

1. Maak de signer-service aan

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);
    }
}

Waarom rawurlencode? De canonieke query is percent-gecodeerd volgens RFC-3986 (spaties → %20, nooit +). rawurlencode komt hier exact mee overeen — urlencode niet (dit genereert +), wat de handtekening verbreekt en invalid_signature retourneert. Door PHP_QUERY_RFC3986 aan http_build_query door te geven, blijft de uiteindelijke URL in dezelfde codering.

2. Configuratie

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. Registreer als singleton

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-commercevoorbeeld

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'));
}

Blogpost-voorbeeld

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 (zonder 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>

Veelvoorkomende valkuilen

De verkeerde boodschap ondertekenen

❌ Fout: hash_hmac('sha256', 'GET/api/v1/og' . $canonical, $hmacSecret) — de nieuwe regel-scheidingsteken ontbreekt. ✅ Correct: hash_hmac('sha256', 'GET/api/v1/og' . "\n" . $canonical, $hmacSecret) — methode + pad, een nieuwe regel, en daarna de canonieke query.

`key` buiten de handtekening laten

❌ Fout: alleen je contentparameters ondertekenen en key achteraf aan de URL toevoegen. ✅ Correct: key wordt samengevoegd met de parameters voordat de canonieke query wordt opgebouwd, en verschijnt in de uiteindelijke URL.

Herhaalde parameters (arrays)

Geef arraywaarden door aan generateSignedOgUrl en laat http_build_query de URL schrijven: het genereert haakjessleutels (features[0]=a&features[1]=b) terwijl de canonieke vorm gewone herhaalde sleutels ondertekent (features=a&features=b). Bouw features=a&features=b niet handmatig in de URL — PHP decodeert herhaalde sleutels naar een scalar (laatste waarde wint), waardoor de server een andere canonieke vorm opbouwt en afwijst met invalid_signature.

401 `missing_signature` / `invalid_signature`

missing_signature (401) betekent dat key of s ontbreekt in de URL. invalid_signature (401) betekent dat de canonieke vorm niet overeenkwam — controleer de nieuwe regel in de ondertekende boodschap, dezelfde hmac_secret aan beide kanten, rawurlencode (niet urlencode) voor elke sleutel en waarde, en haakjessleutels voor herhaalde parameters in de URL.

HMAC-geheim blootstellen

Stel FASTOG_HMAC_SECRET nooit bloot in frontend-JavaScript of openbare configuratiebestanden.