SDK ET API

Vous trouverez sur cette page des informations techniques vous permettant de participer la transparence de la chaîne d’approvisionnement des logiciels.

Comment transférer les informations pour votre indicateur ?

Étape 1 : Récupérez le SBOM correspondant à la version de votre logiciel au format CycloneDX json. Nous avons préparé des instructions détaillées pour chaque environnement.

Etape 2 : Postez le SBOM de votre version logicielle. Utilisez le modèle suivant, en remplaçant toutes les parties en gris par vos informations personnelles :

curl --request PUT 'https://software-health-indicator.com/api/applications/your-application-id/versions' \
     --header 'ApiKey: your-secret-token' \
     --form 'versionName="your-version-name"' \
     --form 'description="Some description of the changes associated with the version"' \
     --form 'sbom=@"/path/to/the/sbom"'

Conseil : Incluez une fois ces étapes dans votre pipeline d’automatisation de déploiement.

Comment inclure l’indicateur sur votre site web ?

Étape 1 : Placez ce script sur votre page une fois. Idéalement juste avant la balise </body>.

<script src="https://software-health-indicator.com/indicators/get-indicator.js" async defer crossorigin="anonymous"></script>

Étape 2 : Placez ce code html à l’endroit où vous voulez que l’indicateur apparaisse sur votre page, en remplaçant toutes les parties en gris

<div class="software-health-indicator" data-software="your-application-id" data-version="your-version-name"><a href="https://software-health-indicator.com" style="display: none;"></a></div>

Astuce : Le choix d’une version spécifique peut être utile sur une page d’historique des versions de votre site web. Partout ailleurs, vous n’utiliserez probablement que la dernière version. Pour obtenir automatiquement la dernière version, remplacez simplement your-version-name par une chaîne vide.

Comment inclure votre indicateur dans du markdown sur GitHub ?

Placez ce qui suit dans votre markdown, en remplaçant toutes les parties en gris

[<img src="https://software-health-indicator.com/indicators/your-application-id/latest?" alt="Software health indicator" title="Open detail" height="140px"/>](https://software-health-indicator.com/?applicationId=your-application-id)

Conseil : Github fait une mise en cache importante des images en dehors de notre contrôle. Vous pouvez ajouter une chaîne aléatoire après latest? (par exemple : latest?nonce=20230323) pour forcer le rafraîchissement de l’image.

Nous sommes là pour vous aider. Contactez-nous pour toute question.