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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package freebox_api_php

Freebox v6 PHP API v3/v4

stable unstable pakagist

Build Status Coverage Codacy

License Total Downloads

Implementation PHP de l'API de la freebox

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 :

API Freebox (v3)

API Freebox (v4)

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

  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

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 :

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

Résultat :

Exemples

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

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

PHP Build Version
Package Version
Requires php Version >=5.5.0
ext-curl Version *
alphayax/rest Version ^1.1.2
guzzlehttp/guzzle Version ~6.0
monolog/monolog Version ^1.9.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package alphayax/freebox_api_php contains the following files

Loading the files please wait ....