Aller au contenu principal

Documentation

Endpoint oEmbed

Transformez un lien Bursae collé dans un CMS (WordPress, Ghost, Notion…) en carte riche automatiquement.

Endpoint

GET https://bursae.fr/api/oembed?url=URL&format=json

Conforme à la spécification oEmbed 1.0 (nouvelle fenêtre). CORS activé pour les appels depuis des domaines tiers.

Paramètres

Paramètres du endpoint oEmbed
ParamètreRequisDescription
urlouiURL de la page Bursae à intégrer (pages /collectivite/{slug})
formatnonjson (défaut) ou xml

URLs supportées

URLs supportées par le endpoint
TypeSchéma
Fiche collectivitéhttps://bursae.fr/collectivite/{slug}

Exemple

Requête cURL
curl "https://bursae.fr/api/oembed?url=https%3A%2F%2Fbursae.fr%2Fcollectivite%2Fbordeaux&format=json"
Réponse JSON
{
  "type": "rich",
  "version": "1.0",
  "title": "Bordeaux — Finances communales | Bursae",
  "author_name": "Bordeaux",
  "provider_name": "Bursae",
  "provider_url": "https://bursae.fr",
  "html": "<iframe src=\"https://bursae.fr/collectivite/bordeaux\" width=\"600\" height=\"400\" frameborder=\"0\" allowfullscreen></iframe>",
  "width": 600,
  "height": 400,
  "thumbnail_url": null,
  "thumbnail_width": null,
  "thumbnail_height": null
}

Auto-découverte

Chaque page collectivité inclut une balise <link> dans le <head> pour la découverte automatique par les CMS compatibles :

<link
  rel="alternate"
  type="application/json+oembed"
  href="https://bursae.fr/api/oembed?url=https%3A%2F%2Fbursae.fr%2Fcollectivite%2Fbordeaux&format=json"
  title="Bordeaux — Finances communales | Bursae"
/>

Codes HTTP

Codes de réponse HTTP
CodeDescription
200Réponse oEmbed valide
400Paramètre url manquant
404URL non reconnue ou commune introuvable
501Format non supporté

CORS

L'endpoint renvoie l'en-tête Access-Control-Allow-Origin: * pour permettre les appels depuis n'importe quel domaine.