Skip to content

Commit 8a73c1d

Browse files
SamuelfaureSamuelfaure
authored
Merge pull request #219 from etalab/feature/effectifs_oeth
Feature/effectifs oeth
2 parents 384313f + ec382c2 commit 8a73c1d

24 files changed

+626
-52
lines changed

‎CLAUDE.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,5 @@
1818
- **Data Structure**: Validate payloads against OpenAPI specifications
1919
- **Best Practice**: Create summary.csv for each endpoint directory
2020
- **File Format**: All files must end with a newline
21+
22+
IMPORTANT! Every payload file in a given folder must have a unique set of parameters. Duplicate parameter sets across files in the same folder are not allowed.

‎openapi_files/api_entreprise.yaml‎

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ paths:
300300
enregistrée dans le système. Elle est donc variable d'une
301301
entreprise à l'autre. \n \n Plus d'informations sur le site
302302
de l'URSSAF : https://www.urssaf.fr/portail/home/employeur/declarer-et-payer/obtenir-une-attestation/attestation-de-vigilance.html"
303-
example: https://storage.entreprise.api.gouv.fr/siade/1569139162-b99824d9c764aae19a862a0af-attestation_vigilance_acoss.pdf
303+
example: https://raw.githubusercontent.com/etalab/siade_staging_data/refs/heads/develop/payloads/api_entreprise_v4_acoss_attestations_sociales/attestation_vigilance_test.pdf
304304
expires_in:
305305
type: integer
306306
example: 7889238
@@ -796,7 +796,7 @@ paths:
796796
title: URL Certificat
797797
description: URL de téléchargement du certificat
798798
type: string
799-
example: https://www.qualypso.fr/download_file.php?id=545cf132-b12f-445d-bcde-56a5b235b1d0
799+
example: https://raw.githubusercontent.com/etalab/siade_staging_data/refs/heads/develop/payloads/api_entreprise_v3_ademe_certificats_rge/exemple-ademe-rge-certificat_qualibat.pdf
800800
nom_certificat:
801801
title: Nom du certificat
802802
description: libéllé du certificat
@@ -2600,7 +2600,7 @@ paths:
26002600
nullable: true
26012601
description: Ce lien délivre l'attestation au format PDF.
26022602
Ce document est automatiquement supprimé après 10 minutes.
2603-
example: https://storage.entreprise.api.gouv.fr/siade/1569139162-b99824d9c764aae19a862a0af-certificat_cibtp.pdf
2603+
example: https://raw.githubusercontent.com/etalab/siade_staging_data/refs/heads/develop/payloads/api_entreprise_v3_cibtp_attestation_cotisations_conges_payes_chomage_intemperies/test_cibtp_certificat.pdf
26042604
expires_in:
26052605
title: Expiration du lien
26062606
description: Nombre de secondes avant expiration du document
@@ -2959,7 +2959,7 @@ paths:
29592959
title: Lien vers le certificat CNETP
29602960
description: Ce lien délivre l'attestation au format PDF.
29612961
Ce document est automatiquement supprimé après 24h.
2962-
example: https://storage.entreprise.api.gouv.fr/siade/1569139162-b99824d9c764aae19a862a0af-certificat_cnetp.pdf
2962+
example: https://raw.githubusercontent.com/etalab/siade_staging_data/refs/heads/develop/payloads/api_entreprise_v3_cnetp_attestation_cotisations_conges_payes_chomage_intemperies/test_cnetp_certificat.pdf
29632963
expires_in:
29642964
type: integer
29652965
example: 7889238
@@ -4444,7 +4444,7 @@ paths:
44444444
title: URL de téléchargement de l'attestation fiscale (.pdf)
44454445
description: Ce lien donne accès à l'attestation fiscale au
44464446
format PDF.
4447-
example: https://storage.entreprise.api.gouv.fr/siade/1569139162-b99824d9c764aae19a862a0af-attestation_fiscale_dgfip.pdf
4447+
example: https://entreprise.api.gouv.fr/files/attestation-fiscale-dgfip-exemple.pdf
44484448
expires_in:
44494449
type: integer
44504450
example: 7889238
@@ -4907,7 +4907,7 @@ paths:
49074907
type: string
49084908
description: Ce lien donne accès à l'attestation fiscale au
49094909
format PDF.
4910-
example: https://storage.entreprise.api.gouv.fr/siade/1569139162-b99824d9c764aae19a862a0af-attestation_fiscale_dgfip.pdf
4910+
example: https://entreprise.api.gouv.fr/files/attestation-fiscale-dgfip-exemple.pdf
49114911
document_url_expires_in:
49124912
title: Délai avant expiration de l'URL de téléchargement du
49134913
document'
@@ -11092,7 +11092,7 @@ paths:
1109211092
title: Lien vers la carte professionnelle
1109311093
description: Ce document est automatiquement supprimé au bout
1109411094
de 3 mois.
11095-
example: https://storage.entreprise.api.gouv.fr/siade/1569139162-b99824d9c764aae19a862a0af-carte_professionnelle_fntp.pdf
11095+
example: https://raw.githubusercontent.com/etalab/siade_staging_data/refs/heads/develop/payloads/api_entreprise_v3_fntp_carte_professionnelle_travaux_publics/carte_professionnelle_tp_test.pdf
1109611096
expires_in:
1109711097
type: integer
1109811098
example: 7889238
@@ -11412,6 +11412,18 @@ paths:
1141211412
required: true
1141311413
schema:
1141411414
type: string
11415+
- name: nature_effectif
11416+
in: query
11417+
description: Nature de l'effectif demandé. Par défaut, l'effectif moyen est
11418+
renvoyé.
11419+
schema:
11420+
type: string
11421+
default: moyen
11422+
enum:
11423+
- moyen
11424+
- boeth
11425+
- ecap
11426+
- assujettissement_oeth
1141511427
security:
1141611428
- jwt_bearer_token: []
1141711429
description: Effectifs annuels des régimes général et agricole d'une unité légale,
@@ -11566,6 +11578,9 @@ paths:
1156611578
type: string
1156711579
enum:
1156811580
- effectif_moyen_annuel
11581+
- effectif_boeth_annuel
11582+
- effectif_ecap_annuel
11583+
- effectif_assujettissement_oeth_annuel
1156911584
date_derniere_mise_a_jour:
1157011585
title: Date de la dernière mise à jour de la donnée
1157111586
type: string
@@ -11837,6 +11852,18 @@ paths:
1183711852
default: 0
1183811853
minimum: 0
1183911854
maximum: 12
11855+
- name: nature_effectif
11856+
in: query
11857+
description: Nature de l'effectif demandé. Par défaut, l'effectif moyen est
11858+
renvoyé.
11859+
schema:
11860+
type: string
11861+
default: moyen
11862+
enum:
11863+
- moyen
11864+
- boeth
11865+
- ecap
11866+
- assujettissement_oeth
1184011867
security:
1184111868
- jwt_bearer_token: []
1184211869
description: Effectifs mensuels des régimes général et agricole d'un établissement,
@@ -11989,6 +12016,9 @@ paths:
1198912016
type: string
1199012017
enum:
1199112018
- effectif_moyen_mensuel
12019+
- effectif_boeth_mensuel
12020+
- effectif_ecap_mensuel
12021+
- effectif_assujettissement_oeth_mensuel
1199212022
annee:
1199312023
title: Année
1199412024
type: string
@@ -26770,7 +26800,7 @@ paths:
2677026800
title: Lien vers l'attestation de cotisation retraite ProBTP
2677126801
description: Ce document est automatiquement supprimé au bout
2677226802
de 3 mois.
26773-
example: https://storage.entreprise.api.gouv.fr/siade/1569139162-b99824d9c764aae19a862a0af-attestation_cotisation_retraite_probtp.pdf
26803+
example: https://raw.githubusercontent.com/etalab/siade_staging_data/refs/heads/develop/payloads/api_entreprise_v3_probtp_attestations_cotisation_retraite/test_probtp_attestation.pdf
2677426804
expires_in:
2677526805
type: integer
2677626806
example: 7889238
@@ -27546,7 +27576,7 @@ paths:
2754627576
title: Lien vers la certification batiment Qualibat
2754727577
description: Cette URL permet de télécharger la certification
2754827578
Qualibat au format PDF.
27549-
example: https://storage.entreprise.api.gouv.fr/siade/1635521735-1a675fc210d09e04604aabe5e93b452fb56865f5-certificat_qualibat.pdf
27579+
example: https://raw.githubusercontent.com/etalab/siade_staging_data/refs/heads/develop/payloads/api_entreprise_v4_qualibat_certifications_batiment/exemple-qualibat.pdf
2755027580
expires_in:
2755127581
type: integer
2755227582
example: 7889238
@@ -28007,7 +28037,7 @@ paths:
2800728037
type: string
2800828038
description: Cette URL permet de télécharger la certification
2800928039
Qualibat au format PDF.
28010-
example: https://storage.entreprise.api.gouv.fr/siade/1635521735-1a675fc210d09e04604aabe5e93b452fb56865f5-certificat_qualibat.pdf
28040+
example: https://raw.githubusercontent.com/etalab/siade_staging_data/refs/heads/develop/payloads/api_entreprise_v4_qualibat_certifications_batiment/exemple-qualibat.pdf
2801128041
document_url_expires_in:
2801228042
title: Nombre de secondes avant expiration du document référencé
2801328043
dans 'document_url'
@@ -28534,7 +28564,7 @@ paths:
2853428564
description: Ce lien délivre le certificat Qualifelec
2853528565
de l'entreprise au format PDF tel qu'accessible depuis
2853628566
le site https://www.qualifelec.fr/.
28537-
example: https://github.com/etalab/siade_staging_data/blob/develop/payloads/api_entreprise_v3_qualifelec_certificats/exemple-certificat-qualifelec-bac-a-sable.jpg
28567+
example: https://raw.githubusercontent.com/etalab/siade_staging_data/refs/heads/develop/payloads/api_entreprise_v3_qualifelec_certificats/exemple-certificat-qualifelec-bac-a-sable.jpg
2853828568
numero:
2853928569
title: Numéro du certificat
2854028570
type: number
@@ -29620,7 +29650,7 @@ paths:
2962029650
nullable: true
2962129651
description: Ce lien délivre l'attestation de vigilance de
2962229652
l'entreprise au format PDF.
29623-
example: https://storage.entreprise.api.gouv.fr/siade/1569139162-b99824d9c764aae19a862a0af-attestation_vigilance_acoss.pdf
29653+
example: https://raw.githubusercontent.com/etalab/siade_staging_data/refs/heads/develop/payloads/api_entreprise_v4_acoss_attestations_sociales/attestation_vigilance_test.pdf
2962429654
document_url_expires_in:
2962529655
title: Nombre de secondes avant expiration du document référencé
2962629656
dans 'document_url'

