Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions clients/node/api-particulier/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

## 0.2.0

- CNAV DSS: add Allocation de Rentrée Scolaire (ARS) endpoint
(`dss.allocation_rentree_scolaire_identite` / `dss.allocation_rentree_scolaire`),
identité pivot and FranceConnect modalities.

## 0.1.1

- Initial release
Expand Down
10 changes: 2 additions & 8 deletions clients/node/api-particulier/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion clients/node/api-particulier/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@api-gouv-dinum/api-particulier",
"version": "0.1.1",
"version": "0.2.0",
"description": "Official Node.js client for API Particulier v3",
"type": "module",
"main": "dist/index.cjs",
Expand Down
28 changes: 28 additions & 0 deletions clients/node/api-particulier/src/resources/dss.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,34 @@ export class Dss {
return this.client.get(path, { params: { 'recipient': options.recipient, 'nomNaissance': options.nom_naissance, 'nomUsage': options.nom_usage, 'prenoms': options.prenoms, 'anneeDateNaissance': options.annee_date_naissance, 'moisDateNaissance': options.mois_date_naissance, 'jourDateNaissance': options.jour_date_naissance, 'sexeEtatCivil': options.sexe_etat_civil, 'codeCogInseePaysNaissance': options.code_cog_insee_pays_naissance, 'codeCogInseeCommuneNaissance': options.code_cog_insee_commune_naissance, 'nomCommuneNaissance': options.nom_commune_naissance, 'codeCogInseeDepartementNaissance': options.code_cog_insee_departement_naissance } });
}

/** [FranceConnect] Statut allocation de rentrée scolaire (ARS) */
async allocation_rentree_scolaire(options: { version?: number; recipient?: string } = {}) {
const resolvedVersion = options.version ?? 3;
const path = (() => {
switch (resolvedVersion) {
case 3:
return `/v3/dss/allocation_rentree_scolaire/france_connect`;
default:
throw new Error(`version ${resolvedVersion} not available for /dss/allocation_rentree_scolaire/france_connect; supported: [3]`);
}
})();
return this.client.get(path, { params: { 'recipient': options.recipient } });
}

/** [Identité] Statut allocation de rentrée scolaire (ARS) */
async allocation_rentree_scolaire_identite(options: { version?: number; recipient?: string; nom_naissance: string; nom_usage?: string; prenoms: string[]; annee_date_naissance?: string; mois_date_naissance?: string; jour_date_naissance?: string; sexe_etat_civil?: string; code_cog_insee_pays_naissance: string; code_cog_insee_commune_naissance?: string; nom_commune_naissance?: string; code_cog_insee_departement_naissance?: string }) {
const resolvedVersion = options.version ?? 3;
const path = (() => {
switch (resolvedVersion) {
case 3:
return `/v3/dss/allocation_rentree_scolaire/identite`;
default:
throw new Error(`version ${resolvedVersion} not available for /dss/allocation_rentree_scolaire/identite; supported: [3]`);
}
})();
return this.client.get(path, { params: { 'recipient': options.recipient, 'nomNaissance': options.nom_naissance, 'nomUsage': options.nom_usage, 'prenoms': options.prenoms, 'anneeDateNaissance': options.annee_date_naissance, 'moisDateNaissance': options.mois_date_naissance, 'jourDateNaissance': options.jour_date_naissance, 'sexeEtatCivil': options.sexe_etat_civil, 'codeCogInseePaysNaissance': options.code_cog_insee_pays_naissance, 'codeCogInseeCommuneNaissance': options.code_cog_insee_commune_naissance, 'nomCommuneNaissance': options.nom_commune_naissance, 'codeCogInseeDepartementNaissance': options.code_cog_insee_departement_naissance } });
}

