Intégrer un widget
-
Chargez le SDK une fois par page, de préférence juste avant
</body>:<script src="https://delivery.idalgo.live/sdk/v1.js" async></script>Le script ne dépend d’aucune bibliothèque et se charge en asynchrone. Son URL est figée sur la version 1 du SDK : une évolution qui vous demanderait de changer votre intégration sortira sous une autre URL (voir Version du SDK).
Si iDalgo vous a remis une clé publique, ajoutez-la sur cette balise :
data-idalgo-key="idl_pk_…"(voir Votre clé). -
Placez un widget là où il doit apparaître :
<div data-idalgo-component="RankingTable" data-idalgo-param-season="374703"></div>data-idalgo-componentchoisit le widget, chaquedata-idalgo-param-*lui passe un paramètre. La galerie liste les widgets et leurs paramètres. -
C’est tout. Au chargement de la page, le SDK trouve les balises, récupère le HTML rendu par iDalgo et l’insère.
Attributs communs
Section intitulée « Attributs communs »| Attribut | Obligatoire | Rôle |
|---|---|---|
data-idalgo-component |
Oui | Nom du widget |
data-idalgo-param-* |
Selon le widget | Paramètres du widget |
data-idalgo-client |
Non | Votre identifiant : thème, direct, réglages par défaut (voir Identifiant client) |
data-idalgo-lazy |
Non | true (défaut) : chargement à l’approche du widget dans l’écran |
data-idalgo-seo |
Non | true (défaut) : ajoute le JSON-LD du widget dans la page |
data-idalgo-link-* |
Non | Gabarit de lien vers vos pages : person, team, contest, results ou standings (/joueurs/{id}, voir Liens) |
Mode sombre et langue
Section intitulée « Mode sombre et langue »Un widget s’affiche en clair par défaut. data-idalgo-param-mode le passe en sombre (dark) ou
lui fait suivre le réglage clair ou sombre de l’appareil du lecteur (auto) :
<div data-idalgo-component="MatchSheet" data-idalgo-param-contest="54732603" data-idalgo-param-mode="auto"></div>Votre thème peut aussi fixer le mode de tous vos widgets ; le paramètre d’une balise l’emporte.
L’interface des widgets est en français : onglets, libellés, statuts (« Terminé », « EN DIRECT »),
dates, textes destinés aux lecteurs d’écran et messages d’erreur du SDK. lang traduit les données
seulement : noms des équipes, des joueurs, des compétitions.
Plusieurs widgets
Section intitulée « Plusieurs widgets »Chaque balise est indépendante : ajoutez-en autant que nécessaire, un seul script suffit.
<div data-idalgo-component="RankingTable" data-idalgo-param-season="374703"></div><div data-idalgo-component="MatchList" data-idalgo-param-season="374703"></div>
<script src="https://delivery.idalgo.live/sdk/v1.js" async></script>Trouver l’identifiant d’une saison
Section intitulée « Trouver l’identifiant d’une saison »Les widgets prennent des identifiants de l’API. La saison en cours d’une compétition est
currentSeason.id dans GET /v1/competitions :
curl "$IDALGO_API/v1/competitions?sport=102"Pour piloter les widgets en JavaScript (rendu à la demande, navigation SPA, événements), voir le SDK JavaScript.
Sans le SDK
Section intitulée « Sans le SDK »Votre serveur peut aussi récupérer le HTML d’un widget et l’insérer lui-même dans la page qu’il génère : voir Intégration côté serveur.