🌐 Description des webservices¶
Présentation¶
Maarch Courrier met à disposition une API REST permettant d'intégrer ses principales fonctionnalités dans une application tierce : gestion des courriers, des pièces jointes, des contacts, des utilisateurs et des référentiels.
Chaque page de cette section présente les routes disponibles, leurs paramètres, les droits nécessaires ainsi que les réponses attendues.
Domaines documentaires¶
| Domaine | Contenu |
|---|---|
| Administration | Configurations, référentiels techniques, notifications et historiques |
| Authentification | Authentification et règles de mot de passe |
| Contacts | Contacts, civilités, groupes et champs personnalisés |
| Courriers | Courriers, suivi, pièces jointes, notes, bannettes et échanges |
| Classement et recherche | Dossiers, recherche et types de courrier |
| Connecteurs | Connecteurs d'interopérabilité, d'édition, de capture et d'archivage |
| Circuits et parapheurs | Circuits de visa et parapheurs |
| Organisation | Entités, groupes, privilèges, utilisateurs et jetons API |
| Divers | Routes techniques ne relevant pas d’un domaine métier |
URL de base¶
Les routes sont accessibles depuis le point d'entrée suivant :
Par exemple, la route /rest/resources est appelée avec l'URL :
Lecture des privilèges¶
Les pages indiquent l'identifiant technique du privilège sous la forme d'un lien vers la correspondance complète des privilèges. Cette référence centralise le libellé visible dans Administration > Groupes > Privilèges, le terme technique utilisé par l'API et une description concise.
Authentification¶
Sauf indication contraire dans la documentation d'une route, les requêtes doivent être authentifiées. Deux méthodes sont disponibles.
Identifiant et mot de passe¶
L'identifiant et le mot de passe peuvent être transmis avec l'authentification HTTP Basic. Par exemple, avec curl :
Cette commande construit automatiquement l'en-tête Authorization: Basic. La syntaxe suivante est également prise en charge, mais elle est déconseillée, car les identifiants peuvent apparaître dans l'historique ou les journaux :
Jeton API¶
Pour un compte WebService, le jeton API peut être transmis dans l'en-tête HTTP :
Consultez la page Jetons API pour connaître les conditions d'utilisation, de création et de révocation d'un jeton.
Disponibilité pendant une migration¶
Pendant une migration applicative, l'accès à l'API et à l'interface utilisateur est temporairement restreint. Consultez la logique du système de mise à jour pour connaître les routes qui restent accessibles, la réponse 503 et le comportement de l'interface.