/** [FranceConnect] Statut allocation de soutien familial (ASF) */
async allocation_soutien_familial(options: { version?: number; recipient?: string } = {}) {
const resolvedVersion = options.version ?? 3;
Expand Down
8 changes: 8 additions & 0 deletions clients/ruby/api_particulier/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ adheres to [Semantic Versioning](https://semver.org/).

## [Unreleased]

## [0.2.0] - 2026-06-01

### Added
- CNAV DSS : nouvel endpoint Allocation de Rentrée Scolaire (ARS)
(`dss.allocation_rentree_scolaire_identite` /
`dss.allocation_rentree_scolaire`), modalités identité
pivot et FranceConnect.

## [0.1.2] - 2026-05-07

### Fixed
Expand Down
4 changes: 2 additions & 2 deletions clients/ruby/api_particulier/Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
api_particulier (0.1.1)
api_particulier (0.2.0)
Comment thread
skelz0r marked this conversation as resolved.
faraday (~> 2.0)
faraday-retry (~> 2.0)

Expand Down Expand Up @@ -62,7 +62,7 @@ DEPENDENCIES

CHECKSUMS
addressable (2.9.0) sha256=7fdf6ac3660f7f4e867a0838be3f6cf722ace541dd97767fa42bc6cfa980c7af
api_particulier (0.1.1)
api_particulier (0.2.0)
bigdecimal (4.1.1) sha256=1c09efab961da45203c8316b0cdaec0ff391dfadb952dd459584b63ebf8054ca
crack (1.0.1) sha256=ff4a10390cd31d66440b7524eb1841874db86201d5b70032028553130b6d4c7e
diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
Expand Down
28 changes: 28 additions & 0 deletions clients/ruby/api_particulier/lib/api_particulier/resources/dss.rb
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,34 @@ def allocation_enfant_handicape_identite(version: nil, recipient: nil, nom_naiss
@client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "nomUsage" => nom_usage, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "sexeEtatCivil" => sexe_etat_civil, "codeCogInseePaysNaissance" => code_cog_insee_pays_naissance, "codeCogInseeCommuneNaissance" => code_cog_insee_commune_naissance, "nomCommuneNaissance" => nom_commune_naissance, "codeCogInseeDepartementNaissance" => code_cog_insee_departement_naissance }.compact)
end

# [FranceConnect] Statut allocation de rentrée scolaire (ARS)
# Logical endpoint: /dss/allocation_rentree_scolaire/france_connect
# Versions available: [3] — default: 3
def allocation_rentree_scolaire(version: nil, recipient: nil)
path =
case version || 3
when 3
"/v3/dss/allocation_rentree_scolaire/france_connect"
else
raise ArgumentError, "version #{version.inspect} not available for /dss/allocation_rentree_scolaire/france_connect; supported: [3]"
end
@client.get(path, params: { "recipient" => recipient }.compact)
end

# [Identité] Statut allocation de rentrée scolaire (ARS)
# Logical endpoint: /dss/allocation_rentree_scolaire/identite
# Versions available: [3] — default: 3
def allocation_rentree_scolaire_identite(version: nil, recipient: nil, nom_naissance:, nom_usage: nil, prenoms:, annee_date_naissance: nil, mois_date_naissance: nil, jour_date_naissance: nil, sexe_etat_civil: nil, code_cog_insee_pays_naissance:, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
path =
case version || 3
when 3
"/v3/dss/allocation_rentree_scolaire/identite"
else
raise ArgumentError, "version #{version.inspect} not available for /dss/allocation_rentree_scolaire/identite; supported: [3]"
end
@client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "nomUsage" => nom_usage, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "sexeEtatCivil" => sexe_etat_civil, "codeCogInseePaysNaissance" => code_cog_insee_pays_naissance, "codeCogInseeCommuneNaissance" => code_cog_insee_commune_naissance, "nomCommuneNaissance" => nom_commune_naissance, "codeCogInseeDepartementNaissance" => code_cog_insee_departement_naissance }.compact)
end

# [FranceConnect] Statut allocation de soutien familial (ASF)
# Logical endpoint: /dss/allocation_soutien_familial/france_connect
# Versions available: [3] — default: 3
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module ApiParticulier
VERSION = '0.1.2'.freeze
VERSION = '0.2.0'.freeze
end
4 changes: 4 additions & 0 deletions commons/data/authorizations.yml
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,10 @@ shared:
- cnav_allocation_enfant_handicape
api_particulier/v3_and_more/cnav/allocation_enfant_handicape_with_france_connect:
- cnav_allocation_enfant_handicape
api_particulier/v3_and_more/cnav/allocation_rentree_scolaire_with_civility:
- cnav_allocation_rentree_scolaire
api_particulier/v3_and_more/cnav/allocation_rentree_scolaire_with_france_connect:
- cnav_allocation_rentree_scolaire
api_particulier/v3_and_more/cnav/complementaire_sante_solidaire_with_civility:
- complementaire_sante_solidaire
api_particulier/v3_and_more/cnav/complementaire_sante_solidaire_with_france_connect:
Expand Down
2 changes: 2 additions & 0 deletions commons/data/throttle.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ shared:
- api_particulier_v3_cnav_participation_familiale_eaje_with_france_connect
- api_particulier_v3_cnav_allocation_enfant_handicape_with_civility
- api_particulier_v3_cnav_allocation_enfant_handicape_with_france_connect
- api_particulier_v3_cnav_allocation_rentree_scolaire_with_civility
- api_particulier_v3_cnav_allocation_rentree_scolaire_with_france_connect
- api_particulier_v3_cnav_prime_activite_with_civility
- api_particulier_v3_cnav_prime_activite_with_france_connect
- api_particulier_v3_cnav_quotient_familial_with_civility
Expand Down
32 changes: 32 additions & 0 deletions commons/endpoints/_swagger_shared/cnav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -568,6 +568,38 @@ cnav:
Ce champs est null dans le cas où le particulier n'est pas bénéficiaire de l'AEEH."
example: '1992-11-29'

