Version 1 du README.md
This commit is contained in:
60
README.md
60
README.md
@@ -1,2 +1,62 @@
|
||||
# ScriptAPI
|
||||
|
||||
Ce dépôt contient une collection de scripts PHP utilisant des appels REST API sur les automates Devices de la gamme Eclypse.\
|
||||
Les scripts peuvent être exécutés via PHP CLI (Command Line Interface).
|
||||
|
||||
## Prérequis
|
||||
|
||||
### Installation de PHP CLI
|
||||
|
||||
Pour exécuter les scripts, vous devez installer PHP CLI sur Windows. Voici les étapes à suivre :
|
||||
|
||||
1. Téléchargez PHP pour Windows depuis le site officiel : [php.net/downloads](https://www.php.net/downloads).
|
||||
2. Extrayez les fichiers téléchargés dans un répertoire de votre choix, par exemple `C:\php`.
|
||||
3. **Ajoutez PHP au PATH** de votre système pour pouvoir l'utiliser en ligne de commande :
|
||||
- Ouvrez les **Paramètres système avancés** :
|
||||
- Cliquez avec le bouton droit sur "Ce PC" ou "Poste de travail".
|
||||
- Sélectionnez **Propriétés**, puis cliquez sur **Paramètres système avancés**.
|
||||
- Dans l'onglet **Avancé**, cliquez sur **Variables d'environnement**.
|
||||
- Trouvez la variable `Path` dans la section **Variables système**, puis cliquez sur **Modifier**.
|
||||
- Ajoutez le chemin vers le répertoire où vous avez extrait PHP, par exemple `C:\php`.
|
||||
- Cliquez sur **OK** pour valider.
|
||||
|
||||
4. Vérifiez que PHP est installé et accessible en ligne de commande en exécutant :
|
||||
```bash
|
||||
php -v
|
||||
|
||||
### Extension cURL
|
||||
|
||||
Les scripts utilisent cURL pour effectuer les requêtes API. Assurez-vous que l'extension cURL est activée dans votre installation PHP :
|
||||
|
||||
1. Ouvrez le fichier php.ini situé dans le répertoire où vous avez installé PHP.
|
||||
2. Vérifiez que la ligne suivante n'est pas commentée (pas de `;` au début) :
|
||||
```ini
|
||||
extension=curl
|
||||
3. Redémarrez la ligne de commande pour appliquer les modifications.
|
||||
|
||||
Si vous ne trouvez pas le fichier php.ini, vous pouvez en créer un en copiant le fichier php.ini-development ou php.ini-production fourni avec PHP, et en le renommant php.ini.
|
||||
|
||||
---
|
||||
|
||||
## Téléchargement des scripts
|
||||
|
||||
Vous pouvez télécharger directement les scripts depuis l'interface web du dépôt :
|
||||
|
||||
1. Accédez à la page principale du dépôt.
|
||||
2. Cliquer sur le fichier `.php` souhaité
|
||||
3. Cliquez sur l'icône **télécharger** en haut à droite.
|
||||
|
||||
|
||||
Exécution des scripts
|
||||
---------------------
|
||||
|
||||
1. Ouvrez une invite de commande ou un terminal dans le répertoire où les fichiers ont été extraits.
|
||||
2. bashCopier le codephp script.php
|
||||
3. Certains scripts peuvent nécessiter des paramètres. Consultez les commentaires dans les fichiers pour plus d'informations.
|
||||
|
||||
|
||||
Documentation des requêtes API
|
||||
------------------------------
|
||||
|
||||
Retrouver de la documentation sur le Rest API des Automates Eclypse sur [wiki.distech-controls.com](https://wiki.distech-controls.com).\
|
||||
Ou sur le site de Postman [postman.com/distech](https://www.postman.com/distech/).
|
||||
Reference in New Issue
Block a user