Aller au contenu principal

API Synchronisation

L'API Synchronisation permet de gérer la synchronisation des données référentiel et de surveiller le statut des synchronisations.

Déclencher la synchronisation référentiel​

  • URL : /api/sync/referentiel
  • Méthode : POST
  • Description : Déclencher la synchronisation des produits référentiel

Réponse​

{
  "message": "Synchronisation déclenchée avec succès"
}

Obtenir le statut de synchronisation​

  • URL : /api/sync/status
  • Méthode : GET
  • Description : Obtenir le statut de la dernière synchronisation

Réponse​

{
  "lastSyncAt": "2024-01-15T10:30:00Z",
  "status": "success",
  "productsCount": 1500,
  "duration": 45000,
  "errorMessage": null
}

Obtenir la dernière mise à jour des produits​

  • URL : /api/sync/last-update
  • Méthode : GET
  • Description : Obtenir l'horodatage de la dernière synchronisation des produits

Réponse​

{
  "lastUpdate": "2024-01-15T10:30:00Z"
}

Statuts de synchronisation​

Les statuts possibles pour une synchronisation sont :

  • success : Synchronisation réussie
  • error : Erreur lors de la synchronisation
  • in_progress : Synchronisation en cours

Codes d'erreur possibles​

  • 500 Internal Server Error : Erreur lors du déclenchement de la synchronisation
  • 503 Service Unavailable : Service de synchronisation temporairement indisponible

Notes importantes​

  • La synchronisation référentiel peut prendre plusieurs minutes selon la quantité de données
  • Il est recommandé de vérifier le statut avant de déclencher une nouvelle synchronisation
  • Les logs de synchronisation sont conservés dans la base de données pour audit