From 8637dcc7cb5d08739f3d67cc3ccc81c27fd81f24 Mon Sep 17 00:00:00 2001 From: Marvin Date: Fri, 20 Feb 2026 15:06:00 +0100 Subject: [PATCH] Update documentation for Logistics API usage environments - Corrected French language errors and improved clarity in the documentation_api_logistics.md file. - Updated connection details for local and remote access, including base URL formats and VPN requirements. - Enhanced the summary of differences between local and remote access scenarios for better understanding. --- documentation/documentation_api_logistics.md | 41 ++++++++------------ 1 file changed, 17 insertions(+), 24 deletions(-) diff --git a/documentation/documentation_api_logistics.md b/documentation/documentation_api_logistics.md index 3966fe7..9f48662 100644 --- a/documentation/documentation_api_logistics.md +++ b/documentation/documentation_api_logistics.md @@ -81,53 +81,46 @@ Le service `App\Services\LogisticsService` utilise ces valeurs pour configurer a ## 2. Environnements d'utilisation -L'API Logistics peut etre interrogee depuis deux environnements distincts. Selon l'environnement utilise, les parametres de connexion (URL de base, hote, ports) different. +L'API Logistics peut être interrogée depuis deux environnements distincts. Selon l'environnement utilisé, l'URL de base et les conditions d'accès diffèrent. ### 2.1 Projet local avec VPN -Dans ce scenario, le developpeur travaille sur son poste local (par exemple avec Laravel Herd) et communique avec le serveur Logistics a distance via le VPN ESI Cloud. +Dans ce scénario, le développeur travaille sur son poste local (par exemple avec Laravel Herd) et communique avec le serveur Logistics à distance via le VPN ESI Cloud. -| Element | Valeur | +| Élément | Valeur | |---------|--------| | Connexion VPN | Obligatoire (VPN vers ESI Cloud) | -| Hote | `tse-10-test.esiweb.pro` (public) ou `tse-10-test.esi.local` (reseau prive via VPN) | -| Port HTTP | 5186 | -| Port HTTPS | 7126 | -| URL de base typique | `http://tse-10-test.esi.local:5186` ou `http://tse-10-test.esiweb.pro:5186` | +| URL de base | `http://tse-10-test.esi.local` | +| Format d'URL complet | `http://tse-10-test.esi.local/{dossier}/{endpoint}` | Exemple de configuration `.env` pour un projet local : ``` -LOGISTICS_API_BASE_URL=http://tse-10-test.esi.local:5186 +LOGISTICS_API_BASE_URL=http://tse-10-test.esi.local LOGISTICS_API_KEY=votre-cle-api LOGISTICS_API_FOLDER=esigescom ``` -Le port doit etre inclus dans l'URL de base car le serveur n'ecoute pas sur les ports standard (80/443). +### 2.2 Bureau à distance (Postman) -### 2.2 Bureau a distance (Postman) +Dans ce scénario, l'utilisateur se connecte au serveur via une connexion de bureau à distance (Remote Desktop) et utilise Postman directement depuis cette session. Étant déjà sur le réseau interne, aucun VPN n'est nécessaire et le serveur est accessible directement. -Dans ce scenario, l'utilisateur se connecte au serveur via une connexion de bureau a distance (Remote Desktop) et utilise Postman directement depuis cette session. Etant deja sur le reseau interne, aucun VPN n'est necessaire et le serveur est accessible directement. - -| Element | Valeur | +| Élément | Valeur | |---------|--------| -| Connexion VPN | Non requise (connexion directe via bureau a distance) | -| Hote | `tse-10-test.esi.local` ou `localhost` (si Postman tourne sur le serveur lui-meme) | -| Port HTTP | 5186 | -| Port HTTPS | 7126 | -| URL de base typique | `http://tse-10-test.esi.local:5186` ou `http://localhost:5186` | +| Connexion VPN | Non requise (connexion directe via bureau à distance) | +| URL de base | `http://tse-10-test.esiweb.pro` | +| Format d'URL complet | `http://tse-10-test.esiweb.pro/{dossier}/{endpoint}` | -Pour obtenir un acces au bureau a distance et a l'application Logistics, contactez **Claudi Dewandre**. +Pour obtenir un accès au bureau à distance et à l'application Logistics, contactez **Claudi Dewandre**. -### 2.3 Recapitulatif des differences +### 2.3 Récapitulatif des différences -| Critere | Projet local (VPN) | Bureau a distance (Postman) | +| Critère | Projet local (VPN) | Bureau à distance (Postman) | |---------|--------------------|-----------------------------| | VPN ESI Cloud | Obligatoire | Non requis | | Outil | Application Laravel, cURL, Postman local | Postman sur le serveur distant | -| Hote | `tse-10-test.esiweb.pro` ou `tse-10-test.esi.local` | `tse-10-test.esi.local` ou `localhost` | -| Port dans l'URL | Oui (5186 ou 7126) | Oui (5186 ou 7126) | -| Acces requis | Identifiants VPN + cle API | Acces bureau a distance + acces Logistics (contacter Claudi Dewandre) + cle API | +| URL de base | `http://tse-10-test.esi.local` | `http://tse-10-test.esiweb.pro` | +| Accès requis | Identifiants VPN + clé API | Accès bureau à distance + accès Logistics (contacter Claudi Dewandre) + clé API | ---