ars:
title: Statut allocation de rentrée scolaire (ARS)
description: "Statut bénéficiaire de l'allocation de rentrée scolaire (ARS).
\n
L'indicateur précise si le particulier est allocataire, ouvrant droit ou non bénéficiaire de l'ARS."
tags:
- Statut Allocation de Rentrée Scolaire (ARS)
attributes:
status:
title: "Statut bénéficiaire de l'allocation de rentrée scolaire (ARS)"
type: string
description: "Indique si le particulier est bénéficiaire de l'allocation de rentrée scolaire au moment de l'appel.
\n
\n
- Si le statut est 'allocataire', cela signifie que le particulier est l'allocataire de l'ARS.
\n
- Si le statut est 'ouvrant_droit', cela signifie que le particulier est ouvrant droit de l'ARS.
\n
- Si le statut est 'non_beneficiaire', cela signifie que le particulier n'est pas concerné par l'ARS."
enum:
- "allocataire"
- "ouvrant_droit"
- "non_beneficiaire"
date_debut_droit:
title: "Date d'ouverture du droit à l'ARS"
type: string
nullable: true
description: "Date de début de droit à l'allocation de rentrée scolaire du particulier bénéficiaire.
\n
Ce champ est null dans le cas où le particulier n'est pas bénéficiaire de l'ARS."
example: '2024-08-09'

v2:
commons:
cache_duration: "La durée du cache est de 1 heure."
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
fiche:
- uid: 'cnav/allocation_rentree_scolaire'
opening: protected
path: '/v3/dss/allocation_rentree_scolaire/identite'
controller: 'api_particulier/v3_and_more/cnav/allocation_rentree_scolaire_with_civility'
ping_url: 'https://particulier.api.gouv.fr/api/cnav_allocation_rentree_scolaire/ping'
position: 805
perimeter:
entity_type_description: |+
✅ Le périmètre de l'API couvre les bénéficiaires de l'allocation de rentrée scolaire (ARS).

⚙️ Vérification en cours avec le fournisseur de données pour confirmer le périmètre exact.
geographical_scope_description: |+
- ✅ France Métropolitaine
- ✅ Départements d'Outre-mer
- ❌ Les collectivités d'Outre-mer, ayant un autre système de sécurité sociale, ne sont pas concernées par cette API.
updating_rules_description:
Les données sont **mises à jour en temps réel** et issues du répertoire national commun de la protection sociale (RNCPS) opéré par la CNAV (Caisse nationale d'assurance vieillesse).
parameters_details:
description: |+
Cette API propose deux modalités d'appel :
<p class="fr-badge fr-badge--blue-ecume">![Cette API est FranceConnectée](<%= image_path('api_particulier/cas_usages/pictos/modalite_appel_france_connect.svg') %>){:width="20px"} FranceConnect</p>
**Avec la [modalité d'appel FranceConnect](<%= cas_usage_path('modalite_appel_france_connect') %>)**.

<p class="fr-badge fr-badge--brown-cafe-creme">Identité pivot</p>
**Avec les données d'identité** :

{:.fr-mb-0}
- Nom de naissance, nom d'usage, prénoms, sexe, date de naissance de l'allocataire, code COG du pays de naissance&nbsp;;
- Commune de naissance _(fortement recommandé)_.
data:
description: |+
Cette API **indique si le particulier est bénéficiaire de l'allocation de rentrée scolaire**, en précisant la date d'ouverture du droit.
provider_uids:
- 'cnav'
keywords:
- allocation
- rentrée scolaire
- aides
- ars
- enfant
call_id:
- Identité pivot
- FranceConnect
parameters:
- Identité pivot
- FranceConnect
faq: []
Loading
Loading