主题

Agent 与 LLM 集成 — FastOG

一份完整、自包含的指南,用于从任何服务端语言集成 FastOG — 面向人类开发者和 AI 编码代理编写。整个客户端接口就是一个函数:signedUrl(params, key, secret) → 一个可直接嵌入的 <meta property="og:image"> URL。

下载技能

将整个技能随身携带——将两个文件放入你的 agents/skills/fastog-integration/ 目录,即可在 Claude Code、Codex 或任何代理中加载:

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

更喜欢合并为一个文件?本页面就是该技能(合同 + 内联实现):curl -O https://fastog.com/docs-files/agent-integration.md

合约(唯一的一份)

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

不变量(违反任何一条 → 401)

  1. RFC-3986 编码 — 除 A-Za-z0-9-._~ 外,所有内容均需百分号编码;空格 → %20,绝不用 +。PHP 使用 rawurlencode;JS 使用 encodeURIComponent 并重新编码 !'()*;Python 使用 quote(safe='-._~');Ruby/Go 使用自定义字节编码器。
  2. key 需要签名 — 它是规范查询的一部分,因此签名与密钥绑定。
  3. 数组在 URL 中需要带括号的键 — 使用普通键(features=…&features=…)对规范字符串签名,但 URL 必须使用 features[0]=… 或 features[]=…。后端是 PHP:重复的无括号键(features=a&features=b)会解码为标量(后者覆盖前者)→ 规范字符串不匹配 → 401。
  4. 无时间戳 — 基于内容寻址。相同参数 → 相同 URL → 可永久缓存;任何变更 → 401 → 不渲染、不消耗配额。

保留参数:s(签名 — 从规范字符串中排除)、key(包含在内)、t(保留 — 切勿使用)。

安全性(不可妥协)

  • hmac_secret 是私密的 — 仅限服务端使用。绝不可出现在浏览器中,绝不可出现在公共 CDN 脚本中。客户端/浏览器端签名永远无法生效。
  • key 是公开的(它出现在每个 URL 中)— 这是预期且安全的,因为伪造需要私钥。
  • 仅支持 GET(爬虫从不发送 POST)。在请求时于服务端签名;你嵌入的是签名后的 URL。

示例演示

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

单文件签名器(零依赖,无需包管理器)

目前还没有 npm i/pip install 包——这些是单文件签名器:每个签名器以单个文件下载,仅生成签名的 OG 图片 URL(包含全部 HMAC 和 RFC-3986 逻辑,无运行时)。请在客户端的服务器上下载并签名:

语言/框架 文件 一行命令
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)

嵌入结果:

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

黄金向量(自行验证任何实现)

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

一个实现是正确的,当且仅当它对给定输入生成该规范值和该签名——并且不同的参数或密钥必须改变签名。黄金向量由 FastOG 服务器本身生成,因此它是基准真相。

参考实现(无需 SDK / 任意语言)

JavaScript(Node.js,CommonJS)

js
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

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, "&")
}

调试 401

代码 含义 修复方法
missing_signature URL 缺少 key 或 s 使用签名器重新生成;确认两个参数均存在
invalid_signature 规范不匹配或密钥错误 任何内容变更后请重新签名;确认两侧使用相同的 hmac_secret;检查空间是否为 %20(而非 +);检查数组在 URL 中是否使用方括号键;确认 key 位于规范中

免费试用——无需注册

在几秒钟内预览和测试动态 OG 图片。

打开免费的 OG 图片测试器

A BeCaSimulations site