Parcours éditeur - etalab/formulaire-qf GitHub Wiki

Vous pouvez suivre ce guide pour interfacer votre système avec le site de transmission du quotient familial (abrégé "FQF" dans la suite de ce document, par ce qu'on l'a longtemps appelé "Formulaire Qotient Familial" même si ce n'est pas vraiment un formulaire).

Fonctionnement général

API Particulier permet de récupérer le Quotient Familial d’un allocataire à partir de son identité pivot.

Si vous n'avez pas l'identité pivot mais que vous avez un portail famille ainsi qu'une habilitation FranceConnect vous pouvez demander à vos usagers de s'identifier avec FranceConnect pour récupérer leur Quotient Familial sur API Particulier.

Pourquoi utiliser le site de transmission du quotient familial ?

Les collectivités sans portail famille ou sans habilitation FranceConnect peuvent renvoyer leurs usagers sur FQF et récupérer les données d'identité pivot ainsi que le quotient familial sur HubEE.

Etapes à suivre pour l'intégration

1. Accès aux environnements

Un environnement de "sandbox" est disponible pour vos tests techniques:

• FQF: https://sandbox.quotient-familial.services.api.gouv.fr/
• HubEE:
  • API: https://api.bas.hubee.numerique.gouv.fr
  • Auth: https://auth.bas.hubee.numerique.gouv.fr/oauth2/token
  • Portail HubEE: https://portail.bas.hubee.numerique.gouv.fr

Pour la production, ces urls sont différentes:

• FQF: https://quotient-familial.numerique.gouv.fr/
• HubEE:
  • API: https://api.hubee.numerique.gouv.fr
  • Auth: https://auth.hubee.numerique.gouv.fr/oauth2/token
  • Portail HubEE: https://portail.hubee.numerique.gouv.fr

2. Avoir un compte éditeur HubEE

Si vous n'avez pas de compte et/ou si votre éditeur n'est pas encore disponible sur HubEE vous pouvez suivre cette présentation.

Une fois que vous aurez votre compte HubEE ainsi que votre éditeur disponible sur la plateforme (en environnement de test) notre équipe pourra vous créer une commune de test.

Celle-ci sera disponible dans la liste déroulante des communes et sera abonnée à votre compte HubEE vous permettant de tester de bout en bout votre intégration.

3. Intégration éditeur avec HubEE

Vous pouvez consulter notre guide technique dédié à l'intégration HubEE

3.1 Comment faire correspondre vos demandes aux données transmises par FQF ?

Le lien que vous utilisez pour envoyer vos usagers vers FQF peut contenir un paramètre d'url spécial (dans la querystring) nommé "external_id". La valeur transmise dans ce paramètre sera présente dans les données transmises (au format JSON ou XML) par FQF sous la clé "external_id".

Par exemple: Vous envoyez un usager sur FQF avec le lien suivant: https://sandbox.quotient-familial.services.api.gouv.fr/?external_id=reference_interne_de_mon_usager

Une fois la demande aboutie, vous récupérerez le JSON (tronqué) suivant :

{
  "external_id": "reference_interne_de_mon_usager",
  "pivot_identity": {
    ...
  },
  "quotient_familial_v3": {
    ...
  },
  "quotient_familial": {
    ...
  }
}

3.1 Comment rediriger l'usager vers mon portail après sa demande ?

Le lien que vous utilisez pour envoyer vos usagers vers FQF peut contenir un paramètre d'url spécial (dans la querystring) nommé "redirect_uri". Ce paramètre doit commencer par "https://" pour être valide.

Une fois sa demande terminée l'usager se trouvera sur une page de confirmation contenant un lien vers la valeur de ce paramètre.

Par exemple: Vous envoyez un usager sur FQF avec le lien suivant: https://sandbox.quotient-familial.services.api.gouv.fr/?redirect_uri=https://url_de_mon_portail.fr

4. Comment tester mon intégration en sandbox ?

Suivez les étapes sur FQF puis pour vous connecter avec FranceConnect:

• choisissez le premier fournisseur d'identité ("Démonstration - eIDAS faible")
• utilisez le login: "test"
• utilisez le mot de passe : "123"

Puis continuez à suivre les étapes sur FQF.