Définition de chaque aide dispensée par une collectivité. L'ensemble des définitions représente son guide des aides.
Une fiche d'aide contient de multiple attributs comme son titre ou sa description. Mais elle peut aussi être composée de données liées comme une liste de compétences. Les différents type de données liées sont :
- des mots-clés
- des compétences
- des publics de bénéficiaires
- des engagements
Le détail de la modélisation de ces données est disponible dans model.md.
Vous pouvez consulter l'API disponible dans ce service en vous rendant sur swagger-UI.
Le guide-des-aides permet de lister les fiches d'aides disponibles et de consulter le détail de chacune. Deux scénarii de consommation sont schématisés dans usage.md.
- La création d'une nouvelle fiche d'aide
- La consultation d'une fichie d'aide
Vous pouvez utiliser postman en tant que client d'API avec la collection suivante :
Pour faciliter le travailler des intégrateurs, un service mock est fourni dans mock-service.