Aller au contenu

🌐 Description des webservices

đŸ§© Frontal REST dĂ©diĂ©

Les webservices de Maarch Courrier sont accessibles via un point d’entrĂ©e unique :

http://login:password@domain/rest/

Structure de l’URL

ÉlĂ©ment Description
login Identifiant d’accùs utilisateur
password Mot de passe associé
domain Nom de domaine ou IP du serveur Maarch Courrier

Exemple :

https://cchaplin:maarch@demo.maarchcourrier.com/rest/

🔐 Il est recommandĂ© d’utiliser HTTPS et d’éviter l’envoi d’identifiants en clair dans l’URL (prĂ©fĂ©rer les headers Authorization).


🚧 Comportement pendant une migration

Pendant une opération de migration applicative, tous les webservices sont indisponibles sauf les trois suivants :

  • GET /rest/langues
  • GET /rest/authenticationInformations
  • GET /rest/images

Les autres endpoints renverront une erreur 503 — Service Unavailable.


Exemple d’erreur pendant une migration

Endpoint

GET /rest/baskets

Réponse

Code HTTP Type Description Exemple
503 object Service indisponible (migration en cours) ci-dessous
{
  "errors": "Service unavailable : migration in progress.",
  "lang": "migrationProcessing",
  "migrating": true
}

🔄 Impact utilisateur

  • L’utilisateur est automatiquement dĂ©connectĂ© pendant la migration.

  • Un message d’information est affichĂ© dans l’interface :

Message de migration

  • L’application redevient disponible Ă  la fin du processus, aprĂšs quoi l’utilisateur doit se reconnecter.