|
| 1 | +> This package is only in French because it is only for certain French internet boxes. |
| 2 | +
|
| 3 | +Une librairie pour faciliter l'utilisation de l'API de Freebox OS. Facilite l'authentification et l'envoi de requêtes afin de pouvoir intéragir simplement avec une Freebox. |
| 4 | + |
| 5 | +## Fonctionnalités |
| 6 | + |
| 7 | +L'API de Freebox OS est capable d'exécuter de nombreuses actions sur la box, comme la gestion des téléchargements et des fichiers sur le disque interne, ou la gestion des contacts et des appels sur le téléphone fixe. Cependant, l'authentification et la première connexion (register) sont assez complexes. Cette librairie permet de simplifier ces étapes, pour vous offrir une meilleure expérience de développement. |
| 8 | + |
| 9 | + |
| 10 | +## Utilisation |
| 11 | +Importez la librairie |
| 12 | +```dart |
| 13 | +import 'package:freebox/freebox.dart'; |
| 14 | +``` |
| 15 | +### Enregistrement |
| 16 | +Cette étape ne doit être effectuée **qu'une seule fois**, et permet d'obtenir un `appToken`. C'est une étape obligatoire pour utiliser l'API de Freebox OS. L'écran d'affichage de la Freebox demandera à l'utilisateur de confirmer l'opération. |
| 17 | + |
| 18 | +```dart |
| 19 | +await FreeboxClient.registerFreebox( |
| 20 | + appId: 'fbx.exemple', |
| 21 | + appName: 'Exemple', |
| 22 | + appVersion: '1.0.0', |
| 23 | + deviceName: 'iOS', |
| 24 | + verbose: true, // Optionnel, true par défaut |
| 25 | +); |
| 26 | +``` |
| 27 | + |
| 28 | +### Authentification |
| 29 | +L'étape d'authentification permet d'obtenir un token de session, qui est nécessaire pour effectuer des requêtes à l'API. |
| 30 | +```dart |
| 31 | +var client = FreeboxClient( |
| 32 | + appToken: "<Obtenu lors de l'enregistrement>", |
| 33 | + appId: "fbx.exemple", |
| 34 | + apiDomain: "<Obtenu lors de l'enregistrement>", |
| 35 | + httpsPort: 0, // "<Obtenu lors de l'enregistrement>" |
| 36 | + verbose: false, // Optionnel, false par défaut |
| 37 | + ); |
| 38 | +
|
| 39 | +await client.authentificate(); |
| 40 | +``` |
| 41 | + |
| 42 | +### Requêtes |
| 43 | +Une fois authentifié, vous pourrez effectuer des requêtes à l'API de Freebox OS. |
| 44 | + |
| 45 | +```dart |
| 46 | +var system = await client.fetch( |
| 47 | + url: "v8/system", |
| 48 | + method: "GET", // Optionnel, GET par défaut |
| 49 | + parseJson: true, // Optionnel, true par défaut |
| 50 | +); |
| 51 | +
|
| 52 | +print(system); // Affiche les informations système de la Freebox |
| 53 | +``` |
| 54 | +> Le header `Content-Type` est automatiquement défini à `application/json` s'il n'est pas déjà défini. |
| 55 | +
|
| 56 | +#### Récupérer un fichier |
| 57 | +Pour récupérer un fichier, rien de plus simple : |
| 58 | +```dart |
| 59 | +var audioData = await client.fetch( |
| 60 | + url: "/v10/call/voicemail/$audioId.au/audio_file", |
| 61 | + parseJson: false, // A ne pas oublier ! |
| 62 | + ); |
| 63 | +
|
| 64 | +// Créé un fichier audio_file.wav qui va contenir le fichier audio |
| 65 | +final file = File('audio_file.wav'); |
| 66 | +await file.writeAsBytes(audioData); |
| 67 | +``` |
| 68 | + |
| 69 | +Ici, on récupère un fichier audio de la messagerie vocale, et on le stocke dans un fichier audio_file.wav. |
| 70 | + |
| 71 | + |
| 72 | +## Informations supplémentaires |
| 73 | + |
| 74 | +- Vous trouverez la liste des endpoints disponibles dans la documentation de l'API de Freebox OS. |
| 75 | + |
| 76 | +Retrouvez tous nos projets pour Freebox sur le [Github de Freebox Tools](https://github.com/Freebox-Tools) |
0 commit comments