Tópico

Integração com Agentes e LLMs — FastOG

Um guia completo e autónomo para integrar o FastOG a partir de qualquer linguagem do lado do servidor — escrito tanto para programadores humanos como para agentes de codificação de IA. Toda a superfície do cliente é uma única função: signedUrl(params, key, secret) → um URL <meta property="og:image"> pronto a incorporar.

Transferir a skill

Leve a skill completa consigo — coloque ambos os ficheiros no seu diretório agents/skills/fastog-integration/ para a carregar no Claude Code, Codex ou em qualquer agente:

SKILL.md — curl -O https://fastog.com/skill/SKILL.md
implementations.md — curl -O https://fastog.com/skill/implementations.md

Prefere um único ficheiro combinado? Esta página é a skill (contrato + implementações inline): curl -O https://fastog.com/docs-files/agent-integration.md

O contrato (o único)

URL        = https://fastog.com/api/v1/og?<content>&key=<apiKey>&s=<signature>
canonical  = every query param except `s` (INCLUDING `key`), keys sorted,
             array values sorted, each pair enc(key)=enc(value) RFC-3986,
             joined with "&"
message    = "GET/api/v1/og" + "\n" + canonical
signature  = hex(HMAC-SHA256(message, hmac_secret))

Invariantes (quebrar qualquer um → 401)

Codificação RFC-3986 — codifique em percentagem tudo exceto A-Za-z0-9-._~; espaço → %20, nunca +. PHP rawurlencode; JS encodeURIComponent + re-codificar !'()*; Python quote(safe='-._~'); codificador de bytes personalizado em Ruby/Go.
key é assinado — faz parte da query canónica, pelo que a assinatura está vinculada à chave.
Arrays precisam de chaves entre parênteses retos no URL — assine o canónico com a chave simples (features=…&features=…), mas o URL deve usar features[0]=… ou features[]=…. O backend é PHP: chaves repetidas sem parênteses retos (features=a&features=b) são descodificadas como um escalar (a última vence) → incompatibilidade canónica → 401.
Sem timestamp — endereçado por conteúdo. Parâmetros idênticos → URL idêntico → cacheável para sempre; qualquer alteração → 401 → sem renderização, sem consumo de quota.

Parâmetros reservados: s (assinatura — excluída do canónico), key (incluído), t (reservado — nunca usar).

Segurança (innegociável)

hmac_secret é privada — apenas no servidor. Nunca num browser, nunca num script público de CDN. Assinatura no cliente/browser nunca pode funcionar.
key é pública (aparece em todos os URLs) — esperado e seguro, porque forjar exige o segredo.
Apenas GET (crawlers nunca fazem POST). Assine no servidor no momento do pedido; o URL assinado é o que incorpora.

Exemplo prático

params    = {template:"blog", title:"Hello World", features:["Free shipping","30-day returns"], key:"sk_test123"}
secret    = 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef

canonical = features=30-day%20returns&features=Free%20shipping&key=sk_test123&template=blog&title=Hello%20World
signature = a79232b15b45002aee76174f542e0a661b37cb1259df01e263c952ca4052a54d
url       = https://fastog.com/api/v1/og?template=blog&title=Hello%20World&features%5B0%5D=Free%20shipping&features%5B1%5D=30-day%20returns&key=sk_test123&s=a79232b15b45002aee76174f542e0a661b37cb1259df01e263c952ca4052a54d

Assinantes de ficheiro único (zero dependências, sem gestor de pacotes)

Ainda não existe um pacote npm i/pip install — estes são assinantes de ficheiro único: cada um é descarregado como um único ficheiro e apenas produz o URL da imagem OG assinada (toda a lógica HMAC + RFC-3986, sem runtime). Descarregue e assine no servidor do cliente:

Linguagem/Framework	Ficheiro	One-liner
Node.js (CJS) / Express	`https://fastog.com/sdk/node.js` · `/sdk/express/fastog.js`	`ogImageUrl(params, { key, secret })`
ESM (SvelteKit / Next / Astro / Vue-Nuxt)	`/sdk/svelte/fastog.js` · `/sdk/next/fastog.js` · `/sdk/astro/fastog.js` · `/sdk/vue/fastog.js`	`ogImageUrl(params, { key, secret })`
PHP	`https://fastog.com/sdk/php/fastog.php.txt`	`FastOg::signedUrl($params, $key, $secret)`
Ruby / Rails	`https://fastog.com/sdk/ruby/fastog.rb`	`FastOg.signed_url(params, key, secret)`
Python	`https://fastog.com/sdk/python/fastog.py`	`fastog.signed_url(params, key, secret)`
Go	`https://fastog.com/sdk/go/fastog.go`	`fastog.SignedURL(params, key, secret)`

