Référence de l'API OG image

La référence de l'API OG image couvre le point de terminaison, les paramètres et le catalogue de modèles pour générer des images Open Graph dynamiques avec FastOG. L'API est soumise à un abonnement — un plan Dynamic API actif est requis, mais les rendus eux-mêmes ne sont pas comptés : il n'y a ni quota mensuel de rendus ni facturation au dépassement. Les URL signées HMAC (signer) sécurisent chaque requête. Inscrivez-vous, choisissez un plan Dynamic API, puis créez votre clé API et votre secret HMAC dans le dashboard ; les rendus API payants sont sans surprise. Le contrat OpenAPI généré constitue la liste faisant autorité, lisible par machine, des paramètres, des codes d'erreur et des slugs de modèles.

URL de base

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

Authentification

Toutes les requêtes nécessitent une authentification par signature HMAC-SHA256. La clé publique key et la signature s sont des paramètres de requête ; l'authentification par en-tête n'est pas prise en charge actuellement. Consultez la documentation HMAC pour plus de détails.

Endpoint

GET /api/v1/og

Génère une image Open Graph dynamique à partir des paramètres fournis.

Paramètres de requête

Paramètres spécifiques aux modèles

Chaque modèle accepte les paramètres communs ci-dessous ainsi que ses paramètres spécifiques (voir le tableau d'index). Le paramètre de requête template détermine la mise en page utilisée (par défaut : default).

Paramètres communs (tous les modèles)

Index des modèles — 67 slugs rendables, 48 sélectionnables. Le tableau ci-dessous documente les apparences les plus utilisées et leurs props spécifiques au modèle ; la liste exhaustive générée (libellé, catégorie, indicateur de retrait et chaque slug accepté) se trouve dans /openapi.json sous x-template-catalogue, et les champs d'éditeur de chaque modèle (clé, libellé, type, valeur par défaut, options et format d'URL) se trouvent sous x-template-fields. Les slugs retirés restent rendables afin que les URL déjà en circulation continuent de fonctionner, mais ils ne sont pas proposés par les sélecteurs.

glassproduct accepte également cta. Les modèles ecommerce, product, glassproduct et imageright affichent « Shop now » par défaut ; définissez cta sur une valeur vide pour masquer la pastille visuelle.

Types de paramètres structurés

Réponse

• 200 OK — Renvoie les données de l'image PNG
• 401 Unauthorized — Authentification invalide ou manquante
• 422 Unprocessable — Paramètres de modèle invalides

Réponses d'erreur

Exemple de requête

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

Exemple cURL

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

Tarification et limites

FastOG est soumis à un abonnement : un plan Dynamic API actif est requis. Les rendus ne sont pas comptabilisés — il n'y a pas de quota mensuel de rendus ni de facturation au dépassement. Le plan est le seul prérequis, et chaque niveau effectue des rendus sans compteur. Consultez Tarification pour les niveaux et prix actuels.

Les images en cache sont gratuites : les requêtes servies depuis le cache edge de Cloudflare (même modèle + mêmes paramètres, quelle que soit la signature s sur une URL précédemment mise en cache) n'atteignent jamais l'origine, donc une URL identique ne consomme pas un nouveau rendu.

Propre par défaut : chaque rendu est propre — aucun filigrane sur quelque plan que ce soit, et aucun non plus sur le testeur d'OG image gratuit, les aperçus Studio ou les exports Studio. Une prop de rendu fastog_watermark reste prise en charge pour les appelants qui demandent explicitement un badge « Made with FastOG », mais rien ne l'active automatiquement.

Voir aussi

• Documentation — Tous les guides et références FastOG
• Testeur d'images OG gratuit — Prévisualisez sans compte
• Guide de démarrage rapide — inclut le flux d'architecture (signature au moment du rendu)
• Guide de signature HMAC
• Validation HMAC
• Tutoriel JavaScript