Giters

Mhivelin / passerelle_deltic

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Documentation de l’application Passerelle DELTIC

❗ Cette documentation est destinée aux administrateurs de l’application passerelle DELTIC

Général

Introduction

Bienvenue dans la documentation utilisateur de la plateforme de la passerelle DELTIC. Cette plateforme permet de gérer les passerelles entre les solutions utilisées par l'entreprise DELTIC.

🥅 Objectifs de l'application

L’application as pour but de gérer les liens entre les logiciels des clients de la société DELTIC

💡 GitHub : [ici](https://github.com/Mhivelin/passerelle_deltic)

⚙️ Installation

  1. Se connecter sur l’invite de commande du serveur (cf : 👀)

  2. Cloner le dépôt :

    git clone https://github.com/Mhivelin/passerelle_deltic

  3. Changer de répertoire courant pour aller dans le dépôt :

    cd passerelle_deltic

  4. Créer un fichier .env ✏️

    nano app/.env

    Avec les valeurs suivantes :

    🚨 Remplacer les valeurs temporaires par les bonnes informations puis sauvegarder (ctrl + s) puis fermer (ctrl + x)

    ADMIN_USERNAME=nomadmin
ADMIN_PASSWORD=motdepasseadmin
SECRET_KEY=cléesecurisée
JWT_SECRET_KEY=cléesecurisée
IP=adresseipdelhote
    💡 comment trouver l’adresse IP ? `ip a`

  5. Lancer le container docker

    sudo docker compose up -d

Voila votre application est lancée ✅ vous pouvez la retrouver sur le port 5000 de votre serveur.

  • en cas de problème, défilez ce menu ou vérifiez si une solution n’est pas apporté dans Problèmes Courants et Solutions

    1. Mise à Jour du Système

    Avant d'installer des logiciels, il est important de mettre à jour les paquets de votre système Debian.

    bashCopy code
sudo apt update
sudo apt upgrade -y

    2. Installation de Git

    Git est nécessaire pour cloner le dépôt du projet.

    bashCopy code
sudo apt install git -y

    3. Installation de Docker

    Docker est utilisé pour exécuter l'application dans un container.

    Installation des prérequis

    bashCopy code
sudo apt install apt-transport-https ca-certificates curl gnupg lsb-release -y

    Ajout de la clé GPG de Docker

    bashCopy code
curl -fsSL https://download.docker.com/linux/debian/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg

    Ajout du dépôt Docker

    bashCopy code
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

    Installation de Docker Engine

    bashCopy code
sudo apt update
sudo apt install docker-ce docker-ce-cli containerd.io -y

    Vérification de l'installation de Docker

    bashCopy code
sudo docker run hello-world

    4. Installation de Docker Compose

    Docker Compose est utilisé pour gérer les services de l'application.

    bashCopy code
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

    Vérification de l'installation de Docker Compose

    bashCopy code
docker-compose --version

    5. Clonage du Dépôt du Projet

    Clonez le dépôt contenant le code source de l'application.

    bashCopy code
git clone https://github.com/Mhivelin/passerelle_deltic
cd passerelle_deltic

    6. Configuration des Variables d'Environnement

    Créez un fichier .env avec les variables nécessaires.

    bashCopy code
nano app/.env

    Ajoutez les valeurs suivantes dans le fichier .env :

    bashCopy code
ADMIN_USERNAME=nomadmin
ADMIN_PASSWORD=motdepasseadmin
SECRET_KEY=cléesecurisée
JWT_SECRET_KEY=cléesecurisée
IP=adresseipdelhote

    Sauvegardez (Ctrl + S) et fermez (Ctrl + X) l'éditeur.

    7. Lancement de l'Application

    Utilisez Docker Compose pour lancer l'application.

    bashCopy code
docker-compose up -d

    Voilà, votre application est maintenant configurée et en cours d'exécution sur une machine Debian. Vous pouvez accéder à l'application via l'adresse IP spécifiée.

🚨 Problèmes Courants et Solutions

🚨 Problèmes Courants et Solutions

⌨️ Utilisation du serveur DELTIC

💡 Comment se connecter au serveur OVH ?

  1. Obtenir les Informations de Connexion 🔐

    Vous aurez besoin des informations suivantes pour vous connecter au serveur Debian :

    • L'adresse IP : vps-43199aa1.vps.ovh.net
    • Le nom d'utilisateur : debian
    • Le mot de passe de l'utilisateur ou la clé SSH privée si vous utilisez l'authentification par clé publique. disponible sur LastPass

  2. Installer un Client SSH 🧑‍💻

    Sur Windows

    • Vous pouvez utiliser PuTTY, un client SSH populaire pour Windows.
    • Téléchargez PuTTY depuis le site officiel.
    • Installez PuTTY en suivant les instructions d'installation.

  3. Se connecter au la VM 🔌

    1. Ouvrez PuTTY.
    2. Dans Host Name (or IP address) entrer debian@vps-43199aa1.vps.ovh.net
    3. cliquer sur open (puis sur Accept seulement pour la première utilisation)
    4. entrer le mot de passe (trouvé sur LastPass) 🚨 Attention, pour des raison de sécurité, les caractères tapé ne s’affichent pas 🚨
Catégorie Commande Description
Mise à jour du système sudo apt update Met à jour la liste des paquets disponibles
sudo apt upgrade -y Installe les mises à jour des paquets déjà installés
Gestion des paquets sudo apt install -y Installe un paquet spécifié
sudo apt remove -y Supprime un paquet spécifié
dpkg -i <package.deb> Installe un paquet .deb téléchargé manuellement
Gestion des services sudo systemctl start Démarre un service
sudo systemctl stop Arrête un service
sudo systemctl restart Redémarre un service
sudo systemctl status Affiche l'état d'un service
sudo systemctl enable Active un service pour qu'il démarre au démarrage du système
Gestion des utilisateurs sudo adduser Ajoute un nouvel utilisateur
sudo deluser Supprime un utilisateur
sudo passwd Change le mot de passe d'un utilisateur
sudo usermod -aG Ajoute un utilisateur à un groupe
Gestion des fichiers ls Liste les fichiers et répertoires dans le répertoire courant
cd Change de répertoire
cp Copie des fichiers ou répertoires
mv Déplace ou renomme des fichiers ou répertoires
rm Supprime un fichier
rm -r Supprime un répertoire et son contenu
Gestion des processus ps aux Affiche les processus en cours d'exécution
htop Version améliorée de top (nécessite l'installation : sudo apt install htop -y)
kill Termine un processus en utilisant son ID de processus
Réseau ifconfig Affiche les configurations réseau
ping Envoie des paquets ICMP ECHO_REQUEST à un hôte
wget Télécharge des fichiers depuis le web
ssh @ Se connecte à un hôte distant via SSH
Docker sudo systemctl start docker Démarre le service Docker
sudo systemctl stop docker Arrête le service Docker
sudo systemctl enable docker Active Docker au démarrage du système
docker build -t . Construit une image Docker à partir d'un Dockerfile
docker run -d -p <host_port>:<container_port> --name Exécute un container en arrière-plan
docker ps Affiche les containers Docker en cours d'exécution (avec container_id)
docker run -d -p <host_port>:<container_port> --name Exécute un container en arrière-plan
docker ps Affiche les containers Docker en cours d'exécution
docker stop <container_id> Arrête un container Docker
docker rm <container_id> Supprime un container Docker
docker-compose up -d Démarre les services définis dans un fichier docker-compose.yml
docker-compose down Arrête et supprime les containers définis dans un fichier docker-compose.yml
docker logs <container_id> Affiche les logs d'un container Docker
Git git clone <repository_url> Clone un dépôt Git vers le répertoire courant
git status Affiche l'état des modifications dans le dépôt

Utilisation de base

Ajout d’administrateur :

  1. Se rendre dans les paramètres en haut a droite ⚙️
  2. Cliquer sur Ajouter un utilisateur dans Gestion des utilisateurs ➕
  3. Entrer le nouveau nom d’utilisateur et le mot de passe 🖍️
  4. Se reconnecter a l’application (avec l’ancien ou le nouvel utilisateur) 🔓

Connection d’une nouvelle passerelle

🧑‍💻 Les logiciels

📄 Zeendoc

Nom ❔Comment l’obtenir ?
Zeendoc_Login
Zeendoc_URL_Client
Zeendoc_CPassword
Zeendoc_CLASSEUR

💵 EBP

Nom ❔Comment l’obtenir ?
Client ID Option 1 : Obtenu par le client lors de la mise en place de son logiciel EBP
Option 2 : Demander a l’intégrateur
Client Secret Option 1 : Obtenu par le client lors de la mise en place de son logiciel EBP
Option 2 : Demander a l’intégrateur
Subscription Key Disponible sur le lien suivant : https://developpeurs.ebp.com/profile
Se connecter avec le compte du client
identifiants de connexion
(mail + mot de passe) Option 1 : Le client fournis ces identifiants
Option 2 : le client participe à l’installation

☁️ Sellsy

Nom ❔Comment l’obtenir ?

Sellsy Client ID

Sellsy Client Secret | 1. 👀 Se rendre sur https://www.sellsy.com/developer/api-v2 2. ➕ Créer un nouvel accès API de type Personnel (le nom de l’accès n’impactera pas la suite). 3. ❌ Ne pas cocher l’accès délégué. 4. ✅ laisser toutes les autorisation cochée 5. 🛟 Enregistrer. 🚨Attention, les information qui s’affiche maintenant ne seront plus visible par la suite donc penser a bien les enregistrer dans LastPass par exemple🚨 |

🤖 Les passerelles

💸 passerelle remontée de paiement Sellsy --> Zeendoc

Il existe deux version de cette Passerelle, la version Date qui remonte la date 📆 du dernier paiement et la version statut qui remonte simplement l’information de paiement ✅

Prérequis

💡 pour ajouter un client a la passerelle, vous aurez besoin de quelques informations au préalable.

⚙️ Configuration d’un nouveau client

  1. Cliquer sur “Ajouter un client” pour se rendre sur la page d’ajout d’un client.
  2. Entrer le nom du client et valider en cliquant sur ajouter.
  3. Sur la page d’accueil, cliquer sur détail puis sur “connecter une passerelle”.
  4. choisir la passerelle “remontée de paiement” et cliquer sur ajouter.
  5. Sur la page d’accueil, cliquer sur détail puis sur "Ajouter/modifier des champs requis”.
  6. remplir les champs EBP_Client_ID EBP_Client_Secret EBP_Subscription_Key Zeendoc_Login Zeendoc_URL_Client Zeendoc_CPassword puis cliquer sur ajouter.
  7. retourner sur “Ajouter/modifier des champs requis” et cliquer sur “Se connecter à EBP : Connexion”
  8. Apres la redirection :
    • OPTION 1 : Page de connexion d’ebp : se connecter avec les identifiants de connexion du client
    • OPTION 2 : Page d’erreur 404 : les information renseigné dans EBP_Client_ID ou EBP_Client_Secret ou EBP_Subscription_Key sont erronée.
    • OPTION 3 : connexion au mauvais compte : en cas de connexion automatique a un autre compte EBP, refaire la manip en navigation privée
  9. retourner sur “Ajouter/modifier des champs requis” et sélectionner Dossier EBP Classeur Zeendoc INDEX_STATUT_PAIEMENT et INDEX_NUM_PIECE puis ajouter.
  10. Vérifier le bon fonctionnement sur le logiciel zeendoc
  11. Bravo 😀 !!

🖍️ Schéma explicatif

sequenceDiagram
    participant Passerelle
    participant EBP
    participant Zeendoc

    Passerelle->>EBP: Se connecter à l'API EBP
    EBP-->>Passerelle: Authentification réussie
    Passerelle->>EBP: Récupérer les documents payés
    EBP-->>Passerelle: Document payé
    Passerelle->>Zeendoc: Se connecter à l'API Zeendoc
    Zeendoc-->>Passerelle: Authentification réussie
    loop Pour chaque document payé
        Passerelle->>Zeendoc: Rechercher le document par référence
        Zeendoc-->>Passerelle: Détails du document
        Passerelle->>Zeendoc: Mettre à jour l'index de paiement à "payé"
        Zeendoc-->>Passerelle: Confirmation de mise à jour
    end
Loading

👤Passerelle remontée de fournisseur

Passerelle remontée de paiement Sellsy —> Zeendoc

sequenceDiagram
    participant Passerelle
    participant Sellsy
    participant Zeendoc

    Passerelle->>Sellsy: Se connecter à l'API Sellsy
    Sellsy-->>Passerelle: Authentification réussie
    Passerelle->>Sellsy: Récupérer les documents payés
    Sellsy-->>Passerelle: Document payé
    loop Pour chaque document payé
		    Passerelle->>Sellsy: Récuperer les information de paiement
		    Sellsy-->>Passerelle: information de paiement
		    Passerelle->>Zeendoc: Se connecter à l'API Zeendoc
		    Zeendoc-->>Passerelle: Authentification réussie

        Passerelle->>Zeendoc: Rechercher le document par référence facture
        Zeendoc-->>Passerelle: Détails du document
        Passerelle->>Zeendoc: Mettre à jour l'index de paiement à la date récuperée
        Zeendoc-->>Passerelle: Confirmation de mise à jour
    end
Loading

Models

Points de terminaison (1)

🔌 Points de terminaison

💡 les points de terminaison sont les url utilisé par l’application pour faire les appels aux APIs et à la base de donnée DEF :

Points de terminaison

Base de donnée

classDiagram
    class CLIENT {
        INTEGER idClient
        TEXT Username
        PRIMARY KEY(idClient)
    }

    class LOGICIEL {
        INTEGER IdLogiciel
        TEXT LibLogiciel
        PRIMARY KEY(IdLogiciel)
    }

    class PASSERELLE {
        INTEGER IdPasserelle
        TEXT LibPasserelle
        PRIMARY KEY(IdPasserelle)
    }

    class CHAMPS {
        INTEGER IdChamp
        TEXT lib_champ
        TEXT nomTable
        INTEGER IdPasserelle
        INTEGER IdLogiciel
        PRIMARY KEY(IdChamp)
        FOREIGN KEY(IdPasserelle) REFERENCES PASSERELLE(IdPasserelle)
        FOREIGN KEY(IdLogiciel) REFERENCES LOGICIEL(IdLogiciel)
    }

    class PASSERELLE_CLIENT {
        INTEGER IdPasserelleClient
        INTEGER IdPasserelle
        INTEGER idClient
        PRIMARY KEY(IdPasserelleClient)
        FOREIGN KEY(IdPasserelle) REFERENCES PASSERELLE(IdPasserelle)
        FOREIGN KEY(idClient) REFERENCES CLIENT(idClient)
    }

    class CONNECT_LOGICIEL {
        INTEGER IdLogiciel
        INTEGER IdPasserelle
        NUMERIC IsSource
        PRIMARY KEY(IdLogiciel, IdPasserelle)
        FOREIGN KEY(IdLogiciel) REFERENCES LOGICIEL(IdLogiciel)
        FOREIGN KEY(IdPasserelle) REFERENCES PASSERELLE(IdPasserelle)
    }

    class CHAMP_PASSERELLE {
        INTEGER IdChamp
        INTEGER IdPasserelleClient
        TEXT Valeur
        PRIMARY KEY(IdChamp, IdPasserelleClient)
        FOREIGN KEY(IdChamp) REFERENCES CHAMPS(IdChamp)
        FOREIGN KEY(IdPasserelleClient) REFERENCES PASSERELLE_CLIENT(IdPasserelleClient)
    }

    CLIENT --> PASSERELLE_CLIENT : idClient
    LOGICIEL --> CHAMPS : IdLogiciel
    PASSERELLE --> CHAMPS : IdPasserelle
    PASSERELLE --> PASSERELLE_CLIENT : IdPasserelle
    LOGICIEL --> CONNECT_LOGICIEL : IdLogiciel
    PASSERELLE --> CONNECT_LOGICIEL : IdPasserelle
    CHAMPS --> CHAMP_PASSERELLE : IdChamp
    PASSERELLE_CLIENT --> CHAMP_PASSERELLE : IdPasserelleClient
Loading

About

Languages

Language:Python 78.1%Language:HTML 21.2%Language:Dockerfile 0.5%Language:CSS 0.1%Language:Shell 0.1%