Free publie la documentation de l'API de Freebox OS

Free publie la documentation de l’API de Freebox OS

Let's code !

Avatar de l'auteur
David Legrand

Publié dans

Logiciel

27/06/2013 2 minutes
28

Free publie la documentation de l'API de Freebox OS

Lors du lancement de Freebox OS, Free a annoncé que des applications tierces pourront interagir avec sa nouvelle interface via une API. Un point qui manquait énormément avec la version précédente, la question de la sécurité des comptes pouvant être mise en question. Disponible au sein de l'interface utilisateur, cette documentation est aussi accessible en ligne.

L'une des plus grandes nouveautés de Freebox OS est sans aucun doute l'API permettant à des développeurs de créer des applications qui pourront simplement interagir avec la Freebox Révolution. Une manière d'ouvrir à de nouveaux usages en comptant sur la communauté, ce qui peut produire d'assez bons résultats.

 

La documentation de cette API est disponible au sein de l'interface utilisateur, via la section d'aide, mais ceux qui n'ont pas de Freebox sous la main pourront aussi la consulter en ligne en se rendant par ici. 

 

Freebox OS API

 

L'ensemble est assez complet puisqu'il est déjà question de gérer les téléchargements, les partages AirMedia, les appels, les contacts, le stockage, la configuration, le contrôle parental... Il ne reste maintenant plus qu'à attendre que les développeurs s'en emparent et mettent en ligne leurs premiers essais. Si jamais c'est votre cas, n'hésitez pas à nous le faire savoir ;)

Écrit par David Legrand

Tiens, en parlant de ça :

Sommaire de l'article

Introduction

Fermer

Commentaires (28)


sympa, ce seront d’office des webapps html5/javascript? ou peut-on utiliser d’autres langages de prog ?


Gab&
Le 27/06/2013 à 13h 17

Les pages sont en anglais. Cela ne me gène pas et je trouve même cela plus simple pour dev, mais c’est étonnant car j’imagine que 99% des usagers de l’API seront francophones… À moins que cet OS soit ensuite revendu…


DeadEye
Le 27/06/2013 à 13h 26







gab69110 a écrit :



Les pages sont en anglais. Cela ne me gène pas et je trouve même cela plus simple pour dev, mais c’est étonnant car j’imagine que 99% des usagers de l’API seront francophones… À moins que cet OS soit ensuite revendu…



Ce n’est pas franchement étonnant. Les usagers de l’API seront à 99% (voire 100%) des développeurs et il est rare qu’un développeur ne soit pas anglophone.



raffoul
Le 27/06/2013 à 13h 27

non, pourquoi ce serait que du html5/js ? c’est un webservice. Tu fais une requête http sur l’adresse indiqué au début de l’api et c’est réglé ;). Une requête = une réponse. Après, elle est pas encore très riche l’API mais c’est mieux que rien !


oui j’ai vu que c’était des ws rest, je faisais allusion à la freebox en elle-meme. peut-on directement installer une app développée avec ces apis sur la freebox, si oui existe-t-il un moyen de mettre ces apps à la disposition des utilisateurs (via un market ou autre). et si oui, quel langage de dev est utilisée pour développer sur les freebox ^^


INoctavo
Le 27/06/2013 à 17h 18







nateriver a écrit :



oui j’ai vu que c’était des ws rest, je faisais allusion à la freebox en elle-meme. peut-on directement installer une app développée avec ces apis sur la freebox, si oui existe-t-il un moyen de mettre ces apps à la disposition des utilisateurs (via un market ou autre). et si oui, quel langage de dev est utilisée pour développer sur les freebox ^^







L’intérêt de cette API c’est surtout pour les systèmes hors de la Freebox pour leur permettre de communiquer avec elle.



