Skip to content

Commit 4a16b54

Browse files
mise à jour README
1 parent bd06ef4 commit 4a16b54

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,11 @@
1313

1414
## Français
1515

16-
### 🚀 Nouvelle fonctionnalité
16+
### ⚠️⚠️⚠️ Prise en compte de la nouvelle API Sirene
1717

18+
Depuis juillet 2025, le _package_ utilise le nouvel endpoint de l'API Sirene ; la syntaxe de requête demeure identique. Seule la méthode d'identification change : en lieu et place des variables d'environnement `INSEE_APP_KEY` et `INSEE_APP_SECRET`, il faut définir une variable `INSEE_API_TOKEN` dans le fichier `.Renviron`. La valeur de cette variable est obtenue en suivant la procédure décrite [ici](https://portail-api.insee.fr/catalog/api/2ba0e549-5587-3ef1-9082-99cd865de66f/doc?page=85c5657d-b1a1-4466-8565-7db1a194667b#usage-de-la-cl%C3%A9-dapi-pour-requ%C3%AAter-lapi-sirene) et en insérant la valeur de la clé d'API obtenue dans la variable d'environnement en question.
19+
20+
#### 📝 À noter également !
1821
Le catalogue de données intègre désormais les données mises à disposition dans [l'API Melodi](https://portail-api.insee.fr/catalog/all). Outre la [liste de données](https://raw.githubusercontent.com/InseeFrLab/DoReMIFaSol/refs/heads/master/data-raw/liste_donnees.json) disponible dans le _package_, les données listées dans le catalogue de Melodi sont intégrées _via_ [ce fichier](https://minio.lab.sspcloud.fr/pierrelamarche/melodi/liste_donnees.json) qui est mis quotidiennement à jour.
1922

2023
### De quoi s'agit-il ?
@@ -75,7 +78,7 @@ donnees_estel <- telechargerDonnees("ESTEL_T201", date = 2018)
7578

7679
#### Requêter une API REST : le répertoire d'entreprises Sirene
7780

78-
Supposons que l'on cherche maintenant à récupérer l'ensemble des établissements rattachés à une unité légale créée le 1er janvier 2020 ; pour cela, on peut par exemple envoyer une requête sur l'API REST Sirene de l'Insee. Pour cela, il faut au préalable avoir configuré un accès à l'API REST de l'Insee et passer en variables d'environnement les données d'identification. La procédure est expliquée par exemple [ici](https://github.com/InseeFrLab/apinsee#exemple). Une fois cela réalisé, la requête peut se faire facilement au travers de `doremifasol` de la manière suivante :
81+
Supposons que l'on cherche maintenant à récupérer l'ensemble des établissements rattachés à une unité légale créée le 1er janvier 2020 ; pour cela, on peut par exemple envoyer une requête sur l'API REST Sirene de l'Insee. Pour cela, il faut au préalable avoir configuré un accès à l'API REST de l'Insee et passer en variable d'environnement la clé d'API. La procédure pour obtenir une clé d'API est expliquée [ici](https://portail-api.insee.fr/catalog/api/2ba0e549-5587-3ef1-9082-99cd865de66f/doc?page=85c5657d-b1a1-4466-8565-7db1a194667b#usage-de-la-cl%C3%A9-dapi-pour-requ%C3%AAter-lapi-sirene). La variable d'environnement consommée par `doremifasol` est `INSEE_API_TOKEN` Une fois cela réalisé, la requête peut se faire facilement au travers de `doremifasol` de la manière suivante :
7982

8083
```r
8184
etablissements <- telechargerDonnees("SIRENE_SIRET",
@@ -95,7 +98,11 @@ Agent du Service Statistique Public, ou utilisateur des données mises à dispos
9598

9699
## English
97100

98-
### 🚀 New Feature
101+
### ⚠️⚠️⚠️ New API endpoint
102+
103+
From July 2025 onwards, `doremifasol` queries the new endpoint for Sirene's API, the French firms' register. The process for authentification is described [here](https://portail-api.insee.fr/catalog/api/2ba0e549-5587-3ef1-9082-99cd865de66f/doc?page=85c5657d-b1a1-4466-8565-7db1a194667b#usage-de-la-cl%C3%A9-dapi-pour-requ%C3%AAter-lapi-sirene). Once provided with an API key, the user must create (through the `.Renviron` file for instance) an environment variable called `INSEE_API_TOKEN`.
104+
105+
#### 📝 Worth noting!
99106

100107
The data catalog now includes data made available in the [Melodi API](https://portail-api.insee.fr/catalog/all). In addition to the [list of data](https://raw.githubusercontent.com/InseeFrLab/DoReMIFaSol/refs/heads/master/data-raw/liste_donnees.json) available in the package, the data listed in the Melodi catalog is integrated via [this file](https://minio.lab.sspcloud.fr/pierrelamarche/melodi/liste_donnees.json) which is updated on a daily basis.
101108

@@ -142,6 +149,13 @@ Tax data are very convenient to carry out information on income distribution at
142149

143150
#### Requesting an API REST on the firms' register _Sirene_
144151

152+
Assume you would like to fetch all firms created on 1<sup>st</sup> January 2020. To this end you may query the Sirene API, for which you'll need to get an API key. The procedure to get one is described [here](https://portail-api.insee.fr/catalog/api/2ba0e549-5587-3ef1-9082-99cd865de66f/doc?page=85c5657d-b1a1-4466-8565-7db1a194667b#usage-de-la-cl%C3%A9-dapi-pour-requ%C3%AAter-lapi-sirene). You'll have to insert the value of this key in an environment variable called `INSEE_API_TOKEN`. Once done, you may proceed with the script below:
153+
154+
```r
155+
etablissements <- telechargerDonnees("SIRENE_SIRET",
156+
argsApi = list(q = "dateCreationUniteLegale:2020-01-01"))
157+
```
158+
145159

146160
### Contributing
147161

0 commit comments

Comments
 (0)