Incorpore o resultado:

html

<meta property="og:image" content="https://fastog.com/api/v1/og?…&key=…&s=…" />

Vetor dourado (auto-verificação de QUALQUER implementação)

params    = {template:"blog", title:"Hello World", features:["Free shipping","30-day returns"], key:"sk_test123"}
secret    = 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
canonical = features=30-day%20returns&features=Free%20shipping&key=sk_test123&template=blog&title=Hello%20World
signature = a79232b15b45002aee76174f542e0a661b37cb1259df01e263c952ca4052a54d

Uma implementação está correta se e somente se produzir esse canónico e essa assinatura para essas entradas — e um parâmetro/chave diferente deve alterar a assinatura. O vetor dourado é gerado pelo próprio servidor FastOG, pelo que é a verdade de referência.

Implementações de referência (sem SDK / qualquer linguagem)

JavaScript (Node.js, CommonJS)

const crypto = require("crypto");

const enc = (s) =>
    encodeURIComponent(String(s)).replace(
        /[!'()*]/g,
        (c) => "%" + c.charCodeAt(0).toString(16).toUpperCase(),
    );

function canonicalize(params, apiKey) {
    const all = { ...params, key: apiKey };
    const pairs = [];
    for (const [k, v] of Object.entries(all)) {
        for (const vv of Array.isArray(v) ? [...v].sort() : [v]) {
            pairs.push(`${enc(k)}=${enc(vv)}`);
        }
    }
    return pairs.sort().join("&");
}

function sign(params, apiKey, secret) {
    return crypto
        .createHmac("sha256", secret)
        .update(`GET/api/v1/og\n${canonicalize(params, apiKey)}`)
        .digest("hex");
}

function signedUrl(
    params,
    apiKey,
    secret,
    baseUrl = "https://fastog.com/api/v1/og",
) {
    const url = new URL(baseUrl);
    for (const [k, v] of Object.entries({ ...params, key: apiKey })) {
        const isArray = Array.isArray(v);
        for (const vv of isArray ? v : [v]) {
            url.searchParams.append(isArray ? `${k}[]` : k, vv);
        }
    }
    url.searchParams.set("s", sign(params, apiKey, secret));
    return url.toString();
}

module.exports = { signedUrl, sign, canonicalize };

PHP

php

function fastog_canonicalize(array $params, string $apiKey): string
{
    $pairs = [];
    foreach (array_merge($params, ['key' => $apiKey]) 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);
    return implode('&', $pairs);
}

function fastog_sign(array $params, string $apiKey, string $secret): string
{
    return hash_hmac('sha256', 'GET/api/v1/og' . "\n" . fastog_canonicalize($params, $apiKey), $secret);
}

function fastog_signed_url(array $params, string $apiKey, string $secret, string $baseUrl = 'https://fastog.com/api/v1/og'): string
{
    $all = array_merge($params, ['key' => $apiKey, 's' => fastog_sign($params, $apiKey, $secret)]);
    return $baseUrl . '?' . http_build_query($all, '', '&', PHP_QUERY_RFC3986);
}

Python

python

import hashlib, hmac
from urllib.parse import quote

_enc = lambda s: quote(str(s), safe="-._~")

def canonicalize(params, api_key):
    pairs = []
    for k, v in {**params, "key": api_key}.items():
        for vv in sorted(v) if isinstance(v, list) else [v]:
            pairs.append(f"{_enc(k)}={_enc(vv)}")
    return "&".join(sorted(pairs))

def sign(params, api_key, secret):
    return hmac.new(secret.encode(), f"GET/api/v1/og\n{canonicalize(params, api_key)}".encode(), hashlib.sha256).hexdigest()

def signed_url(params, api_key, secret, base_url="https://fastog.com/api/v1/og"):
    all_p = {**params, "key": api_key, "s": sign(params, api_key, secret)}
    pairs = []
    for k, v in all_p.items():
        if isinstance(v, list):
            for i, vv in enumerate(v):
                pairs.append(f"{_enc(f'{k}[{i}]')}={_enc(vv)}")
        else:
            pairs.append(f"{_enc(k)}={_enc(v)}")
    return f"{base_url}?{'&'.join(pairs)}"

Ruby

ruby

require "openssl"

def enc(s)
  s.to_s.gsub(/[^A-Za-z0-9\-._~]/) { |c| c.bytes.map { |b| "%%%02X" % b }.join }
end

def canonicalize(params, api_key)
  pairs = params.merge("key" => api_key).flat_map do |k, v|
    values = v.is_a?(Array) ? v.sort : [v]
    values.map { |vv| "#{enc(k)}=#{enc(vv)}" }
  end
  pairs.sort.join("&")
end

def sign(params, api_key, secret)
  OpenSSL::HMAC.hexdigest("SHA256", secret, "GET/api/v1/og\n#{canonicalize(params, api_key)}")
end

def signed_url(params, api_key, secret, base_url = "https://fastog.com/api/v1/og")
  all = params.merge("key" => api_key, "s" => sign(params, api_key, secret))
  pairs = all.flat_map do |k, v|
    if v.is_a?(Array)
      v.each_with_index.map { |vv, i| "#{enc("#{k}[#{i}]")}=#{enc(vv)}" }
    else
      ["#{enc(k)}=#{enc(v)}"]
    end
  end
  "#{base_url}?#{pairs.join("&")}"
end

Go

import (
	"crypto/hmac"
	"crypto/sha256"
	"encoding/hex"
	"fmt"
	"sort"
	"strings"
)

func enc(s string) string {
	const hex = "0123456789ABCDEF"
	var b strings.Builder
	for i := 0; i < len(s); i++ {
		c := s[i]
		if (c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z') || (c >= '0' && c <= '9') || c == '-' || c == '.' || c == '_' || c == '~' {
			b.WriteByte(c)
		} else {
			b.WriteByte('%')
			b.WriteByte(hex[c>>4])
			b.WriteByte(hex[c&0x0f])
		}
	}
	return b.String()
}

func canonicalize(params map[string]any, apiKey string) string {
	all := map[string]any{}
	for k, v := range params {
		all[k] = v
	}
	all["key"] = apiKey
	keys := make([]string, 0, len(all))
	for k := range all {
		keys = append(keys, k)
	}
	sort.Strings(keys)
	var pairs []string
	for _, k := range keys {
		vals := []string{fmt.Sprint(all[k])}
		if arr, ok := all[k].([]string); ok {
			vals = arr
			sort.Strings(vals)
		}
		for _, v := range vals {
			pairs = append(pairs, enc(k)+"="+enc(v))
		}
	}
	sort.Strings(pairs)
	return strings.Join(pairs, "&")
}

func sign(params map[string]any, apiKey, secret string) string {
	mac := hmac.New(sha256.New, []byte(secret))
	mac.Write([]byte("GET/api/v1/og\n" + canonicalize(params, apiKey)))
	return hex.EncodeToString(mac.Sum(nil))
}

func signedURL(params map[string]any, apiKey, secret, baseURL string) string {
	all := map[string]any{}
	for k, v := range params {
		all[k] = v
	}
	all["key"] = apiKey
	all["s"] = sign(params, apiKey, secret)
	keys := make([]string, 0, len(all))
	for k := range all {
		keys = append(keys, k)
	}
	sort.Strings(keys)
	var pairs []string
	for _, k := range keys {
		if arr, ok := all[k].([]string); ok {
			for i, v := range arr {
				pairs = append(pairs, enc(k+"["+fmt.Sprint(i)+"]")+"="+enc(v))
			}
		} else {
			pairs = append(pairs, enc(k)+"="+enc(fmt.Sprint(all[k])))
		}
	}
	return baseURL + "?" + strings.Join(pairs, "&")
}

Depuração de erros 401

Código	Significado	Correção
`missing_signature`	URL sem `key` ou `s`	regenere com uma função de assinatura (signer); verifique se ambos os parâmetros estão presentes
`invalid_signature`	incompatibilidade canónica ou segredo errado	volte a assinar após QUALQUER alteração de conteúdo; confirme o mesmo `hmac_secret` em ambos os lados; verifique se o espaço é `%20` (não `+`); verifique se os arrays usam chaves entre parênteses retos na URL; confirme que `key` está no canónico

Descarregar a competência de IA do FastOG

Entregue toda a competência de integração ao Claude, Codex, Cursor ou qualquer agente — sem necessidade de navegar nesta página.

Descarregar competência de IA Ficheiro combinado (MD)

curl -O https://fastog.com/skill/SKILL.md
curl -O https://fastog.com/skill/implementations.md

Experimente gratuitamente — sem necessidade de registo

Pré-visualize e teste imagens OG dinâmicas em segundos.

Abrir o Testador Gratuito de Imagens OG