API Cadre de vie des communes v1
Présentation
L’API Cadre de vie des communes proposée par eTerritoire restitue des données sur les communes de France. Elle permet d'obtenir des informations sur les infrastructures d'une commune.
La v1 de l’API restitue les informations suivantes :
- Code INSEE de la commune
- Nom de la commune
- URL correspondant à la page commune du site eTerritoire.fr, qui donne de nombreuses informations sur les 36000 communes de France
- Coordonnées GPS de la commune
- Données sur le nombre d’équipements sportifs, de santé, d’éducation, de loisirs, et de services publics présents dans la commune
- Nom des communes à proximité
Selon plusieurs études, les deux principaux freins à la mobilité sont le manque d’opportunités professionnelles et la méconnaissance du cadre de vie. Cette API a donc pour but d’encourager la mobilité grâce à une meilleure connaissance de nos territoires.
Caractéristiques
| Mode d'accès | public |
| Fréquence de mise à jour |
temps réel |
| Cinématique OAuth | |
| Royaume Pôle Emploi Access Management |
/partenaire |
| Scopes nécessaires |
|
Description de la requête
Point d'accès
GET https://api.emploi-store.fr/partenaire/eterritoire/v1/cadre-de-vie.php
Paramètres d'entrée
| Code | Cardinalité | Format | Description | Obligatoire |
|---|---|---|---|---|
| dep |
1,1 |
Integer 2 |
numéro du département à appeler (84 = Département du Vaucluse) |
non |
| proxycom | 2,1 | Integer 2, Integer 3 |
5 communes à proximité, sur une distance de 10km (30 communes est le maximum) |
non |
Exemple d'appel
GET https://api.emploi-store.fr/partenaire/eterritoire/v1/cadre-de-vie.php?dep=84&proxycom=5,10
Authorization: Bearer [Access token]
Description de la réponse
L'API retourne une liste de commune(s)
Données retournées
| Code | Cardinalité | Format | Description |
|---|---|---|---|
| idinsee | 1,1 | Integer 5 | code INSEE de la commune |
| nom | 1,1 | String |
nom de la commune |
| url | 1,1 | String | URL de la page commune du site eterritoire.fr |
| pop | 1,1 | Integer | population de la commune |
| equipements | 1,1 | Sous balise |
nombre d’équipements dans la commune |
| equipements.Équipements sportifs | 1,1 | Integer |
nombre d’équipements sportifs |
| equipements.Santé | 1,1 | Integer | nombre d’équipements de santé |
| equipements.Éducation | 1,1 | Integer |
nombre d’équipements d’éducation |
| equipements.Loisirs | 1,1 | Integer | nombre d’équipements de loisirs |
| equipements.Services publics | 1,1 | Integer | nombre d’équipements de services publics |
| gps | 2,1 | [Double, Double] | coordonnées GPS de la commune |
| proxycom | 1,1 | Sous balise | communes à proximité (selon paramètre défini) |
| ncom | 1,1 | String |
nom de la n-ième commune à proximité |
| cp | 1,1 | Integer 5 | code postal de la n-ième commune à proximité |
| distance | 1,1 | Double |
distance en km de la n-ième commune à proximité |
| pop | 1,1 | Integer |
population de la n-ième commune à proximité |
Exemple de retour
HTTP 200 OK
Content-Type: application/json;charset=UTF-8
[
{
"idinsee": "84001",
"nom": "Althen-des-Paluds",
"url": "/territoires/provence-alpes-cote-d-azur/vaucluse/althen-des-paluds/84001/34080#a2",
"pop": "2671",
"equipements": {
"Équipements sportifs": 6,
"Santé": 19,
"Éducation": 3,
"Loisirs": 2,
"Services publics": 1
},
"gps": [
44.004444122314,
4.9577779769897
],
"proxycom": [
{
"ncom": "Entraigues-sur-la-Sorgue",
"cp": 84320,
"distance": 2.44,
"pop": 8230
},
{
"ncom": "Monteux",
"cp": 84170,
"distance": 4.72,
"pop": 12537
},
{
"ncom": "Vedène",
"cp": 84270,
"distance": 5.13,
"pop": 11045
},
{
"ncom": "Saint-Saturnin-lès-Avignon",
"cp": 84450,
"distance": 5.59,
"pop": 4830
},
{
"ncom": "Bédarrides",
"cp": 84370,
"distance": 6.19,
"pop": 5010
}
]
}
]
Cas d'erreurs possibles
Retrouvez la liste des cas d'erreurs possibles sur la page Erreurs Types.