Selon le type d'API que vous intégrez — bouquet mono ou multi-fournisseur, API à l'unité, API FranceConnectée — votre interlocuteur n'est pas toujours le même pour l'habilitation, l'intégration technique et le support. Ce guide vous aide à identifier qui contacter selon votre situation.
Lire plus • Comprendre ce qu'est une API sans vocabulaire technique.
Qu'est-ce qu'une API ?Types d'API
Dans l'écosystème des API utiles pour mettre en place le « Dites-le-nous une fois », il existe différents types pouvant se superposer :
Les bouquets d'API
Ces API regroupent, derrière un seul point d'entrée et un seul point de contact, plusieurs API, généralement organisées autour d'un secteur ou d'un usage commun. Ces « bouquets d'API » permettent donc d'accéder à de nombreuses données à partir d'une même API ayant plusieurs « branches », appelées « endpoints ». On distingue deux types de bouquets d'API, ceux :
- regroupant les API d'un même fournisseur : Il s'agit d'un regroupement des API d'une même administration, comme par exemple le bouquet des API de FranceTravail.
-
regroupant différents fournisseurs d'API : Il s'agit
d'un regroupement d'API issues de différentes administrations
fournisseurs d'API. Cette mise en commun permet d'accélérer
l'intégration d'API grâce notamment à une demande d'habilitation
unique et une cohérence technique (même authentification, mêmes
conventions de nommage et de réponse).
Les API classiques, « à l'unité »
Ces API sont propres à un seul fournisseur de données, comme l'API Impôt Particulier de la DGFiP ou l'API statut élève scolarisé et boursier du ministère de l'éducation nationale. Souvent très utiles et complémentaires aux bouquets, elles ont chacune leur propre formulaire d'habilitation, ainsi que leur propre gestion des accès et du support.
L'API Impôt Particulier de la DGFiP est un exemple d'API « à l'unité » : elle est propre à un seul fournisseur et dispose de sa propre demande d'habilitation, distincte de celle des bouquets d'API.
Les API FranceConnectées
Il s'agit d'une catégorie d'API qui ne concerne que les données des particuliers. Ces API se superposent aux deux catégories précédentes, elles peuvent être incluses dans des bouquets ou bien autonomes. Elles sont dites « FranceConnectées », car elles peuvent être appelées avec l'identité pivot FranceConnect plutôt qu'un simple identifiant. Ce niveau d'intégration supplémentaire simplifie le parcours de l'usager, sous conditions de quelques prérequis techniques spécifiques.
Lire plus • Consulter la liste de toutes les API FranceConnectées
Les API FranceConnectéesActeurs et interlocuteurs
Voici les différents acteurs et leurs implications au cours de l'intégration d'une API :
| Acteur | Rôle | Exemple |
|---|---|---|
| Le fournisseur de la donnée | Détient et produit la donnée. C'est votre interlocuteur s'il est également l'opérateur de l'API ou du bouquet, autrement ce n'est pas votre point de contact. | La DGFiP pour pour une attestation fiscale, la CAF ou la MSA pour le quotient familial, le Cnous pour le statut boursier. |
| L'opérateur de l'API | Gère l'API et la met à disposition. C'est votre interlocuteur, sauf si vous utilisez son API via un bouquet. Dans ce dernier cas, c'est alors l'opérateur du bouquet qui est votre interlocuteur. | La Caisse nationale d'assurance vieillesse pour l'API quotient familial. |
| L'opérateur du bouquet | Gère le bouquet d'API et tous ses endpoints. Si vous utilisez un bouquet d'API regroupant des API de plusieurs fournisseurs, il s'agit de votre interlocuteur unique pour l'habilitation, l'intégration technique et le support, pour toutes les API du bouquet. | La DINUM pour l'API Particulier et l'API Entreprise. |
| FranceConnect, le cas échéant | Gère l'identité pivot utilisée comme paramètre d'appel des API FranceConnectées. C'est votre interlocuteur uniquement sur cet aspect, si vous intégrez la version FranceConnectée d'une API. | FranceConnect, pour toute API FranceConnectée. |
| Votre éditeur de logiciel métier, le cas échéant | Gère votre ou vos logiciels métiers et intègre les API à l'intérieur. C'est votre interlocuteur privilégié. En cas de difficulté concernant une API, c'est lui que vous devez contacter en premier, notamment parce que le problème rencontré peut provenir du logiciel et non de l'API. Si l'éditeur constate que le problème provient bien de l'API, c'est à lui de contacter l'opérateur de l'API ou du bouquet d'API. | — |
Par exemple, pour l'API Quotient familial CAF/MSA :
- Les fournisseurs de la donnée sont la Caisse d'allocation familiale (CAF) et la Mutuelle sociale agricole (MSA) ;
- L'opérateur de l'API est la caisse nationale d'assurance vieillesse (CNAV) pour des raisons internes aux systèmes d'informations de l'État ;
- L'opérateur du bouquet est la DINUM car l'API est distribuée dans le bouquet API Particulier ;
- Si vous utilisez la version FranceConnectée de l'API Quotient familial, FranceConnect est votre interlocuteur sur cet aspect via son API FranceConnect ;
- Si l'API Quotient familial CAF/MSA a été intégrée par votre éditeur, cet éditeur reste votre interlocuteur privilégié à contacter en premier lieu en cas de difficulté.
Pour résumer
- Trois familles d'API, à combiner selon vos besoins : Bouquets mono ou multi-fournisseurs, API à l'unité, ou API FranceConnectées.
- Identifiez vos interlocuteurs. Selon votre situation et le type d'API que vous utilisez, votre point de contact est différent.
- Votre éditeur est toujours votre premier point de contact, s'il est en charge de l'intégration de l'API.
L'API Entreprise et l'API Particulier sont des bouquets d'API multi-fournisseurs conçus pour mettre en oeuvre le « Dites-le-nous une fois ». L'API Entreprise donne accès aux données des entreprises - Insee, Inpi, DGFIP, URSSAF, caisses de retraite...- ; l'API Particulier, aux données des particuliers - CAF/MSA, France Travail, ministères de l'éducation nationale et de l'enseignement supérieur...-. Les intégrer permet aussi de bénéficier du travail métier effectué pour proposer une offre en cohérence avec les démarches à simplifier.