Services
Cette documentation présente les fonctionnalités des services web mis à disposition par La Société Nouvelle pour l'accès aux empreintes sociétales des entreprises françaises.
Empreinte Sociétale - Interrogation unitaire par numéro de siren
Le service d'interrogation unitaire permet d'obtenir l'empreinte sociétale d'une l'unité légale à partir de son numéro de siren.
Appel du service
Il s'agit d'un service web de type REST. L'invocation du service se fait par envoi d'une requête HTTPS (de type GET) sur une URL publique. Le résultat est communiqué dans le contenu de la réponse HTTPS
URL d'accès au service :https://api.lasocietenouvelle.org/legalunitfootprint/{siren}
Paramètres
{siren} : numéro à 9 chiffres (paramètre obligatoire)
Résultat
La réponse est fournie au format json.
Le retour comporte quatre parties :
- header - qui contient le code retour et le message d'erreur (à ne pas confondre avec l'en-tête http ni l'en-tête de réponse);
- legalUnit - données sur l'unité légale
- footprint - empreinte sociétale de l'unité légale
- metaData - métadonnées
L'empreinte sociétale comprend les 12 indicateurs identifiés par leur code (3 lettres). Elle peut également être complétée par d'autres indicateurs publiés par l'entreprise. Les variables présentes sont décrites ci-après.
Codes retour
Les codes renvoyés par les services sont les suivants :
- 200-OK : unité légale trouvée
- 400-Bad Request : format du numéro de siren incorrect
- 404-Not Found : unité légale non-trouvée
- 500-Internal Server Error : erreur interne
- 503-Service unvailable : service indisponible
Variables de la réponse
Variables présentes pour chaque indicateur
| Variable | Type | Longueur | Contenu | Commentaire |
| value | Nombre | - | Valeur de l'indicateur | - |
| uncertainty | Nombre | - | Incertitude sur la valeur en pourcentage de la valeur | - |
| year | Chaine de caractères | 4 | Année de référence (pour les données publiées : exercice fiscale) | - |
| flag | Caractère | 1 | Indication sur l'origine de la valeur ("p" : publiée, "e": estimée, "d": défaut) | - |
| source | Chaine de caractères | - | Origine de la valeur | - |
| info | Texte | - | Complément d'information sur la valeur | - |
Variables présentes pour la description de l'unité légale
| Variable | Type | Longueur | Contenu | Commentaire |
| siren | Chaine de caractères | 9 | Numéro de siren de l'unité légale | - |
| categorieJuridique | Chaine de caractères | 4 | Code relatif à la catégorie juridique de l'unité légale | - |
| denomination | Chaine de caractères | - | Dénomination de l'unité légale | - |
| denominationUsuelle | Chaine de caractères | - | Dénomination usuelle de l'unité légale | - |
| sigle | Chaine de caractères | - | Sigle de l'unité légale | - |
| codePostalSiege | Chaine de caractères | 5 | Code postal du siège social | - |
| communeSiege | Chaine de caractères | - | Commune du siège social | - |
| activitePrincipaleCode | Chaine de caractères | 6 | Code de l'activité principale de l'unité légale | - |
| activitePrincipaleLibelle | Chaine de caractères | - | Libelle de l'activité principale de l'unité légale | - |
| trancheEffectifs | Chaine de caractères | 2 | Code relatif à la tranche d'effectifs de l'unité légale | - |
| economieSocialeSolidaire | Booléen | - | Enregistrement de la structure en tant que structure de l'ESS | - |
| isActivitesArtisanales | Booléen | - | Présence d'un établissement dont l'activité principale est enregistrée au registre des Métiers | - |
| isLocalisationEtranger | Booléen | - | Présence d'un établissement situé à l'étranger | - |
| caractereEmployeur | Booléen | - | Caractère employeur de l'unité légale | - |
| societeMission | Booléen | - | Appartenance au champ des sociétés à mission | - |
Exemple
"header": {
"code": 200,
"message": "OK"
},
"legalUnit": {
"siren": "889182770",
"categorieJuridiqueCode": "5710",
"categorieJuridiqueLibelle": "SAS, société par actions simplifiée",
"denomination": "LA SOCIETE NOUVELLE",
"sigle": "",
"denominationUsuelle": "",
"codePostalSiege": "59000",
"communeSiege": "LILLE",
"activitePrincipaleCode": "70.22Z",
"activitePrincipaleLibelle": "Conseil pour les affaires et autres conseils de gestion",
"trancheEffectifs": "",
"economieSocialeSolidaire": false,
"caractereEmployeur": true,
"societeMission": false },
"footprint": {
...,
"ECO": {
"value": 84.1,
"year": "2022",
"uncertainty": 27,
"flag": "p",
"source": "",
"info": "",
"description": "Donnée publiée" },
},
}
"metaData":{
...,
"ECO": {
"isBeta": false,
"indicatorLabel": "Contribution à l'économie nationale",
"unitLabel": "pourcentage",
"unitSymbol": "%",
"unitCode": "P100" },
}
}Données par défaut
Le service permet d'obtenir des données par défaut à partir d'un code d'activité, d'un espace économique et d'un agrégat.
Appel du service
Il s'agit d'un service web de type REST. L'invocation du service se fait par envoi d'une requête HTTPS (de type GET) sur une URL publique. Le résultat est communiqué dans le contenu de la réponse HTTPS
URL d'accès au service :https://api.lasocietenouvelle.org/defaultfootprint?code={activity}&area={area}&aggregate={aggregate}
Paramètres
{activity} : code de la division économique
{area} : espace économique, code à 3 lettres
{aggregate} : code de l'agrégat économique
Résultat
La réponse est fournie au format json.
Le retour est structuré en trois parties :
- Partie header (à ne pas confondre avec l'en-tête http ni l'en-tête de réponse) qui contient le code retour et le message d'erreur ;
- Partie footprint qui comprend l'empreinte sociétale et la description de l'unité légale (caractéristiques)
- Partie metaData
Codes retour
Les codes renvoyés par les services sont les suivants :
- 200-OK : unité légale trouvée
- 400-Bad Request : format du numéro de siren incorrect
- 404-Not Found : unité légale non-trouvée
- 500-Internal Server Error : erreur interne
- 503-Service unvailable : service indisponible