Diagnostiquer les problèmes de l’API

Diagnostiquer les problèmes de l’API

Batigest connect

Coup d’œil rapide

Etablissement du diagnostic

Que faire si le serveur ne répond pas Healthy ?

Sur le même sujet

Configurer un serveur SQL dédié

Configurer un certificat SSL

Une API (Application Programming Interface ou interface de programmation d’application) permet l’accès aux fonctionnalités ou aux données d’une application à distance. Ainsi, Sage Batigest Connect s’enrichit d’API afin d’offrir dans de futures versions des points d’accès à des applications partenaires tout en renforçant la protection des données de votre société.

Vous pouvez rencontrer depuis la version v7.0.0 des messages d’information en lien avec l’API Batigest Connect. Par exemple : Votre composant API Batigest Connect n’est pas opérationnel. Veuillez vérifier que le service correspondant est bien lancé sur votre poste principal.

Vous allez établir un diagnostic technique pour identifier les problèmes et y faire face.

Etablissement du diagnostic

Prérequis
Avant de démarrer le diagnostic technique de votre API, assurez-vous que :
. La base de données est installée sur le poste principal.
. Les postes secondaires sont connectés au poste principal.
. L’API n’est pas installée sur les postes secondaires.
. La base de données SQL n’est pas installée sur les postes secondaires.
Si cette configuration n’est pas respectée, contactez votre support.
. Les firewalls du poste principal sont correctement configurés et le port de communication vers l’API est ouvert sur votre réseau.

Activation des services API utilisés par Batigest Connect

Batigest Connect v7
Si vous êtes sur Batigest Connect v7.x, consultez l’article dédié.

Vous allez vérifier que les services API utilisés par Batigest Connect sont activés.

  1. Accédez au répertoire d’installation de Batigest Connect.

    par défaut C > sage > batigestconnect

  2. Lancez l’application ConnectionManager.exe puis cliquez sur Afficher l’état.
    Le navigateur Internet s’ouvre sur la page de statut de l’API Batigest.
    L’adresse devrait répondre correctement avec le résultat Healthy :
    {
    « status »: « Healthy »,
    « description »: « Tous les services sont opérationnels. »,
    « services »: [
    {
    « name »: « LoadingCheck »,
    « status »: « Healthy »,
    « data »: {
    « Api »: « Healthy »,
    « Key »: « Healthy »,
    « Sql »: « Healthy »
    }}]}
  3. Si la précédente étape s’est bien déroulée, refaites la manipulation depuis le poste qui a un problème pour joindre l’API.

Si le navigateur bloque la connexion car elle n’est pas sécurisée, confirmez que vous souhaitez poursuivre sur le site. En savoir plus…

Que faire si le serveur ne répond pas Healthy ?

Si le serveur ne répond pas Healthy, vérifiez que :

  • Le Pool de l’API Batigest Connect ainsi que l’API ont été démarrés.
  • L’état du service de l’API.

Vérification du démarrage du Pool de l’API Batigest Connect et de  l’API

  1. Ouvrez la boîte de dialogue Exécuter (raccourci clavier Win + R).
  2. Saisissez InetMgr.exe.
  3. Ouvrez le gestionnaire (OK).
  4. Dans le Pool d’applications, vérifiez que le Pool SageBatigestConnectAppPool est démarré ; s’il n’est pas démarré, démarrez-le.
  5. Dans le dossier Sites, vérifiez que le site SageBatigestConnectApi est démarré ; s’il n’est pas démarré, démarrez-le.

Si cette première vérification n’a pas suffi, vérifiez l’état du service de l’API.

Vérification de l’état du service de l’API

Il est possible que l’API soit démarrée mais que le site https://desktop-iunjg8b:443/healthbatigest (à adapter selon le contenu de vos fichiers) remonte des dysfonctionnements complémentaires.
Pour obtenir des informations plus précises sur l’origine du problème, connectez-vous au poste principal afin de consulter les fichiers de journalisation des traitements. Ces fichiers se trouvent par défaut dans le répertoire d’installation de l’API C:\Program Files (x86)\Sage\BatigestConnectApi\logs. Exemple de fichier BatigestApi20240703.log