‎openapi_files/api_particulier.yaml‎

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ paths:
6262
get:
6363
summary: "[FranceConnect] Extrait d'immatriculation véhicule"
6464
tags:
65-
- Prochainement
65+
- Extrait d'immatriculation véhicule
6666
parameters:
6767
- name: recipient
6868
in: query
@@ -166,20 +166,23 @@ paths:
166166
type: integer
167167
description: L'année de naissance du demandeur.
168168
example: 1990
169+
nullable: true
169170
mois_date_naissance:
170171
title: Mois de naissance
171172
type: integer
172173
description: Le mois de naissance du demandeur.
173174
minimum: 1
174175
maximum: 12
175176
example: 3
177+
nullable: true
176178
jour_date_naissance:
177179
title: Jour de naissance
178180
type: integer
179181
description: Le jour de naissance du demandeur.
180182
minimum: 1
181183
maximum: 31
182184
example: 15
185+
nullable: true
183186
code_departement_naissance:
184187
title: Code département de naissance
185188
type: string
@@ -555,6 +558,47 @@ paths:
555558
type: object
556559
meta:
557560
type: object
561+
properties:
562+
identity_matching:
563+
title: Résultats de la vérification d'identité
564+
type: object
565+
description: Résultats de la comparaison entre l'identité
566+
FranceConnect et l'identité du demandeur d'immatriculation.
567+
A noter que la validation demande exclusivement une correspondance
568+
sur le nom de famille et le prénom. La correspondance sur
569+
la date de naissance n'est pas prise en compte dans cette
570+
validation mais est fournie à titre informatif.
571+
properties:
572+
family_name:
573+
title: Nom de famille correspond
574+
type: number
575+
format: float
576+
description: Indique si le nom de famille correspond entre
577+
FranceConnect et l'identité ANTS.
578+
example: 1.0
579+
given_name:
580+
title: Prénom correspond
581+
type: number
582+
format: float
583+
description: Indique si le prénom correspond entre FranceConnect
584+
et l'identité ANTS.
585+
example: 1.0
586+
birth_date:
587+
title: Date de naissance correspond
588+
type: number
589+
format: float
590+
description: Indique si la date de naissance correspond
591+
entre FranceConnect et l'identité ANTS.
592+
example: 0.0
593+
overall_match:
594+
title: Correspondance globale
595+
type: boolean
596+
description: Indique si l'identité correspond globalement
597+
(nom de famille et prénom).
598+
example: true
599+
required:
600+
- identity_matching
601+
additionalProperties: false
558602
required:
559603
- data
560604
- links

