# Termes et conventions communs utilisés
LâĂ©quipe de lâArchitecture de RĂ©fĂ©rence a utilisĂ© des termes et conventions communs tout au long de la conception et la documentation du modĂšle dâArchitecture de RĂ©fĂ©rence Mojaloop 2.0.
Veuillez utiliser cette liste pour vous familiariser avec des termes qui pourraient vous sembler inconnus ou oubliĂ©s. La liste contient Ă©galement des rĂ©fĂ©rences Ă des articles et documents tiers disponibles dans la section âPour aller plus loinâ de ce document.
| Convention/Terme | Description |
|---|---|
| Acteurs | Participant humain ou systĂšme externe Ă un Cas dâUtilisation. Tous les Cas dâUtilisation sont initiĂ©s par des Acteurs. |
| BC | Bounded ContextâŻ: Un Contexte BornĂ© est un composant du Design-Driven Development et contient gĂ©nĂ©ralement un ou plusieurs sous-domaines. Les Contextes BornĂ©s sont des entitĂ©s de lâEspace Solution (Solution Space), et contiennent une solution unique applicable Ă un ou plusieurs sous-domaines. (Pour plus dâinformations, voir : Vue dâensemble de lâArchitecture inspirĂ©e du DDD dans lâaperçu de lâEspace Solution, ou notre section Pour aller plus loin : Articles et Documents de RĂ©fĂ©rence) |
| UC | Cas dâUtilisation: Liste dâactions ou dâĂ©tapes dĂ©crivant les interactions entre un Acteur (humain ou systĂšme externe) et un systĂšme pour atteindre un objectif particulier. Un exemple dans Mojaloop seraitâŻ: âEffectuer un transfert avec confirmation du bĂ©nĂ©ficiaireâ. (Pour plus dâinformations, voir lâarticle WikipĂ©dia âUse Caseâ citĂ© dans la section Pour aller plus loin : Articles et Documents de RĂ©fĂ©rence de ce document) |
| Sync | Communications synchrones, unidirectionnelles ou bidirectionnelles, faisant partie du processus initial. ReprĂ©sentĂ©es par une ligne pleine dans les schĂ©mas UC. UtilisĂ©es gĂ©nĂ©ralement pour les Messages devant impĂ©rativement figurer dans le workflow dâun UC pour assurer son exĂ©cution correcte. ExempleâŻ: une messagerie synchrone du BC Transferts vers le BC Gestion du Cycle de Vie des Participants pour obtenir des donnĂ©es Participant non prĂ©sentes en cache lors dâune demande de transfert. |
| Async | Communications asynchrones, unidirectionnelles ou bidirectionnelles, ne faisant pas partie du processus initial. SignalĂ©es par une ligne pointillĂ©e dans les schĂ©mas UC. UtilisĂ©es principalement pour les ĂvĂ©nements qui signalent quâune action a eu lieuâŻ: câest immuable et ne changera pas, comme les rapports de rappel (callback). |
| POST | UtilisĂ© pour crĂ©er de nouvelles ressources. Plus prĂ©cisĂ©ment, pour crĂ©er des ressources subordonnĂ©es Ă une autre (ex. ressource âparentâ). En d'autres termes (IOW), lors de la crĂ©ation d'une nouvelle ressource, on fait un POST sur le parent, le service lâassocie au parent, lui attribue un identifiant (URI de la nouvelle ressource), etc. En cas de succĂšs, le systĂšme renvoie un en-tĂȘte Location avec le lien de la ressource créée (HTTP 201). (Pour plus dâinformations, voir la rĂ©fĂ©rence âRestful API Tutorâ dans la section Pour aller plus loin : Articles et Documents de RĂ©fĂ©rence de ce document) |
| GET | UtilisĂ© pour lire (ou rĂ©cupĂ©rer) la reprĂ©sentation dâune ressource. En cas de succĂšs ânormalâ, GET retourne une reprĂ©sentation XML ou JSON et le code de rĂ©ponse HTTP 200 (OK). En cas dâerreur, renvoie gĂ©nĂ©ralement un 404 (NOT FOUND) ou un 400 (BAD REQUEST). (Pour plus dâinformations, voir la rĂ©fĂ©rence âRestful API Tutorâ dans la section Pour aller plus loin : Articles et Documents de RĂ©fĂ©rence de ce document) |
| PUT | UtilisĂ© pour mettre Ă jour une ressource connue, en effectuant un PUT sur l'URI d'une ressource connue avec le corps de requĂȘte contenant la reprĂ©sentation nouvellement mise Ă jour de la ressource d'origine. Dans certains cas, PUT peut Ă©galement servir Ă crĂ©er de nouvelles ressources, mais en raison de la complexitĂ©, ce n'est pas recommandĂ© (il faut utiliser POST Ă la place). (Pour plus dâinformations, voir la rĂ©fĂ©rence âRestful API Tutorâ dans la section Pour aller plus loin : Articles et Documents de RĂ©fĂ©rence de ce document) |
| 200 (OK) | Code HTTP indiquant âSuccĂšsâ. La requĂȘte a abouti. Lâinformation retournĂ©e avec le code de statut dĂ©pend gĂ©nĂ©ralement de la mĂ©thode employĂ©e dans la requĂȘteâŻ: pour POST, la rĂ©ponse dĂ©crit le rĂ©sultatâŻ; pour GET, la ressource demandĂ©eâŻ; pour PUT, une rĂ©ponse similaire Ă POST. (Pour plus dâinformations, voir la rĂ©fĂ©rence âRestful API Tutorâ dans la section Pour aller plus loin : Articles et Documents de RĂ©fĂ©rence de ce document) |
| 201 (Created) | Code HTTP indiquant âCrééâ ou âtraitĂ©eâ. La ressource demandĂ©e a Ă©tĂ© créée, consultable via lâURI renvoyĂ©e dans la rĂ©ponse. Si la ressource ne peut ĂȘtre créée immĂ©diatement, le serveur retourne un 202 (Accepted). (Pour plus dâinformations, voir la rĂ©fĂ©rence âRestful API Tutorâ dans la section Pour aller plus loin : Articles et Documents de RĂ©fĂ©rence de ce document) |
| 202 (Accepted) | Code HTTP indiquant que la requĂȘte a Ă©tĂ© acceptĂ©e pour traitement, mais nâest pas terminĂ©e. Elle peut ou non ĂȘtre traitĂ©e selon lâĂ©tat du systĂšme. LâopĂ©ration Ă©tant asynchrone, il nây a pas non plus de mĂ©canisme pour renvoyer le code de statut quelle que soit lâissue de lâopĂ©ration. La rĂ©ponse 202 est dĂ©libĂ©rĂ©ment non-engageante pour permettre Ă une requĂȘte dâĂȘtre traitĂ©e sans exiger que lâagent reste connectĂ© jusquâĂ ce quâelle le soit. La rĂ©ponse doit donner un Ă©tat du systĂšme, Ă©ventuellement un lien vers une plateforme de suivi ou une estimation du moment dâexĂ©cution. (Pour plus dâinformations, voir la rĂ©fĂ©rence âRestful API Tutorâ dans la section Pour aller plus loin : Articles et Documents de RĂ©fĂ©rence de ce document) |
| OHS | Open Host ServiceâŻ: Documentation des mĂ©thodes Ă utiliser pour intĂ©grer des systĂšmes aval Ă une plateforme amont existante sans nĂ©cessiter de modifications. Apporte gĂ©nĂ©ralement le support de multiples types de clients, sans se focaliser sur aucunâŻ: câest au systĂšme aval de comprendre la documentation publiĂ©e par lâamont. OHS et PL sont couramment associĂ©s par les plateformes amont. Actuellement utilisĂ© dans les entitĂ©s suivantesâŻ: API externe FSPIOP, API externe ISO, Notifications & Alertes BC, API externe PISP ML, API externe PISP ISO, Scheduling BC, Transfers & Transactions BC, Quoting BC, Accounts & Balances BC, Settlements BC, Gestion du Cycle de Vie du Participant, Account Lookup & Discovery BC. (Pour plus dâinformations, voir la rĂ©fĂ©rence âStrategic Domain-Driven Designâ dans la section Pour aller plus loin : Articles et Documents de RĂ©fĂ©rence de ce document) |
| PL | Published LanguageâŻ: Proche parent de lâOpen Host Service et souvent utilisĂ© conjointement. PL utilise un langage documentĂ©, par exemple XML, pour les opĂ©rations dâentrĂ©e/sortie de base pour lesquelles il est utilisĂ©. Aucun environnement ou bibliothĂšque spĂ©cifique nâest requis, tant que le langage publiĂ© est respectĂ©. Le Published Language nâest pas exclusif aux web servicesâŻ: on peut par exemple dĂ©poser un fichier dans un dossier, dĂ©clenchant ainsi une opĂ©ration qui le stocke Ă un emplacement spĂ©cifiĂ© par l'application. Actuellement utilisĂ© dans les entitĂ©s suivantesâŻ: API externe FSPIOPâŻ; API externe ISO. (Pour plus dâinformations, voir la rĂ©fĂ©rence âStrategic Domain-Driven Designâ dans la section Pour aller plus loin : Articles et Documents de RĂ©fĂ©rence de ce document)) |
