Commit 82bfe21e authored by Julien Fastré's avatar Julien Fastré

[specs immoware-chill] modification + nouvelles captures d'éran

parent 72e6d4f4
Version 1
################
Immoware > CHILL
################
.. list-table::
* - Contact technique AMLI à mobiliser prioritairement
- Grégory Simonet <gregory.simonet@batigere.fr>
* - Auteur et contact technique Champs-Libres
- Julien Fastré <julien.fastre@champs-libres.coop>
Historique des versions
***********************
.. list-table::
* - Version 1 (actuelle)
- 20 avril 2018
- Document initial
Contact technique AMLI à mobiliser prioritairement
Auteur et contact technique CL
********
Contexte
......@@ -37,7 +52,7 @@ Emplacement des boutons
Un premier bouton serait à placer sur la page d'accueil de Immoware
.. figure:: emplacement_button_1.png
.. figure:: emplacement_button_1_avec_dessin.png
:figwidth: 100%
Bouton pour créer une demande de procédure sociale, sur la page d'accueil de Immoware.
......@@ -45,21 +60,21 @@ Un premier bouton serait à placer sur la page d'accueil de Immoware
Un second bouton serait placé dans le dossier du client:
.. figure:: emplacement_button_2.png
.. figure:: emplacement_button_2_avec_dessin.png
:scale: 100 %
Bouton pour créer une demande de procédure sociale, depuis le dossier du client
.. figure:: indication_procedure.png
.. figure:: indication_procedure_avec_dessin.png
:scale: 100 %
Indication de la procédure en cours dans immoware.
TODO : ajouter icone CHILL
Le logo de Chill à utiliser peut être fourni au format svg ou png.
==========================
==========================================
Informations à transmettre depuis Immoware
==========================
==========================================
Pour la personne concernée :
......@@ -201,6 +216,15 @@ Autres membres du ménage
Ces informations sont à préfixer de :code:`a` suivi d'un index pour l'entrée. Les index doivent être des entiers incrémenté de la valeur 1 et débuter à 0.
Exemple:
.. code-block::
a[0][name]=dupont&a[0][firstname]=Yoan&a[0][link]=child&a[1][name]=dupont&a[1][firstname]=isabelle&a[1][link]=child
.. list-table:: Paramètres *Autres membres du ménage*
:header-rows: 1
......@@ -259,6 +283,7 @@ En mode :code:`GET`, aucune réponse ne sera renvoyée à Immoware.
En mode :code:`POST`, le système d'information répondra avec les informations suivantes:
En cas de succès:
-----------------
- Code de statut :code:`201`
- contenu:
......@@ -266,14 +291,34 @@ En cas de succès:
.. code-block:: json
{
"redirect-url": "https://chill.amli.asso.fr/redirect/814",
"extid": "814"
"redirect-url": "https://chill.amli.asso.fr/redirect/zArk85esdeg",
"extid": "e268265a-4483-11e8-8292-b328867b92bb",
"expiration": "2018-04-20T12:30:00Z"
}
Le champ :code:`redirect-url` contiendra l'URL de redirection vers laquelle rediriger l'utilisateur d'Immoware.
Le champ :code:`extid` contiendra un identifiant unique qui permettra de suivre l'évolution du mandatement (pour le suivi de la procédure). Il sera de type texte, maximum 255 caractères.
Le champ :code:`expiration` contiendra la date à laquelle le lien expirera.
En cas d'erreur
---------------
Le SI Amli renverra un status code :code:`400`.
Dans le cas où le quota d'envoi sera dépassé
--------------------------------------------
Le SI Amli renverra un status code :code:`429` (voir section "sécurité").
Sécurité
--------
L'envoi d'une requête ne modifiera pas les informations enregistrée dans le SI Amli, tant que l'utilisateur ne les validera pas. Pour éviter les requêtes multiples, un quota de 20 requêtes par heure sera introduit. Au delà, le SI AMLI renverra une erreur :code:`429`.
Par simplicité, nous n'introduirons pas d'authentification; mais si cela est techniquement possible pour immoware, nous sommes preneurs.
Retour des informations vers Immoware
=====================================
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment