Referencia de la API de imágenes OG

La referencia de la API de imágenes OG cubre el endpoint, los parámetros y el catálogo de plantillas para generar imágenes Open Graph dinámicas con FastOG. La API está supeditada a una suscripción: se requiere un plan Dynamic API activo, pero los propios renders no se facturan por uso: no hay cuota mensual de renders ni facturación por exceso. Las URL firmadas con HMAC mantienen segura cada solicitud. Regístrate, elige un plan Dynamic API y luego crea tu clave de API y tu secreto HMAC en el panel; los renders de pago de la API son limpios. El contrato OpenAPI generado es la lista autoritativa legible por máquina de parámetros, códigos de error y slugs de plantillas.

URL base

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

Autenticación

Todas las solicitudes requieren autenticación mediante firma HMAC-SHA256. La key pública y la firma s son parámetros de consulta; actualmente no se admite la autenticación basada en cabeceras. Consulta la documentación de HMAC para más detalles.

Endpoint

GET /api/v1/og

Genera una imagen OG dinámica a partir de los parámetros proporcionados.

Parámetros de consulta

Parámetros específicos de cada plantilla

Todas las plantillas aceptan los parámetros compartidos que se indican a continuación además de sus parámetros específicos (consulta la tabla de índice). El parámetro de consulta template selecciona el diseño que se usa (por defecto: default).

Parámetros compartidos (todas las plantillas)

Índice de plantillas — 67 slugs renderizables, 48 seleccionables. La tabla siguiente documenta los estilos más usados y sus props específicas de plantilla; la lista exhaustiva y generada (etiqueta, categoría, indicador de retirada y todos los slugs aceptados) está en /openapi.json bajo x-template-catalogue, y los campos del editor de cada plantilla (clave, etiqueta, tipo, valor por defecto, opciones y formato de URL) están bajo x-template-fields. Los slugs retirados siguen siendo renderizables para que las URLs que ya están en circulación sigan funcionando, pero los selectores no los ofrecen.

glassproduct también acepta cta. Las plantillas ecommerce, product, glassproduct y imageright muestran «Shop now» por defecto; asigna un valor vacío a cta para ocultar la píldora visual.

Tipos de parámetros estructurados

Respuesta

• 200 OK — Devuelve datos de imagen PNG
• 401 Unauthorized — Autenticación no válida o ausente
• 422 Unprocessable — Parámetros de plantilla no válidos

Respuestas de error

Ejemplo de solicitud

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

Ejemplo de cURL

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

Precios y límites

FastOG está restringido por suscripción: se requiere un plan activo de Dynamic API. Las renderizaciones no se facturan por uso: no hay cuota mensual de renderizaciones ni facturación por exceso. El plan es el requisito, y todos los niveles renderizan sin contador. Consulta Precios para ver los niveles y precios actuales.

Las imágenes en caché son gratuitas: las solicitudes servidas desde la caché perimetral de Cloudflare (misma plantilla + parámetros, independientemente de la firma s en una URL previamente cacheada) nunca llegan al origen, por lo que una URL idéntica no consume otra renderización.

Limpio por defecto: cada renderización es limpia: sin marca de agua en ningún plan, y tampoco en el probador gratuito de imágenes OG, las vistas previas de Studio ni las exportaciones de Studio. Todavía se admite una prop de renderización fastog_watermark para quienes soliciten explícitamente una insignia "Made with FastOG", pero nada la activa automáticamente.

Relacionado

• Documentación — Todas las guías y referencias de FastOG
• Probador de imágenes OG gratuito — Previsualiza sin una cuenta
• Guía de inicio rápido — incluye el flujo de arquitectura (firma en el momento del renderizado)
• Guía de firmas HMAC
• Validación HMAC
• Tutorial de JavaScript