PHPackages                             alphayax/freebox\_api\_php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. alphayax/freebox\_api\_php

ActiveLibrary[HTTP & Networking](/categories/http)

alphayax/freebox\_api\_php
==========================

API PHP pour la Freebox

1.3.2(6y ago)124073MITPHPPHP >=5.5.0CI failing

Since Feb 6Pushed 6y ago4 watchersCompare

[ Source](https://github.com/alphayax/freebox_api_php)[ Packagist](https://packagist.org/packages/alphayax/freebox_api_php)[ RSS](/packages/alphayax-freebox-api-php/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (10)Dependencies (7)Versions (79)Used By (0)

Freebox v6 PHP API v3/v4
========================

[](#freebox-v6-php-api-v3v4)

[![stable](https://camo.githubusercontent.com/32e1ce119e2937e9d239ad6d7fafecf041a40d893696bd1bf8992d5325afe3d0/68747470733a2f2f706f7365722e707567782e6f72672f616c7068617961782f66726565626f785f6170695f7068702f762f737461626c65)](https://camo.githubusercontent.com/32e1ce119e2937e9d239ad6d7fafecf041a40d893696bd1bf8992d5325afe3d0/68747470733a2f2f706f7365722e707567782e6f72672f616c7068617961782f66726565626f785f6170695f7068702f762f737461626c65)[![unstable](https://camo.githubusercontent.com/f43045d6ded782f939429b2180ec4cc036bc7b71a17d64ccba39c3121240c236/68747470733a2f2f706f7365722e707567782e6f72672f616c7068617961782f66726565626f785f6170695f7068702f762f756e737461626c65)](https://camo.githubusercontent.com/f43045d6ded782f939429b2180ec4cc036bc7b71a17d64ccba39c3121240c236/68747470733a2f2f706f7365722e707567782e6f72672f616c7068617961782f66726565626f785f6170695f7068702f762f756e737461626c65)[![pakagist](https://camo.githubusercontent.com/0652ed05c65312d972f01e3ed3be52b5dce9938b19ee45a072fe21beaef1d131/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f616c7068617961782f66726565626f785f6170695f7068702e737667)](https://camo.githubusercontent.com/0652ed05c65312d972f01e3ed3be52b5dce9938b19ee45a072fe21beaef1d131/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f616c7068617961782f66726565626f785f6170695f7068702e737667)

[![Build Status](https://camo.githubusercontent.com/e2c5f084cc238df385f0db567e73e4bfb7fd53bbd9de46c98da25705a8376758/68747470733a2f2f7472617669732d63692e6f72672f616c7068617961782f66726565626f785f6170695f7068702e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/alphayax/freebox_api_php)[![Coverage](https://camo.githubusercontent.com/7cbb9314943945a79a36fde31e4aea1de4d3bc9ca3192279e869ecf4ecba51ba/68747470733a2f2f6170692e636f646163792e636f6d2f70726f6a6563742f62616467652f436f7665726167652f6633353639636636373166303462386162366436393962653366643031316535)](https://www.codacy.com/app/alphayax/freebox_api_php?utm_source=github.com&utm_medium=referral&utm_content=alphayax/freebox_api_php&utm_campaign=Badge_Coverage)[![Codacy](https://camo.githubusercontent.com/3dba4c9c90526d384a7267a0f1d4ebb3af0ce005f7acedf2480267c47180a7ce/68747470733a2f2f6170692e636f646163792e636f6d2f70726f6a6563742f62616467652f47726164652f6633353639636636373166303462386162366436393962653366643031316535)](https://www.codacy.com/app/alphayax/freebox_api_php?utm_source=github.com&utm_medium=referral&utm_content=alphayax/freebox_api_php&utm_campaign=Badge_Grade)

[![License](https://camo.githubusercontent.com/4b8b67579ea26391b00f730e3e0941273e391ca2cddd92e9105eab6e692289de/68747470733a2f2f706f7365722e707567782e6f72672f616c7068617961782f66726565626f785f6170695f7068702f6c6963656e7365)](https://packagist.org/packages/alphayax/freebox_api_php)[![Total Downloads](https://camo.githubusercontent.com/688b5caa913b4286a61bb78a72afedf4ce81dbdc2e2e59154539e767febb1495/68747470733a2f2f706f7365722e707567782e6f72672f616c7068617961782f66726565626f785f6170695f7068702f646f776e6c6f616473)](https://packagist.org/packages/alphayax/freebox_api_php)

Implementation PHP de l'API de la freebox

- Intégralement dans sa version 3
- Partiellement dans sa version 4

Prérequis
---------

[](#prérequis)

Ce projet est basé sur **composer**. Pensez à installer les dependences :)

Fonctionnalités
---------------

[](#fonctionnalités)

Un document complet repertorie l'ensemble des services implémentées :

- Pour la v3 de l'API : [API v3](docs/services_v3/__NAMESPACE__.md)
- Pour la v4 de l'API : [API v4](docs/services_v4/__NAMESPACE__.md)

### API Freebox (v3)

[](#api-freebox-v3)

- [AirMedia](docs/services_v3/AirMedia/__NAMESPACE__.md)
- [Call](docs/services_v3/Call/__NAMESPACE__.md)
- [Configuration](docs/services_v3/config/__NAMESPACE__.md)
- [Download](docs/services_v3/download/__NAMESPACE__.md)
- [FileSystem](docs/services_v3/FileSystem/__NAMESPACE__.md)
- [Parental Control](docs/services_v3/ParentalControl/__NAMESPACE__.md)
- [RRD](docs/services_v3/RRD/__NAMESPACE__.md)
- [Storage](docs/services_v3/Storage/__NAMESPACE__.md)

### API Freebox (v4)

[](#api-freebox-v4)

- [AirMedia](docs/services_v4/AirMedia/__NAMESPACE__.md)
- [Download](docs/services_v4/download/__NAMESPACE__.md)
- [FileSystem](docs/services_v4/FileSystem/__NAMESPACE__.md)

Utilisation
-----------

[](#utilisation)

### Application

[](#application)

L'objet `\alphayax\freebox\utils\Application` représente votre application. Vous devrez créer une instance de cette classe et la transmettre aux services que vous souhaitez utiliser.

#### Association

[](#association)

Pour acceder aux services proposés par l'API de la freebox, vous deverez autoriser votre application. Cette procedure impose que vous soyez connecté au réseau local de votre Freebox lors de "l'association" et que vous ayez la Freebox a portée de main. L'application sauvegarde automatiquement le token retourné par la freebox et cette procedure ne sera plus a reproduire.

Notez que pour modifier les droits d'accès aux differents services, vous deverez passer par l'interface web locale : \[\].

> Parametres de la freebox > Divers > Gestion des accès > Applications

1. Créer un objet application.
2. Demander l'autorisation de connexion a la freebox (cf: cadrant led du Freebox Server)
3. Récuperer une session pour utiliser les divers services de l'API

```
$App = new \alphayax\freebox\utils\Application( 'com.alphayax.freebox.example', 'Freebox PHP API Exemple', '0.0.1');
$App->authorize();
$App->openSession();
```

#### Accès local

[](#accès-local)

L'accès local est activé par défaut. Une fois l'application créée et la session ouverte, vous pouvez utiliser directement les services auquels l'application à acces.

#### Accès distant

[](#accès-distant)

Pour pouvoir utiliser l'accès distant, il vous faudra le token associé a votre application. Ce token s'obtient automatiquement après l'association faite via l'appel à la méthode `authorize()`. Le token est ecrit dans le fichier `app_token`. Il est également disponible via la methode `\alphayax\freebox\utils\Application::getAppToken()`.

Une fois le token obtenu, vous pouvez proceder comme suit :

```
$App = new \alphayax\freebox\utils\Application( 'com.alphayax.freebox.version', 'Freebox PHP API Example (Version)', '1.0.0');
$App->setFreeboxApiHost( 'https://xxx.freeboxos.fr:17105'); // A remplacer par votre host
$App->setAppToken( 'xxxxxxxxxxxxxxxxxxxx');                 // A remplacer par votre token
$App->openSession();
```

### Services

[](#services)

Les appels aux services de l'API se font par l'intermédiaire de services. Ces derniers possedent les méthodes pour récuperer, ajouter ou mettre a jour des données.

Voici un exemple d'utilisation de l'API System :

1. Nous créons un nouveau service "System"
2. Nous demandons de récuperer la configuration actuelle
3. Affichage du modele retourné

```
$System = new \alphayax\freebox\api\v3\services\config\System( $App);
$SystemConfig = $System->getConfiguration();

print_r( $SystemConfig);
```

Résultat :

```
alphayax\freebox\api\v3\models\SystemConfig Object
(
    [firmware_version:protected] => 3.3.1
    [mac:protected] => 77:77:77:77:77:77
    [serial:protected] => 7777777777777777
    [uptime:protected] => 44 jours 16 heures 35 minutes 16 secondes
    [uptime_val:protected] => 3861316
    [board_name:protected] => fbxgw2r
    [temp_cpum:protected] => 63
    [temp_sw:protected] => 52
    [temp_cpub:protected] => 58
    [fan_rpm:protected] => 2253
    [box_authenticated:protected] => 1
)
```

Exemples
--------

[](#exemples)

Les exemples sont disponibles dans le repertoire `exemple`. Ils sont classés par services :

- `AirMedia` : Exemple de lancement d'une video sur le Freebox Player
- `Call` :
    - `Call` : Liste les appels recus et emis sur la freebox (avec exemple de supression et de marquage comme lu)
    - `Contact` : Liste les contacts, ajoute et retire un numéro de téléphone au premier contact de la liste
- `FileSystem`
    - `fileSharing` : Un exemple de partage de fichier sur le net
    - `fsListing` : Un exemple de scan de repertoires de la freebox
    - `fsOperation` : Un exemple d'operations sur le fichiers (copies, déplacement, renommage, par2..)
- `config`
    - `check_dns` : Un script pour récuperer la configuration courrante du DHCP
    - `Connection` : Récupere diverses informations sur la connexion de la freebox (xDSL, FTTH, DynDns...)
    - `DMZ` : Récupération de la configuration de votre zone démilitarisée
    - `Freeplug` : Affichage de votre configuration de Freeplug
    - `IncomingPort` : Retourne la configuration actuelle du port d'entrée HTTP
    - `LCD` : Exemple de modification de la luminosité du cadrant LCD de la freebox server
    - `LAN` : Configuration du LAN et exploration des machines en réseau
    - `PortForwarding` : Exemple d'ajout d'une redirection de port
    - `System` : Affichage de la configuration système de la freebox
    - `UPnP` : Affichage des configuration UPnP
    - `VPN` : Affiche la configuration des serveurs VPN, liste les utilisateurs...
    - `WiFi` : Affiche la configuration globale du wifi
- `download`
    - `Download` : Listage des téléchargement en cours, liste des fichiers d'un téléchargement et mise a jour de la priorité de téléchargement
    - `DlConfig` : Affichage des configurations de téléchargement (bt, nntp...)
    - `dl_rss` : Un script qui parse les flux RSS et qui rajoute en téléchagement les items correspondant a une expression réguliere
    - `Bittorrent` : Affiche des infos sur des telechargements bittorent
- `ParentalControl`
    - `Filter` : Retourne la config et les filtres actuels
- `Storage`
    - `Disk` : Retourne des informations sur les disques connectés aux freebox
    - `Partition` : Retourne des infos sur ces disques. Possibilité de verification ou de formatage
- `remote` : Un exemple de connexion distant
- `version` : Affichage de la version de l'API de la freebox

Freebox Delta et accès aux objets connectés
-------------------------------------------

[](#freebox-delta-et-accès-aux-objets-connectés)

Pour accéder aux objets connectés, vous devez autoriser l'application à y accéder. Pour ce faire, allez dans l'interface d'administration de la freebox après avoir obtenu votre clé API, puis rendez vous dans `Paramètres de la Freebox` / `Gestion des accès` / `Application` puis autorisez `Gestion de l'alarme et maison connectée`.

###  Health Score

35

—

LowBetter than 79% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity21

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity73

Established project with proven stability

 Bus Factor1

Top contributor holds 99.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~16 days

Recently: every ~109 days

Total

75

Last Release

2532d ago

Major Versions

0.9.1 → 1.0.02016-06-12

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/7924417?v=4)[Yann Ponzoni](/maintainers/alphayax)[@alphayax](https://github.com/alphayax)

---

Top Contributors

[![alphayax](https://avatars.githubusercontent.com/u/7924417?v=4)](https://github.com/alphayax "alphayax (135 commits)")[![paxal](https://avatars.githubusercontent.com/u/1848817?v=4)](https://github.com/paxal "paxal (1 commits)")

---

Tags

apirestdownloadfreeboxFreebox revolutionFreebox delta

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/alphayax-freebox-api-php/health.svg)

```
[![Health](https://phpackages.com/badges/alphayax-freebox-api-php/health.svg)](https://phpackages.com/packages/alphayax-freebox-api-php)
```

###  Alternatives

[xeroapi/xero-php-oauth2

Xero official PHP SDK for oAuth2 generated with OpenAPI spec 3

1054.3M14](/packages/xeroapi-xero-php-oauth2)[huaweicloud/huaweicloud-sdk-php

Huawei Cloud SDK for PHP

1829.2k2](/packages/huaweicloud-huaweicloud-sdk-php)[cybercog/youtrack-rest-php

YouTrack REST API PHP Client.

37149.2k3](/packages/cybercog-youtrack-rest-php)[onesignal/onesignal-php-api

A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com

34170.2k2](/packages/onesignal-onesignal-php-api)[ory/hydra-client

Documentation for all of Ory Hydra's APIs.

17435.9k](/packages/ory-hydra-client)[zenditplatform/zendit-php-sdk

PHP client for Zendit API

1204.3k](/packages/zenditplatform-zendit-php-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)