Freebox Server (Ultra V9/ Pop V8/ Delta V7 / Revolution V6 / Mini 4K)

Je développe actuellement une application pour le contrôle des box dont la Freebox v6 fait partie.

Lors de mes tests de l’API d’authentification, j’ai constaté une anomalie lors de la récupération d’un challenge pour l’ouverture d’une session (GET http://mafreebox.freebox.fr/api/v1/login/ dans le cas où on aura logged_in = true donc où on est déjà connecté). Le challenge retourné n’est plus une chaîne mais un tableau de 32 cases présentant une partie du code de génération du challenge.

Un aperçu pour preuve : http://img835.imageshack.us/img835/41/im4z.png

Si AirMedia est en cours d’utilisation (plus fréquent si le titre du morceau/album est long) :
lors d’une demande d’authentification via l’API freebox Os, la demande API recouvre partiellement l’affichage AirMedia.

Bonjour,

Suite à des tests sur l’API et quelques bugs, je me retrouve avec un retour “ratelimited” à l’authentification.
Comment l’enlever ? C’est bien de bloquer trop d’échecs de connexion mais là ça fait plus de 12h donc j’aimerais bien pouvoir de nouveau accéder à l’API de ma Freebox. Il faudrait pouvoir enlever le blocage depuis la console Freebox OS.

Merci

L’appel à l’url http://hd1.freebox.fr/pub/channels retourne une réponse Forbidden au lieu de renvoyer la liste des chaînes comme sur les freebox hd.

Bonjour,

Il semblerait que Freebox OS mémorise une Applications même si on a refusé son autorisation. De plus, sauf erreur, rien ne permet de distinguer une Application autorisée d’une application non autorisée.

J’ai déclenché par erreur une nouvelle demande d’autorisation du “Compagnon Freebox” (Androïd), que j’ai refusée au niveau du panneau de commande du Server, mais en interrogeant la “Gestion des accès” de Freebox OS, je trouve l’Application en double, (à noter que la seconde, que j’ai refusée, n’a pas le “setting” ‘Modification des réglages de la Freebox”).

S’agit-il d’une erreur ? Spécifique au fait que cette Application utilise des API spéciales ?

Je pense qu’une Application qui n’a pas reçu l’autorisation par l’abonné, ne devrait pas être mémorisée, ou alors avec un status clairement identifiable “application non autorisé”, (histoire de laisser une trace pour identifier les tentatives d’intrusion).

De plus, cette action a généré un doublon : même code Application, même version, même périphérique demandeur... cela n’aurait déjà pas dû être accepté par le Server...

Cordialement,

DFAL

Bonjour,
en utilisant la requête documentée “PUT /api/v1/storage/partition/{id}” pour ejecter un disque USB connecté, j’ai le code retour HTTP 403 (forbidden) avec la réponse JSON suivante :

Requête : PUT /api/v1/storage/partition/2002

{
"state": "umounted"
}

Réponse

{
"uid": "[supprimé par l'auteur]",
"success": false,
"missing_right": "settings",
"msg": "Cette application n'est pas autorisée à accéder à cette fonction",
"result": {
	"password_salt": "[supprimé par l'auteur]"
},
"error_code": "insufficient_rights"
}

Pour info quelques autres requêtes/réponses :
Requête : GET /api/v1/storage/disk/
Réponse :

{
"success": true,
"result": [{
	"idle_duration": 260,
	"spinning": true,
	"table_type": "msdos",
	"firmware": "SC16",
	"type": "internal",
	"idle": true,
	"connector": 0,
	"id": 1,
	"state": "enabled",
	"time_before_spindown": 340,
	"total_bytes": 250059350016,
	"model": "ST9250311CS",
	"active_duration": 0,
	"temp": 46,
	"serial": "5VCK86J6",
	"partitions": [{
		"fstype": "ext4",
		"total_bytes": 245150846976,
		"label": "Disque dur",
		"id": 3,
		"fsck_result": "no_run_yet",
		"state": "mounted",
		"disk_id": 1,
		"free_bytes": 129748549632,
		"used_bytes": 102949330944,
		"path": "L0Rpc3F1ZSBkdXI="
	}]
}, {
	"type": "usb",
	"total_bytes": 2000365289472,
	"connector": 0,
	"id": 2001,
	"active_duration": 0,
	"partitions": [{
		"fstype": "ntfs",
		"total_bytes": 2000364236800,
		"label": "My Passport",
		"id": 2002,
		"fsck_result": "no_run_yet",
		"state": "mounted",
		"disk_id": 2001,
		"free_bytes": 1973009326080,
		"used_bytes": 27354910720,
		"path": "L015IFBhc3Nwb3J0"
	}],
	"idle_duration": 0,
	"state": "enabled",
	"idle": false,
	"spinning": false,
	"model": "",
	"table_type": "msdos",
	"temp": 0,
	"serial": "",
	"firmware": ""
}]
}

Requête : POST /api/v1/login/session/

{
"app_id": "idappli",
"password": "[supprimé par l'auteur]"
}

Réponse :

{
"result": {
	"session_token": "[supprimé par l'auteur]",
	"challenge": "[supprimé par l'auteur]",
	"password_salt": "[supprimé par l'auteur]",
	"permissions": {
		"downloader": true,
		"settings": false,
		"calls": true,
		"explorer": true,
		"contacts": true,
		"parental": false
	}
},
"success": true
}

Il est donc impossible d’éjecter un disque USB alors que la documentation décrit l’action

J’essaye d’écrire une petite application pour collecter les statistiques sur
le débit de Freeplugs. Je peux récupérer ces données sans problème en faisant
une requête sur http://mafreebox.freebox.fr/api/v1/freeplug mais si j’essaye
de les prendre directement sur le lien correspondant au freeplug qui
m’intéresse, ça retourne toujours -1. Par exemple:

$ curl -H 'X-Fbx-App-Auth: ...' http://mafreebox.freebox.fr/api/v1/freeplug | json_pp
{
   "success" : true,
   "result" : [
      {
         "members" : [
            {
               "eth_port_status" : "up",
               "eth_full_duplex" : true,
               "tx_rate" : -1,
               "inactive" : 1,
               "model" : "int6400",
               "has_network" : true,
               "eth_speed" : 100,
               "local" : true,
               "net_role" : "cco",
               "net_id" : "xx:xx:xx:xx:xx:xx",
               "id" : "yy:yy:yy:yy:4A:A4",
               "rx_rate" : -1
            },
            {
               "eth_port_status" : "up",
               "eth_full_duplex" : true,
               "tx_rate" : 86,
               "inactive" : 1,
               "model" : "int6400",
               "has_network" : true,
               "eth_speed" : 100,
               "local" : false,
               "net_role" : "sta",
               "net_id" : "xx:xx:xx:xx:xx:xx",
               "id" : "yy:yy:yy:yy:4B:11",
               "rx_rate" : 40
            }
         ],
         "id" : "xx:xx:xx:xx:xx:xx"
      }
   ]
}

mais

$ curl -H 'X-Fbx-App-Auth: ...' http://mafreebox.freebox.fr/api/v1/freeplug/yy:yy:yy:yy:4B:11 | json_pp
{
   "success" : true,
   "result" : {
      "eth_port_status" : "up",
      "eth_full_duplex" : true,
      "tx_rate" : -1,
      "inactive" : 1,
      "model" : "int6400",
      "has_network" : true,
      "eth_speed" : 100,
      "local" : false,
      "net_role" : "sta",
      "net_id" : "xx:xx:xx:xx:xx:xx",
      "id" : "yy:yy:yy:yy:4B:11",
      "rx_rate" : -1
   }
}

/api/v1/system/ renvoie l’uptime sous forme de texte, correctement formatée :
- Les jours, heures, minutes et secondes ne sont pas indiqués s’ils sont nuls (par exemple “1 jour 1 minute 1 seconde” - Les jours, heures, minutes et secondes sont au singulier quand ils sont à 1
C’est très bien au niveau accord, mais si on doit récupérer l’uptime en secondes, ça devient un peu compliqué.
Est-il possible d’ajouter un compteur “uptime_sec” de type int qui renvoie l’uptime en secondes (comme pour l’uptime de la connexion ADSL) ?

Une erreur s’est glissée dans la fonction “Update the current DHCP configuration” (http://dev.freebox.fr/sdk/os/dhcp/#update-the-current-dhcp-configuration).
L’exemple (PUT /api/v1/airmedia/ HTTP/1.1) ne correspond pas à la requête permettant la mise à jour de la config DHCP (PUT /api/v1/dhcp/config/).

Un erreur est présente dans l’exemple de la fonction “Create a new MAC filter” (http://dev.freebox.fr/sdk/os/wifi/#create-a-new-mac-filter).

Pour créer un nouvel objet WifiMacFilter, il ne faut pas écrire

POST /api/v1/wifi/mac_filter/00:07:CB:01:02:03 HTTP/1.1
Host: mafreebox.freebox.fr
{
   "comment": "filtre de test",
   "type": "blacklist",
   "mac": "00:07:CB:CB:07:00"
}

mais

POST /api/v1/wifi/mac_filter HTTP/1.1
Host: mafreebox.freebox.fr
{
   "comment": "filtre de test",
   "type": "blacklist",
   "mac": "00:07:CB:CB:07:00"
}

Le problème est sur l’URL appelée avec le POST où l’adresse MAC est en trop.

Une erreur est présente dans l’exemple de la fonction “Update a partition state” (http://dev.freebox.fr/sdk/os/storage/#update-a-partition-state).

Pour changer l’état d’une parition, il ne faut pas écrire

PUT /api/v1/storage/disk/1 HTTP/1.1
Host: mafreebox.freebox.fr
{
   "state" : "umounted"
}

mais

PUT /api/v1/storage/partition/1 HTTP/1.1
Host: mafreebox.freebox.fr
{
   "state" : "umounted"
}

Le problème est sur l’URL appelée avec le PUT.

Une erreur est présente dans l’intitulé de la fonction “Get the list of available AirMedia receivers” (http://dev.freebox.fr/sdk/os/airmedia/#get--api-v1-airmedia-receivers-).

L’intitulé est incorrect.

Plutôt que d’écrire

Update the current

il faudrait écrire

Get the list of AirMediaReceiver connected to the Freebox Server

.

Une erreur est présente dans les 2 exemples de l’API “File Sharing Link API” (http://dev.freebox.fr/sdk/os/share/#file-sharing-link-api). Un guillemet est manquant dans les 2 exemples de réponses à un GET après la variable “name”.

Plutôt que d’écrire

{
   success: true,
   result: [
      {
          "path": "L0Rpc3F1ZSBkdXIvUGhvdG9zL01lcyB2YWNhbmNlcyBlbiByb3Vsb3R0ZQ==" /* /Disque dur/Photos/Mes vacances en roulotte */
          "name: "Mes vacances en roulotte",
          "token": "gAnweF2Xg5OwcJWn",
          "expire": 1355852344,
          "fullurl": "http://13.37.42.69/api/v1/share/gAnweF2Xg5OwcJWn/"
      },
      {
          "path": "L0Rpc3F1ZSBkdXIvc2hhcmVk", /* /Disque dur/shared */
          "name": "shared",
          "token": "s8a+4VtOQNkkQ55f",
          "expire": 1355866268,
          "fullurl": "http://13.37.42.69/api/v1/share/s8a+4VtOQNkkQ55f/"
      }
   ]
}

il faudrait écrire

{
   success: true,
   result: [
      {
          "path": "L0Rpc3F1ZSBkdXIvUGhvdG9zL01lcyB2YWNhbmNlcyBlbiByb3Vsb3R0ZQ==" /* /Disque dur/Photos/Mes vacances en roulotte */
          "name": "Mes vacances en roulotte",
          "token": "gAnweF2Xg5OwcJWn",
          "expire": 1355852344,
          "fullurl": "http://13.37.42.69/api/v1/share/gAnweF2Xg5OwcJWn/"
      },
      {
          "path": "L0Rpc3F1ZSBkdXIvc2hhcmVk", /* /Disque dur/shared */
          "name": "shared",
          "token": "s8a+4VtOQNkkQ55f",
          "expire": 1355866268,
          "fullurl": "http://13.37.42.69/api/v1/share/s8a+4VtOQNkkQ55f/"
      }
   ]
}

Et plutôt que d’écrire

{
    "success": true,
    "result": {
        "path": "L0Rpc3F1ZSBkdXIvUGhvdG9zL01lcyB2YWNhbmNlcyBlbiByb3Vsb3R0ZQ==" /* /Disque dur/Photos/Mes vacances en roulotte */
        "name: "Mes vacances en roulotte",
        "token": "gAnweF2Xg5OwcJWn",
        "expire": 1355852344,
        "fullurl": "http://13.37.42.69/api/v1/share/gAnweF2Xg5OwcJWn/"
    }
}

il faudrait écrire

{
    "success": true,
    "result": {
        "path": "L0Rpc3F1ZSBkdXIvUGhvdG9zL01lcyB2YWNhbmNlcyBlbiByb3Vsb3R0ZQ==" /* /Disque dur/Photos/Mes vacances en roulotte */
        "name": "Mes vacances en roulotte",
        "token": "gAnweF2Xg5OwcJWn",
        "expire": 1355852344,
        "fullurl": "http://13.37.42.69/api/v1/share/gAnweF2Xg5OwcJWn/"
    }
}

Cette fonction (http://dev.freebox.fr/sdk/os/share/#create-a-file-sharing-link) est mal documentée.

• Elle se nomme “Create a File Sharing link” → Son libellé est “Updates the FsTask task with the given id”.

• Sa commande est “POST /api/v1/share_link/” → L’exemple donne “PUT /api/v1/fs/tasks/15”.

function addDownload(link) {

var param = {"download_url": link, "recursive": true,"username":"","password":""};
var paramString = JSON.stringify(param);

var headers = {
      'Content-Type': 'application/x-www-form-urlencoded',
      'X-Fbx-App-Auth': session_token
};

$.ajax({
  type       : "POST",
  url        : FREEBOX_URL+'/api/v1/downloads/add',
  headers    : headers,
  data       : paramString,
  crossDomain: true,
  beforeSend : function() {$.mobile.loading('show')},
  complete   : function() {$.mobile.loading('hide')},
  success    : function(response) {
    if (response.success === true) {
      console.log("téléchargement ajouté");
    } else {
      console.log('Impossible d\'ajouter le Téléchargement : '+ JSON.stringify(response));
      return;
    }
  },
  error: function(response) {
    console.log(response);
  }
});     

}

avec cette requête j ai en retour

Impossible d’ajouter le Téléchargement : {”msg”:”Erreur lors de l’ajout du téléchargement”,”success”:false,”error_code”:”invalid_request”}

sachant que link est un lien http d’un .torrent encodé avec encodeURIComponent ...

thanks

bonjour

pour l ajout de download d un torrent par l api

1/ faut il encoder l url ? (j ai testé avec et sans)
2/ utiliser application/json ou multipart pour un ajout simple de torrent par url ? (j ai testé les deux)

je n ai aucun soucis avec l api freebox nickel sauf l ajout de downloads ... pas moyen, message impossible d ajouter le telechargement à chaque fois...

cdt

Bonjour,

Avec le nouveau firmware 2.1 du Server, l’API a aussi changé de version et est maintenant en version 2.0 :

{”uid”:”e63317fda62fd02acd47faab71ad7215”,”device_name”:”Freebox Server”,”api_version”:”2.0”,”api_base_url”:”\/api\/”,”device_type”:”FreeboxServer1,1”}

Noter que le device est toujours “1,1”.

La compatibilité ascendante est elle assurée ?

Si j’envoie une requête typée version “1.0” sera-t-elle honorée sur la version “2.0” ?

Et en cas de changement dans les paramètres d’appel ou les réponses que se passe-t-il ?

Merci.

Cordialement,

DFAL

Bonjour,

L’url pour la récupération des rrd ne semble pas être la bonne sur la documentation de l’api http://dev.freebox.fr/sdk/os/rrd/#post--api-v1-rrs- :

POST /api/v1/rrs/

Il s’agirait plutôt de :

POST /api/v1/rrd/

Comme cela est indiqué dans le bloc « Example request » :

POST /api/v1/rrd/ HTTP/1.1

(L’ancre #post–api-v1-rrs- semble erronée elle-même).

Depuis le passage à l’API V2, tous les exemples et requêtes sont obsolètes dans la doc. Le chemin fait toujours référence à la v1.

Exemple pour la fonction Request authorization (http://dev.freebox.fr/sdk/os/login/#request-authorization) :
POST /api/v1/login/authorize/ à remplacer par POST /api/v2/login/authorize/
Idem pour l’exemple associé et toutes les fonctions de la documentation de l’API.

Peut être faudrait il remplacer le v1 (ou v2) par un “APIVersion” évitant ainsi d’avoir à reprendre toute la doc lors d’une migration à une nouvelle version majeure des fonctions qui fonctionnaient en version précédente de l’API ?
–> POST /api/APIVersion/login/authorize/

Set the config of a DynDNS service
http://dev.freebox.fr/sdk/os/connection/#put--api-v1-connection-ddns-{provider}-

Returns the current DDNSConfig
à corriger en
Set the DDNSConfig

hello

Tout d’abord félicitations pour vos nouvelles api ! et comme indiqué dans le titre, juste pour info y a t il une date (environ...) pour la doc qui va avec :p ?

on peut regarder les requetes par firebug etc mais bon ça reste assez obscur ...

thx