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.).
| 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 |
| Nom de la route | Description |
| /api/tenants/{tenantId}/liquidations/mettre-a-jour-suivi-liquidation | Mettre à jour le suivi d’une liquidation |
| 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) |
| Nom de la route | Description |
| {{url}}/pda-semi-public-api/api/api-gru/graphql | Récupération des tiers et des demandes d’un compte OiDC (API Générique) |
| {{url}}/pda-semi-public-api/api/tenants/{tenantId}/gru-publik/mes-demandes | Récupération des tiers et des demandes d’un compte OiDC (GRU Publik) |
| {{url}}/pda-semi-public-api/api/tenants/{tenantId}/gru-publik/mes-demandes-pour-un-tiers | Récupération des demandes d’un tiers associés à un compte OiDC (GRU Publik) |
| Nom de la route | Description |
| URL : {{url}}/pda-semi-public-api/api/graphql Query : deliberationRecupererInfosDossiers | API GraphQL – Récupération des informations des dossiers rattachés à une instance délibérante externe |
| {{url}}/pda-semi-public-api/api/tenants/{{tenantId}}/deliberation/recuperer-documents-lies-a-dossier-et-demande | API REST – Récupération des documents de délibération d’un dossier |
| URL : {{url}}/pda-semi-public-api/api/graphql Mutation : deliberationRattacherRapport | API GraphQL – Rattachement d’un numéro de rapport de délibération à une liste de dossiers |
| URL : {{url}}/pda-semi-public-api/api/graphql Mutation : deliberationDetacherRapport | API GraphQL – Détachement d’un numéro de rapport de délibération à une liste de dossiers |
| URL : {{url}}/pda-semi-public-api/api/graphql Mutation : deliberationMettreAJourInformations | API GraphQL – Mise à jour des informations de délibération sur une liste de dossiers |
| {{url}}/pda-semi-public-api/api/api/tenants/{tenantId}/deliberation/ajouter-document-instance | API REST – Ajout d’un document sur une instance associée à un outil de délibération externe |
| Nom de la route | Description |
| URL : /pda-semi-public-api/api/tenants/{tenantId}/traitement-masse/creation-de-decision | API REST – Lancement du traitement de masse de vote des dossiers |
| URL : /pda-semi-public-api/api/tenants/{tenantId}/traitement-masse/creation-de-decision/rapport/{referenceRapport}?{{offset}}&{{limit}} | API REST – Récupération du rapport du traitement de masse de vote des dossiers |
| Nom de la route | Description |
| URL : /pda-semi-public-api/api/tenants/{tenantId}/connecteur-aides-en-nature/documents/file | API REST – Dépôt des fichiers Planitech |
| URL : /pda-semi-public-api/api/tenants/{tenantId}/connecteur-aides-en-nature/reports/last-seven-reports | API REST – Récupération de la liste des rapports d’exécution |
| URL : /pda-semi-public-api/api/tenants/{tenantId}/connecteur-aides-en-nature/reports/{reportId} | API REST – Récupération d’un rapport d’exécution |
| URL : /pda-semi-public-api/api/tenants/{tenantId}/connecteur-aides-en-nature/reports/{reportId}/{typeWorker}/{typeTreatment}/errors | API REST – Récupération du rapport d’un worker |