L'API HTTP RESTful de FreeboxOS

L'interface de contrôle de FreeboxOS est déclarée en mulsticast via le protocole DNS-SD sous le nom de service _fbx-api._tcp, ce qui permet aux applications sur smartphones ou tablettes de découvrir la présence du service lorsqu'ils sont connectés en wifi au boitier Server.

Une autre manière, simple mais non fiable, de reconnaître la présence de FreeboxOS est de faire une requète HTTP sur http://mafreebox.freebox.fr/api_version afin de savoir si FreeboxOS répond. Attention, FreeboxOS n'est disponible que sur Freebox Révolution, il faut donc gérer les cas d'erreur (404 not found, request timeout...) lors d'un accès à des Freebox plus anciennes telles que la Freebox Crystal.

L'API RESTful de FreeboxOS est dotée d'un système d'authentification et d'acquisition de droits nécessitant une phase d'association pendant laquelle l'utilisateur va autoriser l'application à prendre la main et cela sans entrer le mot de passe de FreeboxOS. Ces droits sont révoquables ou modifiables dans l'interface web de FreeboxOS sur http://mafreebox.freebox.fr.

Une application pour smartphone, Freebox Compagnon, a été implémentée et utilise exclusivement l'API RESTful de FreeboxOS. Vous pouvez télécharger cette application sur le Google Play Store ou sur Apple iTunes (code source non disponible).

Pour plus de détail, consulter la documentation complète de l'API FreeboxOS.