Vous pourrez y trouver des informations relatives aux erreurs suivantes :

Erreur 500.x sur l’URL de test « healthbatigest »

Batigest Connect v7
Si vous êtes sur Batigest Connect v7.x, consultez l’article dédié.

Le serveur IIS identifie un problème de configuration du serveur, ceci peut provenir d’un composant dysfonctionnel ou de la configuration du serveur incorrect.

Cause possible : Il peut s’agir d’une erreur d’installation du composant Microsoft ASP.NET Core Runtime 8.0.x.

Solution 1 :
1. Depuis la liste des applications et fonctionnalités windows, réparez le composant Microsoft .Net 8.0.x – Windows Server Hosting.
2. Redémarrez le site sous IIS.

Solution 2 :
1. Téléchargez le composant d’installation Windows Hosting Bundle v8.0.x. à partir de la page https://dotnet.microsoft.com/en-us/download/dotnet/8.0
2. Redémarrez le site sous IIS.

Erreur de connexion au serveur SQL

Le site identifie un problème d’accès à la base de données. Le fichier de journalisation pourra vous indiquer de manière précise la cause.

Exemple 1
09:06:10 [FTL] Unhandled exception
Microsoft.Data.SqlClient.SqlException (0x80131904): A network-related or instance-specific error occurred while establishing a connection to SQL Server.
Cause possible : le serveur SQL n’est pas démarré.
Solution possible  : démarrer le serveur SQL.

Exemple 2
11:41:53 [DBG] Échec de la connexion pour l’utilisateur ‘IIS APPPOOL\SageBatigestConnectAppPool’. Raison : le compte est désactivé.
Cause possible  : l’utilisateur SQL n’est plus actif.
Solution possible  : réactivez l’utilisateur via SQL Management Studio.

Erreur de clé privée / clé publique

Le service identifie des problèmes pour créer ou réinitialiser des clés d’échange. Dans les fichiers de journalisation vous pouvez trouver cet exemple d’erreur :
15:28:53 [ERR] GetBytes Failed
System.Security.Cryptography.CryptographicException: Données non valides.
Cause possible : l’utilisateur Windows qui exécute le service API n’est plus le même et les clés encryptées ne sont plus valides mais ne peuvent pas être recréées.
Solution possible :
1. Arrêtez le service API Batigest Connect et le pool d’application dans IIS.
2. Supprimez les fichiers contenus dans le répertoire C:\ProgramData\Sage\APIBTGCNCT.
3. Redémarrez les services qui ont été arrêtés.

Erreur non identifiable via le site

S’il n’est toujours pas possible de joindre l’API ou le site, les fichiers de journalisation des traitements peuvent afficher l’erreur suivante : « https://desktop-iunjg8b/healthbatigest » serveur introuvable

Plusieurs causes sont possibles.

Cause possible : le service est éteint.
Solution possible  :
1. Placez-vous sur le poste principal.
2. Ouvrez IIS.
3. Démarrez le pool et le site des API Batigest Connect associés.

Cause possible : l’URL de l’API n’est plus la bonne.
Solution possible :
1. Placez-vous sur le poste principal.
2. Ouvrez IIS.
3. Vérifiez les informations du site SageBatigestConnectApi et vérifiez dans les paramètres avancés la liaison (exemple https:*:443:).
4. Vérifiez les ports de communication.
5. Vérifiez les logs.

Cause possible  : l’utilisateur Windows qui exécute le service API a été changé.
Solution possible :
1. Placez-vous sur le poste principal.
2. Ouvrez IIS.
3. Vérifiez les informations du site SageBatigestConnectApi et vérifiez dans les paramètres avancés la liaison (exemple https:*:443:).
4. Vérifiez les ports de communication.
5. Vérifiez les logs.

Cause possible : une autre machine possède le même nom sur le réseau que le poste principal.
Solution possible : assurez-vous que toutes les machines de votre réseau d’entreprise ont des noms uniques.