Agent- & LLM-integration — FastOG
En komplet, selvstændig guide til at integrere FastOG fra ethvert server-side sprog — skrevet til både menneskelige udviklere og AI-kodningsagenter. Hele klientfladen er én funktion: signedUrl(params, key, secret) → en klar-til-indlejring <meta property="og:image">-URL.
Download færdigheden
Tag hele færdigheden med dig — læg begge filer i din agents/skills/fastog-integration/-mappe for at indlæse den i Claude Code, Codex eller en hvilken som helst agent:
SKILL.md—curl -O https://fastog.com/skill/SKILL.mdimplementations.md—curl -O https://fastog.com/skill/implementations.md
Foretrækker du én kombineret fil? Denne side er færdigheden (kontrakt + implementeringer inline): curl -O https://fastog.com/docs-files/agent-integration.md
Kontrakten (den eneste)
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))
Invariante regler (brud på nogen → 401)
- RFC-3986-kodning — procentkod alt undtagen
A-Za-z0-9-._~; mellemrum →%20, aldrig+. PHPrawurlencode; JSencodeURIComponent+ genkod!'()*; Pythonquote(safe='-._~'); Ruby/Go bruger tilpasset byte-koder. keyer signeret — den er en del af den kanoniske query, så signaturen er bundet til nøglen.- Arrays kræver bracket-nøgler i URL'en — signer den kanoniske med den almindelige nøgle (
features=…&features=…), men URL'en skal brugefeatures[0]=…ellerfeatures[]=…. Backend'en er PHP: gentagne nøgler uden brackets (features=a&features=b) afkodes til en skalar (sidste vinder) → kanonisk mismatch → 401. - Ingen tidsstempel — content-adresseret. Identiske parametre → identisk URL → kan cachelagres for evigt; enhver ændring → 401 → ingen rendering, intet kvoteforbrug.
Reserverede parametre: s (signatur — udelukket fra den kanoniske), key (inkluderet), t (reserveret — brug aldrig).
Sikkerhed (ikke til forhandling)
hmac_secreter privat — kun server-side. Aldrig i en browser, aldrig i et offentligt CDN-script. Signering på klienten/i browseren kan aldrig fungere.keyer offentlig (den optræder i hver URL) — forventet og sikkert, fordi forfalskning kræver hemmeligheden.- Kun GET (crawlere POST'er aldrig). Signér på serveren ved anmodningstidspunktet; den signerede URL er det, du indlejrer.
Gennemarbejdet eksempel
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
Enkeltfil-signeringsmoduler (nul afhængigheder, ingen pakkehåndtering)
Der findes endnu ingen npm i/pip install-pakke — disse er enkeltfil-signeringsmoduler: hver downloades som én fil og producerer kun den signerede OG-billed-URL (al HMAC- og RFC-3986-logik, ingen runtime). Download og signér på klientens server:
| Sprog/Framework | Fil | 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) |
Indlejr resultatet:
<meta property="og:image" content="https://fastog.com/api/v1/og?…&key=…&s=…" />
Golden vector (selv-verificér ENHVER implementering)
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
En implementering er korrekt hvis og kun hvis den producerer den kanoniske værdi og den signatur for disse input — og en anden parameter/nøgle skal ændre signaturen. Golden vector er genereret af FastOG-serveren selv, så den er den ultimative sandhed.
Referenceimplementeringer (uden SDK / ethvert sprog)
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
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
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
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, "&")
}
Fejlfinding af 401
| Kode | Betydning | Løsning |
|---|---|---|
missing_signature |
URL mangler key eller s |
Generér igen med en underskriver (signer); bekræft, at begge parametre er til stede |
invalid_signature |
Kanonisk uoverensstemmelse eller forkert hemmelighed | Underskriv igen efter ENHVER indholdsændring; bekræft den samme hmac_secret på begge sider; kontrollér, at mellemrummet er %20 (ikke +); kontrollér, at arrays bruger nøgler i kantede parenteser i URL'en; bekræft, at key er i den kanoniske værdi |