mpa/logisticsAPI
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation for Logistics API usage environments

Browse Source 
- 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.
This commit is contained in:
Marvin
2026-02-20 15:06:00 +01:00
parent 4b2f172e2a
commit 8637dcc7cb
1 changed files with 17 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
documentation/documentation_api_logistics.md
View File

@@ -81,53 +81,46 @@ Le service `App\Services\LogisticsService` utilise ces valeurs pour configurer a
## 2. Environnements d'utilisation ## 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 ### 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) | | Connexion VPN | Obligatoire (VPN vers ESI Cloud) |
| Hote | `tse-10-test.esiweb.pro` (public) ou `tse-10-test.esi.local` (reseau prive via VPN) | | URL de base | `http://tse-10-test.esi.local` |
| Port HTTP | 5186 | | Format d'URL complet | `http://tse-10-test.esi.local/{dossier}/{endpoint}` |
| Port HTTPS | 7126 |
| URL de base typique | `http://tse-10-test.esi.local:5186` ou `http://tse-10-test.esiweb.pro:5186` |
Exemple de configuration `.env` pour un projet local : 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_KEY=votre-cle-api
LOGISTICS_API_FOLDER=esigescom 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. | Élément | Valeur |
| Element | Valeur |
|---------|--------| |---------|--------|
| Connexion VPN | Non requise (connexion directe via bureau a distance) | | Connexion VPN | Non requise (connexion directe via bureau à distance) |
| Hote | `tse-10-test.esi.local` ou `localhost` (si Postman tourne sur le serveur lui-meme) | | URL de base | `http://tse-10-test.esiweb.pro` |
| Port HTTP | 5186 | | Format d'URL complet | `http://tse-10-test.esiweb.pro/{dossier}/{endpoint}` |
| Port HTTPS | 7126 |
| URL de base typique | `http://tse-10-test.esi.local:5186` ou `http://localhost:5186` |
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 | | VPN ESI Cloud | Obligatoire | Non requis |
| Outil | Application Laravel, cURL, Postman local | Postman sur le serveur distant | | 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` | | URL de base | `http://tse-10-test.esi.local` | `http://tse-10-test.esiweb.pro` |
| Port dans l'URL | Oui (5186 ou 7126) | Oui (5186 ou 7126) | | Accès requis | Identifiants VPN + clé API | Accès bureau à distance + accès Logistics (contacter Claudi Dewandre) + clé API |
| Acces requis | Identifiants VPN + cle API | Acces bureau a distance + acces Logistics (contacter Claudi Dewandre) + cle API |
--- ---