Pour développer des applications sur la Freebox en elle même il y a Elixir (http://elixir.freebox.fr/ ) qui permet de développer en JavaScript avec un binding des bibliothèques Enlightenment et une API propre à la Freebox. Tu as accès en net avec Elixir mais pas sur le même réseau que la Freebox donc normalement pas possible d’accéder à l’API OS.



Ensuite pour les éditeurs pro il y a moyen de faire des applications natives mais il faut un partenariat avec Free.



vinky_
Le 27/06/2013 à 17h 54







INoctavo a écrit :



pas sur le même réseau que la Freebox donc normalement pas possible d’accéder à l’API OS.







J’ai cru comprendre que les apis n’étaient pas accessible depuis l’exterieur du réseauhttp://bugs.freeplayer.org/task/12565. C’est vraiment le cas ?



Ca semble quand même être une sacré régression par rapport à la version précédente non ?



INoctavo
Le 27/06/2013 à 17h 54

Je viens de me rendre compte que je parlais de la Freebox TV et toi de l’interface web certainement (:


brazomyna
Le 27/06/2013 à 18h 34







nateriver a écrit :



oui j’ai vu que c’était des ws rest, je faisais allusion à la freebox en elle-meme. peut-on directement installer une app développée avec ces apis sur la freebox, si oui existe-t-il un moyen de mettre ces apps à la disposition des utilisateurs (via un market ou autre). et si oui, quel langage de dev est utilisée pour développer sur les freebox ^^





Non, on ne peut pas développer d’appli qui s’exécutent sur une des box ; l’API est juste une interface qui permet à d’autres ‘device’ d’intéragir avec la freebox.



C’est d’ailleurs pour ça que je trouve que la dénomination ‘OS’ est pour le moins usurpée.



Elixir permet de développer sur Freebox, mais on ne peut pulblier que pour l’ancienne version de la box (Freebox HD). C’est pas possible pour la Freebox Révolution qui est, je crois, la seule box qui dispose de Freebox OS





Au delà, une application qui peut facilement être mise sur pied et rapidement faire le buzz, c’est un système de mise en ‘groupe’ d’utilisateurs pour partager des photos de vacances et autres joyeusetés, le tout quasiment totalement décentralisé, et sans qu’aucune forme de serveur centralisé ne stocke quoi que ce soit au mileu (genre des index de noms de fichiers, …), donc légalement difficilement attaquable.



C’est “pas ma came” comme disent les d’jeuns, mais nul doute que ça va rapidement émerger.




brazomyna
Le 27/06/2013 à 18h 41







INoctavo a écrit :



Tu as accès en net avec Elixir mais pas sur le même réseau que la Freebox donc normalement pas possible d’accéder à l’API OS.





Techniquement parlant, l’API n’est ouverte que du côté “réseau local derrière la box” ?



Ca me paraît contradictoire avec la notion de partage de fichier, le streaming depuis l’extérieur, etc…



Aymeric_F Abonné
Le 27/06/2013 à 20h 26

Yep… En voyant “Freebox OS”, je pensais qu’on allait avoir accès à des API pour dev des outils tournant sur la Freebox serveur ou TV…

Hélas, ce n’est qu’une interface web de management designée en système d’exploitation type Windows… :(

Ok, il y a des API qui permettent de dev des outils permettant d’interagir avec l’interface de gestion de la freebox, mais c’est tout. Bref, ce n’est pas un OS…


Ricard
Le 28/06/2013 à 06h 50

Génial. Toute la documentation d’une API Franco-Française bien écrite en Anglais. Bravo Free.<img data-src=" />


Gab&
Le 28/06/2013 à 07h 25

Il est possible d’envoyer des requêtes depuis l’extérieur, ça répond bien. Pour l’instant je n’ai fait que des trucs basiques, à terme j’aimerais bien scripter quelque chose pour mettre à jour la blocklist automatiquement. <img data-src=" />


pixeye
Le 28/06/2013 à 07h 41







gab69110 a écrit :







Et comment fait-on ? en envoyant la requête sur l’ip ? mafreebox.freebox.fr ne répond pas depuis tous les réseaux… (en tout cas pas en http sur la racine)



J’ai bien compris que la demande d’autorisation devait se faire en local, et il me semblait bien avoir compris que l’accès externe était possible (en tout cas via l’application mobile)



D’ailleurs ça ne sous-entend pas qu’en théorie Free a accès à tout le contenu de nos box ? <img data-src=" />



nemesis93_75
Le 28/06/2013 à 07h 54







le_castor a écrit :



Et comment fait-on ? en envoyant la requête sur l’ip ? mafreebox.freebox.fr ne répond pas depuis tous les réseaux… (en tout cas pas en http sur la racine)



J’ai bien compris que la demande d’autorisation devait se faire en local, et il me semblait bien avoir compris que l’accès externe était possible (en tout cas via l’application mobile)



D’ailleurs ça ne sous-entend pas qu’en théorie Free a accès à tout le contenu de nos box ? <img data-src=" />







Bah perso j’ai fait deux trois requetes HTTP hier, depuis l’extérieur vers ma freebox, et ça marchait… Après j’ai pas encore du tout approfondi l’API <img data-src=" />



pixeye
Le 28/06/2013 à 08h 08







nemesis93_75 a écrit :







Bon c’est vrai que j’ai pas testé de faire des requêtes, possible après tout que les serveurs de free soient configurés pour ne pas répondre si la requête est pas authentifiée <img data-src=" /> c’est nouveau pour moi ce genre de méthodes :)



al_bebert
Le 28/06/2013 à 10h 23







le_castor a écrit :



Et comment fait-on ? en envoyant la requête sur l’ip ? mafreebox.freebox.fr ne répond pas depuis tous les réseaux… (en tout cas pas en http sur la racine)



J’ai bien compris que la demande d’autorisation devait se faire en local, et il me semblait bien avoir compris que l’accès externe était possible (en tout cas via l’application mobile)



D’ailleurs ça ne sous-entend pas qu’en théorie Free a accès à tout le contenu de nos box ? <img data-src=" />







dans tous les cas l’appli freebox compagnon bosse à distance sans soucis une fois l’authentification faite en local



Gab&
Le 28/06/2013 à 12h 41







le_castor a écrit :



Et comment fait-on ? en envoyant la requête sur l’ip ? mafreebox.freebox.fr ne répond pas depuis tous les réseaux… (en tout cas pas en http sur la racine)







Il faut activer l’accès distant et utiliser ton ip publique le numéro de port utilisé pour l’accès distant.



Exemple, si ton ip publique est 80.123.456.789 et que le port de l’accès distant est 8585, tu peux faire une requête du genre :



http://80.123.456.78<img data-src=" />585/api_version



si tu as configuré un dns sur ton compte free tu peux même utiliser un truc du genre



http://le_castor.hd.free.fr<img data-src=" />585/api_version



Gab&
Le 28/06/2013 à 12h 49

j’arrive plus à éditer pour virer le smiley mais en gros il faut faire :

http://ip_publique:port/requete


AxelDG
Le 28/06/2013 à 14h 56







Ricard a écrit :



Génial. Toute la documentation d’une API Franco-Française bien écrite en Anglais. Bravo Free.<img data-src=" />







En même temps je ne donne pas un grand avenir ni à une boîte qui ferait sa documentation de référence en français ni à un développeur qui ne sait pas lire l’anglais… <img data-src=" />



Ricard
Le 28/06/2013 à 15h 18







AxelDG a écrit :



En même temps je ne donne pas un grand avenir ni à une boîte qui ferait sa documentation de référence en français ni à un développeur qui ne sait pas lire l’anglais… <img data-src=" />





J’ai jamais commenté mes codes en Anglais.<img data-src=" />



Ricard
Le 28/06/2013 à 15h 19







gab69110 a écrit :



j’arrive plus à éditer pour virer le smiley mais en gros il faut faire :

http://ip_publique:port/requete





<img data-src=" /> Exact. J’ai fait pareil et ça fonctionne.<img data-src=" />



AxelDG
Le 28/06/2013 à 15h 55







Ricard a écrit :



J’ai jamais commenté mes codes en Anglais.<img data-src=" />







Effectivement, si tous les employés de la boîtes sont français ça n’a pas énormément d’intérêt… et puis quand bien même les commentaires seraient illisibles par un non francophone, le code reste la référence (cf commentaires obsolètes, incomplets ou juste incompréhensibles…).



En revanche dans une documentation, et plus particulièrement une documentation technique pour des développeurs, l’anglais est, à mon sens, bien plus approprié. <img data-src=" />

Et si besoin, traduit en français après…



5h31k
Le 28/06/2013 à 20h 00







AxelDG a écrit :



Effectivement, si tous les employés de la boîtes sont français ça n’a pas énormément d’intérêt… et puis quand bien même les commentaires seraient illisibles par un non francophone, le code reste la référence (cf commentaires obsolètes, incomplets ou juste incompréhensibles…).



En revanche dans une documentation, et plus particulièrement une documentation technique pour des développeurs, l’anglais est, à mon sens, bien plus approprié. <img data-src=" />

Et si besoin, traduit en français après…







Après tout dépend le marché que tu vise. En occurrence, si la doc ne sera lisible que par des francophones, il n’y a aucun intérêt à l’écrire en Anglais. De plus, je rappelle que, en théorie, tout les documents techniques qui sortent en France doivent être écris en Français obligatoirement (texte de loi toussa).



AxelDG
Le 28/06/2013 à 21h 07







5h31k a écrit :



Après tout dépend le marché que tu vise. En occurrence, si la doc ne sera lisible que par des francophones, il n’y a aucun intérêt à l’écrire en Anglais. De plus, je rappelle que, en théorie, tout les documents techniques qui sortent en France doivent être écris en Français obligatoirement (texte de loi toussa).





Euh… Je ne suis pas certain que ce genre de loi (dont j’ignorais l’existence, au passage)… ne soit ni applicable ni appliquée dans le monde du développement aujourd’hui.



5h31k
Le 29/06/2013 à 10h 47







AxelDG a écrit :



Euh… Je ne suis pas certain que ce genre de loi (dont j’ignorais l’existence, au passage)… ne soit ni applicable ni appliquée dans le monde du développement aujourd’hui.







Je te confirme l’existence de cette loi (lorsque j’étais encore en étude nous l’avions étudié). TU peux aussi remarquer son application lorsque tu va dans les magasins pas cher (par exemple la foire fouille et compagnie), certains produits ont une étiquette collée en Français dessus pour se conformer à la règle (en particulier les produits de beauté/ soin du corps).



Après je t’accorde que son application est vraiment très restreinte dans le domaine du développement informatique. De plus, je suis d’accord avec toi sur le fait qu’un développeur dois savoir au moins lire une fiche technique Anglaise (je comprend les docs en Anglais mais je suis incapable d’avoir une conversation avec un Texan)



psn00ps
Le 01/07/2013 à 09h 03







gab69110 a écrit :



j’arrive plus à éditer pour virer le smiley mais en gros il faut faire :

http://ip_publique:port/requete





Il faut surtout utiliser la balise url/lien <img data-src=" />



Gab&
Le 01/07/2013 à 09h 22







psn00ps a écrit :



Il faut surtout utiliser la balise url/lien <img data-src=" />







Merci <img data-src=" />



PS: à la base je voulais quand même le mettre en texte brut vu que ce n’est pas un lien !