Referência da API de imagens OG

A referência da API de imagens OG abrange o endpoint, os parâmetros e o catálogo de templates para gerar imagens Open Graph dinâmicas com o FastOG. A API está sujeita a subscrição — é necessário um plano Dynamic API ativo, mas as renderizações em si não são contabilizadas: não existe quota mensal de renderizações nem faturação de excedentes. Os URLs assinados com HMAC mantêm cada pedido seguro. Registe-se, escolha um plano Dynamic API e, em seguida, crie a sua chave de API e o segredo HMAC no dashboard; as renderizações pagas da API são limpas. O contrato OpenAPI gerado é a lista autoritativa legível por máquina de parâmetros, códigos de erro e slugs de templates.

URL base

https://fastog.com/api/v1/og

Autenticação

Todos os pedidos requerem autenticação por assinatura HMAC-SHA256. A key pública e a assinatura s são parâmetros de query; a autenticação baseada em cabeçalhos não é atualmente suportada. Consulte a Documentação HMAC para mais detalhes.

Endpoint

GET /api/v1/og

Gera uma imagem Open Graph dinâmica com base nos parâmetros fornecidos.

Parâmetros de consulta

Parâmetros específicos do template

Todos os templates aceitam os parâmetros partilhados abaixo mais os seus parâmetros específicos (ver a tabela de índice). O parâmetro de consulta template seleciona o layout utilizado (predefinição: default).

Parâmetros partilhados (todos os templates)

Índice de templates — 67 slugs renderizáveis, 48 selecionáveis. A tabela abaixo documenta os estilos mais usados e as props específicas de cada template; a lista exaustiva e gerada (label, categoria, flag de retirada e todos os slugs aceites) está em /openapi.json em x-template-catalogue, e os campos do editor de cada template (key, label, type, default, options e formato de URL) estão em x-template-fields. Os slugs retirados continuam renderizáveis para que os URLs já em circulação continuem a funcionar, mas não são oferecidos pelos seletores.

glassproduct também aceita cta. Os templates ecommerce, product, glassproduct e imageright mostram "Shop now" por predefinição; defina cta com um valor vazio para ocultar a pill visual.

Tipos de parâmetros estruturados

Resposta

• 200 OK — Devolve dados de imagem PNG
• 401 Unauthorized — Autenticação inválida ou em falta
• 422 Unprocessable — Parâmetros de template inválidos

Respostas de erro

Pedido de exemplo

GET /api/v1/og?template=blog&title=Hello%20World&subtitle=A%20test%20post&key=sk_quick_123abc&s=a1b2c3...

Exemplo cURL

curl "https://fastog.com/api/v1/og?template=blog&title=Hello%20World&key=sk_quick_123abc&s=<signature>"

Preços e limites

O FastOG está condicionado a subscrição: é necessário um plano Dynamic API ativo. Os renders não são medidos — não existe quota mensal de renders nem faturação de excedentes. O plano é a condição de acesso e todos os níveis renderizam sem contador. Consulta Preços para os níveis e preços atuais.

As imagens em cache são gratuitas: os pedidos servidos a partir da cache de edge da Cloudflare (mesmo template + parâmetros, independentemente da assinatura s num URL previamente em cache) nunca chegam à origem, pelo que um URL idêntico não consome outro render.

Limpo por predefinição: todos os renders são limpos — sem marca de água em nenhum plano, e nenhuma no OG Image Tester gratuito, nas pré-visualizações do Studio ou nas exportações do Studio. Uma prop de render fastog_watermark continua a ser suportada para os chamadores que pedem explicitamente um selo "Made with FastOG", mas nada a define automaticamente.

Relacionado

• Documentação — Todos os guias e referências do FastOG
• Testador de imagens OG gratuito — Pré-visualize sem uma conta
• Guia de início rápido — inclui o fluxo da arquitetura (assinar no momento da renderização)
• Guia de assinatura HMAC
• Validação HMAC
• Tutorial de JavaScript