Download the PHP package alphayax/freebox_api_php without Composer
On this page you can find all versions of the php package alphayax/freebox_api_php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download alphayax/freebox_api_php
More information about alphayax/freebox_api_php
Files in alphayax/freebox_api_php
Informations about the package freebox_api_php
Freebox v6 PHP API v3/v4
Implementation PHP de l'API de la freebox
- Intégralement dans sa version 3
- Partiellement dans sa version 4
Prérequis
Ce projet est basé sur composer. Pensez à installer les dependences :)
Fonctionnalités
Un document complet repertorie l'ensemble des services implémentées :
- Pour la v3 de l'API : API v3
- Pour la v4 de l'API : API v4
API Freebox (v3)
- AirMedia
- Call
- Configuration
- Download
- FileSystem
- Parental Control
- RRD
- Storage
API Freebox (v4)
- AirMedia
- Download
- FileSystem
Utilisation
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
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 : [http://mafreebox.freebox.fr/login.php].
Parametres de la freebox > Divers > Gestion des accès > Applications
- Créer un objet application.
- Demander l'autorisation de connexion a la freebox (cf: cadrant led du Freebox Server)
- Récuperer une session pour utiliser les divers services de l'API
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
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 :
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 :
- Nous créons un nouveau service "System"
- Nous demandons de récuperer la configuration actuelle
- Affichage du modele retourné
Résultat :
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 PlayerCall
: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 netfsListing
: Un exemple de scan de repertoires de la freeboxfsOperation
: Un exemple d'operations sur le fichiers (copies, déplacement, renommage, par2..)
config
check_dns
: Un script pour récuperer la configuration courrante du DHCPConnection
: 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éeFreeplug
: Affichage de votre configuration de FreeplugIncomingPort
: Retourne la configuration actuelle du port d'entrée HTTPLCD
: Exemple de modification de la luminosité du cadrant LCD de la freebox serverLAN
: Configuration du LAN et exploration des machines en réseauPortForwarding
: Exemple d'ajout d'une redirection de portSystem
: Affichage de la configuration système de la freeboxUPnP
: Affichage des configuration UPnPVPN
: 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échargementDlConfig
: 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éguliereBittorrent
: 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 freeboxPartition
: Retourne des infos sur ces disques. Possibilité de verification ou de formatage
remote
: Un exemple de connexion distantversion
: Affichage de la version de l'API de la freebox
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
.
All versions of freebox_api_php with dependencies
ext-curl Version *
alphayax/rest Version ^1.1.2
guzzlehttp/guzzle Version ~6.0
monolog/monolog Version ^1.9.1