Module PowerShell pour l’API OVH

Introduction

Envoyer un SMS ou interroger un service OVH depuis un script PowerShell, c'est pratique pour des alertes, des notifications ou de l'automatisation. C'est pour cela que j'ai développé BSAOvhApi, un module PowerShell publié sur la PowerShell Gallery, qui simplifie ces appels à l'API OVH.

Que propose BSAOvhApi ?

Le module regroupe quelques fonctions pour interagir avec l'API OVH :

• Send-BSAOvhSms : envoie un SMS via l'API OVH.
• Invoke-BSAOvhApi : fonction générique pour appeler les autres services de l'API OVH, si la fonction dont vous avez besoin n'existe pas encore.

Le projet est open source (licence MIT). Vous pouvez aussi ajouter vos propres fonctions et les proposer sur le dépôt GitHub : les contributions sont les bienvenues.

Prérequis

• Windows 7+ / Windows Server 2003+
• PowerShell v3 minimum
• Un compte OVH avec accès à l'API : il faut créer une Application Key, un Application Secret et récupérer votre Consumer Key. La documentation OVH détaille la marche à suivre.

Installation

Le module s'installe depuis la PowerShell Gallery :

Install-Module -Name BSAOvhApi

Exemple : envoyer un SMS

Send-BSAOvhSms -ApplicationKey 'your_application_key' `
    -ApplicationSecret 'your_application_secret' `
    -ConsumerKey 'your_consumer_key' `
    -From 'My Company' `
    -To '+33612345678' `
    -Message 'Hello World'

Remplacez les clés par les vôtres, l'expéditeur par votre nom d'émetteur et le destinataire par un numéro au format international.

Ne stockez pas vos clés en clair dans vos scripts ou votre dépôt Git : privilégiez des variables d'environnement ou un coffre de secrets.

Aller plus loin

Pour un service OVH qui n'a pas de fonction dédiée, Invoke-BSAOvhApi permet d'appeler directement l'API. La console de l'API OVH liste tous les endpoints disponibles.

Conclusion

BSAOvhApi évite d'écrire soi-même la signature et les appels HTTP de l'API OVH : une installation en une commande, et l'envoi de SMS devient un simple appel de fonction. Si le service dont vous avez besoin n'est pas couvert, la fonction générique ou une contribution au dépôt font le reste.

---

Lien vers GitHub