Início Rápido — Gere a Sua Primeira Imagem OG
Este início rápido da FastOG coloca a sua primeira imagem Open Graph dinâmica em funcionamento em minutos. Criar uma conta é gratuito — depois escolha um plano Dynamic API para a quota de renderização. Cria a sua chave de API e o segredo HMAC quando precisar no painel de controlo. Cada renderização é limpa — sem marca de água em nenhum plano, incluindo o testador gratuito. Experimente o Testador de Imagens OG Gratuito para ver o pipeline em ação e, em seguida, assine os seus próprios URLs com os passos abaixo.
Como funciona — Arquitetura
A FastOG foi concebida para imagens OG on-demand: o seu site assina um URL no momento da renderização da página, o crawler obtém-no, a FastOG renderiza o PNG uma vez e a Cloudflare coloca-o em cache, de modo que todos os pedidos posteriores são instantâneos e gratuitos.
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
As três regras que fazem com que "simplesmente funcione"
- Assine o conteúdo, não o relógio. A assinatura cobre todos os parâmetros (título, template, …). Parâmetros idênticos produzem sempre o URL idêntico — é isso que faz a cache de borda funcionar: mesmo conteúdo → mesmo URL → cache hit para sempre.
- A imagem é permanente após a primeira renderização. A assinatura apenas controla a primeira renderização. Assim que uma imagem é renderizada, a borda da FastOG mantém-na durante um ano com base nos parâmetros de conteúdo — pedidos posteriores com os mesmos parâmetros são servidos a partir da borda e nunca chegam ao renderizador (não contam para a sua quota). Uma assinatura inválida em conteúdo em cache ainda devolve o PNG em cache (a resposta indica qual camada respondeu:
X-FastOG-Worker-Cache: HITouR2); apenas um cache miss recebe 401. - O único modo de falha. Um URL adulterado (alguém altera
title/template) recebe 401 na FastOG num cache miss — por isso nunca pode ser usado para gastar a sua quota. URLs legítimos nunca expiram: permanecem válidos até rodar o segredo HMAC da chave.
1. Obtenha a sua Chave de API e o Segredo HMAC
-
Aceda ao Painel FastOG → Chaves de API
-
Clique em "Criar Nova Chave de API"
-
Atribua um nome (por exemplo, "Site de Produção")
-
Copie ambos os valores (apresentados apenas uma vez!):
- Chave de API:
sk_...(32 caracteres após o prefixo) - Segredo HMAC: string hexadecimal de 64 caracteres
- Chave de API:
-
Guarde-os no seu ambiente:
# 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. Implementar a função de assinatura de URL
Para tutoriais completos com vários frameworks e padrões, consulte:
- 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
// 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)
// 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)
# 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. Utilização no seu Blog/Site
Next.js App Router
// 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
{{-- 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>
Template 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. Teste a Sua Implementação
# 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>"
Resultado esperado:
- ✅ Assinatura válida → Devolve a imagem OG
- ❌ Parâmetro adulterado (por exemplo,
titlealterado) →{"code": "invalid_signature"} - ❌ Assinatura inválida →
{"code": "invalid_signature"}
5. Lista de Verificação de Segurança
- [ ] Segredo HMAC armazenado em variáveis de ambiente (não no código)
- [ ] Utilização de HTTPS em todos os pedidos
- [ ] Segredo nunca exposto em JavaScript do lado do cliente
- [ ] Monitorização de tentativas de assinatura falhadas
6. Tratar Erros
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;
}
}
Próximos Passos
- Implemente a assinatura no backend do seu site (consulte os tutoriais)
- Teste com a API da FastOG
- Monitore os registos (logs) para tentativas de assinatura falhadas
- Configure alertas para falhas repetidas
Para documentação completa, consulte o Guia de Assinatura HMAC.