Aller au contenu principal

API Intercom

L'API Intercom permet de surveiller la santé et le statut de tous les microservices de l'écosystème UBSI.

Obtenir les rapports pour toutes les applications​

  • URL : /api/intercom/reports
  • Méthode : GET
  • Description : Obtenir les derniers rapports pour toutes les applications

Réponse​

{
  "achat": {
    "status": "healthy",
    "lastCheck": "2024-01-15T10:30:00Z",
    "responseTime": 150
  },
  "gestion": {
    "status": "healthy",
    "lastCheck": "2024-01-15T10:30:00Z",
    "responseTime": 200
  },
  "referentiel": {
    "status": "healthy",
    "lastCheck": "2024-01-15T10:30:00Z",
    "responseTime": 180
  }
}

Obtenir le rapport pour une application spécifique​

  • URL : /api/intercom/reports/{app}
  • Méthode : GET
  • Description : Obtenir le dernier rapport pour une application spécifique

Paramètres de chemin​

  • app : Nom de l'application (un de : achat, bi, ecommerce, fidelite, gestion, logistique, paiement, promotion, referentiel, sav)

Réponse​

{
  "status": "healthy",
  "lastCheck": "2024-01-15T10:30:00Z",
  "responseTime": 150,
  "details": "Tous les systèmes opérationnels"
}

Ping toutes les applications​

  • URL : /api/intercom/now
  • Méthode : GET
  • Description : Ping toutes les applications pour le statut actuel

Réponse​

{
  "achat": {
    "status": "online",
    "timestamp": "2024-01-15T10:30:00Z",
    "responseTime": 50
  },
  "gestion": {
    "status": "online",
    "timestamp": "2024-01-15T10:30:00Z",
    "responseTime": 75
  },
  "referentiel": {
    "status": "online",
    "timestamp": "2024-01-15T10:30:00Z",
    "responseTime": 60
  }
}

Ping une application spécifique​

  • URL : /api/intercom/now/{app}
  • Méthode : GET
  • Description : Ping une application spécifique pour le statut actuel

Paramètres de chemin​

  • app : Nom de l'application

Réponse​

{
  "status": "online",
  "timestamp": "2024-01-15T10:30:00Z",
  "responseTime": 50,
  "details": "Service répondant normalement"
}

Applications surveillées​

Les applications suivantes sont surveillées par l'API Intercom :

  • achat : Service d'achat
  • bi : Business Intelligence
  • ecommerce : E-commerce
  • fidelite : Programme de fidélité
  • gestion : Gestion des stocks et commandes
  • logistique : Logistique et livraison
  • paiement : Système de paiement
  • promotion : Gestion des promotions
  • referentiel : Référentiel des produits
  • sav : Service après-vente

Statuts possibles​

  • healthy : Service en bonne santé
  • unhealthy : Service en panne ou dégradé
  • online : Service accessible
  • offline : Service inaccessible
  • timeout : Timeout lors de la vérification

Codes d'erreur possibles​

  • 404 Not Found : Application non trouvée
  • 500 Internal Server Error : Erreur lors de la vérification du statut
  • 503 Service Unavailable : Service Intercom temporairement indisponible

Notes importantes​

  • Les vérifications sont effectuées en temps réel
  • Les temps de réponse sont exprimés en millisecondes
  • En cas d'erreur, le champ details contient des informations supplémentaires