API CAF
Accéder simplement aux informations concernant une famille allocataire de la CAF.
Informations pouvant être obtenues
- Quotient familial
- Adresse connue
- Nom, prénom, sexe et date de naissance des allocataires
- Nom, prénom, sexe et date de naissance des enfants à charge
Ces informations sont délivrées de façon sécurisée, sur la base du numéro d'allocataire et du code postal.
Les données sont mises à jour de façon mensuelle.
Installation et utilisation
Pré-requis
Configuration
Pour utiliser ce projet, vous devez créer un fichier config.json
. Vous pouvez pour cela vous inspirer du fichier config.example.json
.
Clé | Description | Exemple |
---|---|---|
port |
Port d'écoute du serveur HTTP | 5000 (valeur par défaut) |
cafHost |
Hôte du service CAF | https://caf-host |
cafSslCertificate |
Chemin vers le certificat permettant de se connecter au service CAF | /path/to/cert |
cafSslKey |
Chemin vers la clé permettant de se connecter au service CAF | /path/to/key |
cafPingParams.numeroAllocataire |
Numéro d'allocataire à utiliser pour le service de PING | 1234567 |
cafPingParams.codePostal |
Code postal à utiliser pour le service de PING | 12345 |
Installation des dépendances
yarn
Lancement du service
yarn start
Lancer les tests
yarn test
Documentation de l'API
Pour obtenir les informations concernant une famille :
Requête :
GET /api/famille?numeroAllocataire=123456&codePostal=92330
Réponse :
Pour vérifier la disponibilité du service
Requête :
GET /api/ping
Réponse :
pong
si le service fonctionneboom
sinon