API Particulier
Producteur : DINUMEntités administratives, simplifiez les démarches des particuliers en récupérant pour eux leurs informations administratives (quotient familial CAF, composition familiale, statut demandeur d’emploi, étudiant et étudiant boursier).
Description
À quoi sert l’API Particulier ?
L'API Particulier permet de mettre en oeuvre le principe « Dites-le-nous une fois », en application de l’article L114-8 du Code des relations entre le public et l’administration .
L'API Particulier est un bouquet d'API donnant accès à des données administratives des particuliers : quotient familial CAF, composition familiale, statut demandeur d’emploi, certificat de scolarité des élèves du primaire, du secondaire et étudiant, statuts élève et étudiant boursier ... il est utilisable dans le cadre des démarches en ligne et téléservices proposés aux usagers, ainsi que dans les logiciels métiers utilisés par les agents habilités en guichet.
Les usagers n'ont plus à fournir de pièces justificatives à l'appui de leurs démarches administratives, telles que la tarification sociale et solidaire des transports, la cantine à 1 euro, les aides facultatives à la scolarité...
Ce qu'API Particulier change pour vous, administrations :
En intégrant la brique API Particulier dans votre système d’information ou votre site internet :
- ✅ Vous n’avez plus besoin de demander certaines informations aux particuliers, comme le certificat de scolarité ou l'attestation CAF ;
- ✅ Vous n’avez pas de saisie ou de vérification supplémentaire à réaliser ;
- ✅ Les informations sont certifiées ;
- ✅ Vous accédez avec une seule habilitation aux données de différents fournisseurs : la Caisse nationale des allocations familiales (CNAF), la sécurité sociale agricole (MSA), Pôle emploi, le ministère de l'enseignement supérieur et de la recherche (MESR), le ministère de l'éduction nationale (MEN) et enfin le Centre national des œuvres universitaires et scolaires (Cnous).
Exemples d’application
API accessibles avec l'API Particulier
| API | Fournisseur des données | Données | Disponibilité sur API Particulier | Peut s'utiliser avec FranceConnect |
|---|---|---|---|---|
| Quotient familial CAF | CNAF | Quotient familial CAF, composition familiale 📖 Documentation Extension du périmètre au régime agricole (MSA) prévu T3 2023 | ✅ | Prévu T1 2024 |
| Certificat de scolarité étudiant | MESR | Statut, établissement 📖 Documentation | ✅ | ✅ |
| Statut étudiant boursier | Cnous | Statut étudiant, statut boursier 📖 Documentation | ✅ | ✅ |
| Statut demandeur d'emploi | Pôle Emploi | Statut et catégorie (A,B,C,D) 📖 Documentation | ✅ | ➡️ Pas FranceConnecté dans API Particulier mais disponible avec cette API. |
| Statut élève scolarisé et boursier | Ministère de l'éducation nationale | Statut élève scolarisé au primaire et secondaire ; et statut boursier | ✅ | Prévu |
| Liste des paiements de Pôle emploi | Pôle Emploi | Montants des paiements des allocations ou des aides | T2 2023 | ➡️ Ne sera pas FranceConnecté dans API Particulier mais déjà disponible avec cette API. |
| Statut Complémentaire santé solidaire (CSS) | Direction de la sécurité sociale | Indique si le particulier a la CSS, avec ou sans participation. | T2 2023 | T2 2023 |
| Statut Revenu de solidarité active (RSA) | Direction de la sécurité sociale | En cours de définition | T4 2023 | T4 2023 |
🔎 En savoir plus sur les API et les API France Connectées.
Conditions générales d'utilisation
Les conditions générales d'utilisation sont disponibles à ici en PDF.
Infolettre API Particulier
Chaque année, l'équipe de l'API Particulier envoie un bilan chiffré sur l'utilisation de l'API, et la feuille de route de l'année suivante (nouvelles démarches, prochaines données qui intègrent l'API...).
FAQ
Qu'est-ce qu'une API ?
Pour mieux comprendre ce qu'est une API, consulter cette page.
Quelles sont les étapes pour utiliser l'API Particulier ?
Je suis une collectivité ou une administration :
- Je consulte les cas d’usages de l'API Particulier :
- Si j'ai un éditeur de logiciel, je consulte le tableau en bas du cas d'usage pour savoir si mon éditeur intègre déjà l’API Particulier.
- Sinon je contacte mon éditeur et je lui transmets le lien vers la documentation technique pour m'assurer qu'il peut intégrer l'API.
- Je clique sur le bouton "faire une demande d'habilitation", je crée mon compte DataPass ou je me connecte.
- Une fois sur la première page du formulaire d'accès à l'API Particulier, je complète l'encadré "Qui implémentera l'API ?" :
- Si j'ai un éditeur, je coche "Votre éditeur de logiciel" et je le sélectionne dans la liste déroulante s'il est disponible.
- Si je n'ai pas d'éditeur, je coche "Votre équipe de développeurs". Je clique sur "Suivant".
- À la page suivante, rubrique "Modèles pré-remplis", je sélectionne le formulaire pré-rempli adéquat :
- Si j'ai un éditeur, je retrouve son nom et le nom de la solution dans la liste déroulante.
- Si je n'ai pas d'éditeur, je laisse le mode par défaut "Demande libre".
- Je complète mon formulaire : informations sur le projet, données nécessaires, traitement des données, cadre juridique - dont délibération -, coordonnées de l'équipe dont responsable technique, délégué à la protection des données et responsable de traitement.
- Une fois ma demande instruite et validée par l'équipe API Particuliere, je reçois un e-mail m'indiquant où récupérer mon jeton. Je le transmets à mon éditeur ou à mes développeurs.
Je suis un éditeur et je ne suis pas encore référencé :
ℹ️ Si vous êtes éditeur de logiciels, c'est à votre client public, collectivité ou administration, de faire sa demande d'habilitation auprès de l'API Particulier.
Vous pouvez nous demander de vous référencer sur un cas d'usage afin de proposer un formulaire pré-rempli qui simplifiera l'expérience de vos clients. Voici la procédure à suivre :
- Je repère les données dont mes clients publics ont besoin pour un cas d'usage précis que je peux ou pourrai proposer dans ma solution logicielle ;
- Je consulte la documentation technique, et j'utilise le bac à sable pour tester les appels d'API ;
- J'écris à cette adresse pour être référencé sur le cas d'usage associé et avoir un formulaire pré-rempli à disposition de mes clients.
Comment tester l'API ? Un jeton d'accès est-il nécessaire pour accéder au bac à sable ?
Vous pouvez accéder au bac à sable afin de tester des appels d’API avec des données virtuelles. Aucune habilitation n’est nécessaire, un token est généré immédiatement.
Il est possible d'ajouter des données au bac à sable à travers la plateforme Airtable : Depuis le swagger, en cliquant sur le détail des données proposées par un fournisseur de données, vous pouvez cliquer sur la liste des données présentes en bac à sable. Sur AirTable vous pouvez ensuite éditer des données. Exemple ici avec les données bac à sable de l'API de la CNAF.
Comment récupérer mon jeton d'accès (token) une fois ma demande validée ?
- Une fois votre demande d'habilitation validée, un e-mail vous est envoyé avec un lien vers mon.portail-test-staging.api.gouv.fr/.
- Une fenêtre de connexion (compte Datapass) s'ouvre. Renseignez les mêmes identifiants utilisés lors de votre demande d'habilitation.
- Sur votre espace mon.portail-test-staging.api.gouv.fr/, votre jeton est disponible et peut-être copié.
⚠️ Votre token vous est propre, il ne faut pas le diffuser. Vous ne devez jamais copier-coller un token dans un moteur de recherche ou dans un e-mail. L’usage de votre token se fait uniquement dans votre logiciel métier sécurisé utilisé pour réaliser vos appels. - Vous devez transmettre ce jeton à votre éditeur ? Ou à votre équipe technique ? Utilisez un moyen de transmission sécurisé (messagerie cryptée par exemple).
Support utilisateur
Vous êtes utilisateur de l'API Particulier, vous rencontrez un problème et avez besoin d'échanger avec nous en transmettant des données sensibles ? Utilisez le formulaire de transfert d'informations sécurisées.
L’équipe
Documentation technique
L’API en détail
Partenaires
- CNAF
- Pôle Emploi
- mesr