Autre #72372
Mis à jour par Brice Mallet il y a plus d'un an
Mgdis nous demande notre avis sur leur connecteur V2, courriel envoyé le 13/12.
J'attribue en première instance à Nicolas.
<pre>
-------- Message transféré --------
Sujet : RE: API Publik V2, spécifications
Date : Tue, 13 Dec 2022 14:57:32 +0000
De : Robin Hélène <Robin-h@mgdis.fr>
Pour éviter d'allonger ce ticket, j'ai créé une page wiki récapitulant nos échanges : Brice Mallet <bmallet@entrouvert.com>, Palatinus Vincent <palatinus-v@mgdis.fr>, Hely Gwennolé <hely-g@mgdis.fr>
Copie à : Goarin Marie <Goarin-m@mgdis.fr>, Cornuaille Hugues <Cornuaille-h@mgdis.fr>
Comme indiqué par Gwennolé dans un message précédent, nous sommes actuellement en cours de rédaction des exigences concernant l'API semi-publique de récupération des demandes d'un compte. Nous aurions besoin de valider avec Mgdis vous le résultat JSON renvoyés par cette API, afin qu'il soit exploitable par votre application.
La nouvelle route d'API que nous réaliserons devrait être du type : https://dev.entrouvert.org/projects/saint-denis/wiki/Documentation_pour_une_API_V2
GET /pda-semi-public-api/api/tenants/:tenantId/entrouvert/mes-demandes?suboidc=:subid
En plus du paramètre obligatoire "suboidc" permettant de passer le "subid" du compte, il sera possible d'ajouter des paramètres facultatifs :
- paramètre de filtre, permettant de filtrer la donnée par téléservice ou statut de tiers,
- paramètres de pagination
Vous trouverez en pièces jointes des exemples de résultats retournés par l'API :
- Cas d'un appel à l'API d'un compte ayant déposé 3 demandes prises en charge sur 2 tiers valides : cf. fichier apiEntrouvert-unCompte-nDemandes-nTiersValides.json
- Cas d'un appel à l'API d'un compte ayant transmis sa 1ère demande sur un nouveau tiers : cf. fichier apiEntrouvert-unCompte-uneDemande-unTiers.json
- Cas d'un appel à l'API d'un compte dont une demande et le tiers ont été refusés : cf. fichier apiEntrouvert-unCompte-uneDemandeRefusee-unTiersRefuse.json
- Cas d'un appel à l'API d'un nouveau compte n'ayant pas encore commencé de dépôt de demande : dans ce cas l'API renverra un tableau vide ([]).
La structure de la réponse de l'API est en cours d'analyse, nous pouvons encore apporter des modifications.
Pouvez-vous donc nous faire un retour sur la structure des résultats envoyés ? Correspond-elle à votre attendu ?
Vous manque-t-il des informations ou à l'inverse y a-t-il des informations inutiles ?
*Hélène ROBIN*
/Analyste Produit et Product Owner/
robin-h@mgdis.fr <mailto:robin-h@mgdis.fr>
</pre>
J'attribue en première instance à Nicolas.
<pre>
-------- Message transféré --------
Sujet : RE: API Publik V2, spécifications
Date : Tue, 13 Dec 2022 14:57:32 +0000
De : Robin Hélène <Robin-h@mgdis.fr>
Pour éviter d'allonger ce ticket, j'ai créé une page wiki récapitulant nos échanges : Brice Mallet <bmallet@entrouvert.com>, Palatinus Vincent <palatinus-v@mgdis.fr>, Hely Gwennolé <hely-g@mgdis.fr>
Copie à : Goarin Marie <Goarin-m@mgdis.fr>, Cornuaille Hugues <Cornuaille-h@mgdis.fr>
Comme indiqué par Gwennolé dans un message précédent, nous sommes actuellement en cours de rédaction des exigences concernant l'API semi-publique de récupération des demandes d'un compte. Nous aurions besoin de valider avec Mgdis vous le résultat JSON renvoyés par cette API, afin qu'il soit exploitable par votre application.
La nouvelle route d'API que nous réaliserons devrait être du type : https://dev.entrouvert.org/projects/saint-denis/wiki/Documentation_pour_une_API_V2
GET /pda-semi-public-api/api/tenants/:tenantId/entrouvert/mes-demandes?suboidc=:subid
En plus du paramètre obligatoire "suboidc" permettant de passer le "subid" du compte, il sera possible d'ajouter des paramètres facultatifs :
- paramètre de filtre, permettant de filtrer la donnée par téléservice ou statut de tiers,
- paramètres de pagination
Vous trouverez en pièces jointes des exemples de résultats retournés par l'API :
- Cas d'un appel à l'API d'un compte ayant déposé 3 demandes prises en charge sur 2 tiers valides : cf. fichier apiEntrouvert-unCompte-nDemandes-nTiersValides.json
- Cas d'un appel à l'API d'un compte ayant transmis sa 1ère demande sur un nouveau tiers : cf. fichier apiEntrouvert-unCompte-uneDemande-unTiers.json
- Cas d'un appel à l'API d'un compte dont une demande et le tiers ont été refusés : cf. fichier apiEntrouvert-unCompte-uneDemandeRefusee-unTiersRefuse.json
- Cas d'un appel à l'API d'un nouveau compte n'ayant pas encore commencé de dépôt de demande : dans ce cas l'API renverra un tableau vide ([]).
La structure de la réponse de l'API est en cours d'analyse, nous pouvons encore apporter des modifications.
Pouvez-vous donc nous faire un retour sur la structure des résultats envoyés ? Correspond-elle à votre attendu ?
Vous manque-t-il des informations ou à l'inverse y a-t-il des informations inutiles ?
*Hélène ROBIN*
/Analyste Produit et Product Owner/
robin-h@mgdis.fr <mailto:robin-h@mgdis.fr>
</pre>