Imagens OG em PHP e Laravel

Este guia aborda imagens OG em PHP e Laravel com FastOG — assine um URL HMAC no seu backend, coloque-o numa meta tag, e as suas publicações de blogue obtêm imagens Open Graph dinâmicas automaticamente. Baseado em subscrição com uma conta gratuita (escolha um plano Dynamic API; crie a sua chave de API no dashboard); experimente o Free OG Image Tester para pré-visualizar um modelo antes de o configurar.

Guia completo para implementar URLs de imagens OG assinados com HMAC em PHP e Laravel.

Início Rápido

1. Criar o serviço de assinatura

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

Porquê rawurlencode? A consulta canónica é codificada em percentagem conforme RFC-3986 (espaços → %20, nunca +). rawurlencode corresponde exatamente a isto — urlencode não (emite +), o que quebra a assinatura e devolve invalid_signature. Passar PHP_QUERY_RFC3986 a http_build_query mantém o URL final na mesma codificação.

2. Configuração

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. Registar como 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

Controlador

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

Rota da API

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

Exemplo de E-commerce

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

Exemplo de Publicação de Blog

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

PHP Puro (Sem 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>

Armadilhas Comuns

Assinar a Mensagem Errada

❌ Errado: hash_hmac('sha256', 'GET/api/v1/og' . $canonical, $hmacSecret) — falta o separador de nova linha. ✅ Correto: hash_hmac('sha256', 'GET/api/v1/og' . "\n" . $canonical, $hmacSecret) — método + caminho, uma nova linha e, em seguida, a query canónica.

Deixar `key` Fora da Assinatura

❌ Errado: assinar apenas os seus parâmetros de conteúdo e anexar key ao URL posteriormente. ✅ Correto: key é fundido nos parâmetros antes de a query canónica ser construída e aparece no URL final.

Parâmetros Repetidos (Arrays)

Passe valores de array para generateSignedOgUrl e deixe http_build_query escrever o URL: ele emite chaves entre parênteses retos (features[0]=a&features[1]=b) enquanto o canónico assina chaves repetidas simples (features=a&features=b). Não construa features=a&features=b manualmente no URL — o PHP descodifica chaves repetidas num escalar (vence o último valor), pelo que o servidor reconstrói um canónico diferente e rejeita com invalid_signature.

401 `missing_signature` / `invalid_signature`

missing_signature (401) significa que key ou s está em falta no URL. invalid_signature (401) significa que o canónico não correspondeu — confirme a nova linha na mensagem assinada, o mesmo hmac_secret em ambos os lados, rawurlencode (não urlencode) para cada chave e valor, e chaves entre parênteses retos para parâmetros repetidos no URL.

Expor o Segredo HMAC

Nunca exponha FASTOG_HMAC_SECRET em JavaScript no frontend ou em ficheiros de configuração públicos.