‎payloads/api_entreprise_v3_gip_mds_effectifs_annuels_entreprise/200-boeth.yaml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
description: 'GIP-MDS effectifs annuels entreprise 200 avec nature_effectif boeth'
3+
params:
4+
siren: '130025265'
5+
year: '2024'
6+
nature_effectif: boeth
7+
status: 200
8+
payload: |-
9+
{
10+
"data": {
11+
"siren": "130025265",
12+
"annee": "2024",
13+
"effectifs_annuel": [
14+
{
15+
"regime": "regime_general",
16+
"value": 3,
17+
"nature": "effectif_moyen_annuel",
18+
"date_derniere_mise_a_jour": "2024-01-01"
19+
}
20+
]
21+
},
22+
"links": {
23+
},
24+
"meta": {
25+
}
26+
}

‎payloads/api_entreprise_v3_gip_mds_effectifs_annuels_entreprise/README.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,62 @@
174174
--url "https://staging.entreprise.api.gouv.fr/v3/gip_mds/unites_legales/130025265/effectifs_annuels/2024"
175175
```
176176

177+
</p>
178+
</details>
179+
* [200-boeth.yaml](200-boeth.yaml)
180+
181+
Status `200`
182+
183+
GIP-MDS effectifs annuels entreprise 200 avec nature_effectif boeth
184+
185+
<details><summary>Paramètres</summary>
186+
<p>
187+
188+
```json
189+
{
190+
"siren": "130025265",
191+
"year": "2024",
192+
"nature_effectif": "boeth"
193+
}
194+
```
195+
196+
</p>
197+
</details>
198+
199+
<details><summary>Réponse API</summary>
200+
<p>
201+
202+
```json
203+
{
204+
"data": {
205+
"siren": "130025265",
206+
"annee": "2024",
207+
"effectifs_annuel": [
208+
{
209+
"regime": "regime_general",
210+
"value": 3,
211+
"nature": "effectif_moyen_annuel",
212+
"date_derniere_mise_a_jour": "2024-01-01"
213+
}
214+
]
215+
},
216+
"links": {},
217+
"meta": {}
218+
}
219+
```
220+
221+
</p>
222+
</details>
223+
224+
<details><summary>Commande cURL</summary>
225+
<p>
226+
227+
```bash
228+
curl -H "Authorization: Bearer $token" \
229+
-G -d 'recipient=10000001700010' -d 'context=Contexte+de+la+requ%C3%AAte' -d 'object=Objet+de+la+requ%C3%AAte' \
230+
--url "https://staging.entreprise.api.gouv.fr/v3/gip_mds/unites_legales/130025265/effectifs_annuels/2024"
231+
```
232+
177233
</p>
178234
</details>
179235
* [404.yaml](404.yaml)

‎payloads/api_entreprise_v3_gip_mds_effectifs_annuels_entreprise/summary.csv‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,24 @@ Titre,Description,Paramètres,Status,Réponse
6565
""meta"": {
6666
}
6767
}"
68+
,GIP-MDS effectifs annuels entreprise 200 avec nature_effectif boeth,"{""siren"":""130025265"",""year"":""2024"",""nature_effectif"":""boeth""}",200,"{
69+
""data"": {
70+
""siren"": ""130025265"",
71+
""annee"": ""2024"",
72+
""effectifs_annuel"": [
73+
{
74+
""regime"": ""regime_general"",
75+
""value"": 3,
76+
""nature"": ""effectif_moyen_annuel"",
77+
""date_derniere_mise_a_jour"": ""2024-01-01""
78+
}
79+
]
80+
},
81+
""links"": {
82+
},
83+
""meta"": {
84+
}
85+
}"
6886
,Chiffre d'affaire annuels entreprise 404,"{""siren"":""000000000"",""year"":""2020""}",404,"{
6987
""errors"": [
7088
{

0 commit comments

Comments
 (0)