Certaines de vos applications ont besoin de s’interfacer avec le Portail des aides. Elles peuvent avoir besoin de récupérer de la donnée du Portail des aides. Elles peuvent également avoir besoin de mettre à jour de la donnée du Portail des aides. Afin de faciliter ces échanges de données, le Portail des aides possède un service, nommé pda-semi-public-api, qui aura pour rôle d’exposer des API à destination d’applications externes au Portail des aides, et de gérer la sécurisation des appels de ces API. En plus d’ajouter une couche de sécurité, qui est essentielle dans ce type d’interface avec des applications externes, ce service joue également le rôle de proxy vers les différents services constituant le Portail des aides (référentiel tiers, référentiel des demandes, connecteur gestion financière, GED applicative, etc.).

Module dossiersFinanciersExternes

Nom de la route Description
/api/tenants/{tenantId}/dossiers-financiers-externes/mettre-a-jour-statut-dossier Mettre à jour le statut d’un dossier financier externe (CREE ou EN_ERREUR)
/api/tenants/{tenantId}/dossiers-financiers-externes/mettre-a-jour-statut-liquidation Mettre à jour le statut d’une liquidation (CREE ou EN_ERREUR)
/api/tenants/{tenantId}/dossiers-financiers-externes/recuperer-documents-lies-a-une-liquidation Récupérer les documents existants sur une demande associée à un dossier financier externe

Module liquidations

Nom de la route Description
/api/tenants/{tenantId}/liquidations/mettre-a-jour-suivi-liquidation Mettre à jour le suivi d’une liquidation

Module Kiosque GED

Nom de la route Description
{{url}}/pda-semi-public-api/api/agent-ged/graphql Récupération d’événements de documents ainsi que leurs données métiers liées. (GraphQL) Administration des mappings sur les données métiers liées aux documents
{{url}}/pda-semi-public-api/api/tenants/portaildesaides/agent-ged/documents/ Récupération de documents. (GET https)