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/api/v2/siren/{siren}

Paramètres

{siren} : numéro à 9 chiffres (paramètre obligatoire)

Résultat

La réponse est fournie au format json.

Le retour est structuré en deux parties :

  • Le 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 ;
  • Le profil qui comprend l'empreinte sociétale et la description de l'unité légale (caractéristiques)

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

VariableTypeLongueurContenuCommentaire
valueNombre-Valeur de l'indicateur-
flagCaractère1Indication sur l'origine de la valeur ("p" : publiée, "e": estimée, "d": défaut)-
uncertaintyNombre-Incertitude sur la valeur en pourcentage de la valeur-
yearChaine de caractères4Année de référence (pour les données publiées : exercice fiscale)-
sourceChaine de caractères-Origine de la valeur-
infoTexte-Complément d'information sur la valeur-
codeChaine de caractères3Code de l'indicateur-
unitChaine de caractères-Unité-
libelleChaine de caractères-Libellé de l'indicateur-
valueDeclaredBooléen-Valeur déclarée-
libelleFlagChaine de caractères-Libellé du flag-

Variables présentes pour la description de l'unité légale

VariableTypeLongueurContenuCommentaire
sirenChaine de caractères9Numéro de siren de l'unité légale-
categorieJuridiqueChaine de caractères4Code relatif à la catégorie juridique de l'unité légale-
denominationChaine de caractères-Dénomination de l'unité légale-
denominationUsuelleChaine de caractères-Dénomination usuelle de l'unité légale-
sigleChaine de caractères-Sigle de l'unité légale-
codePostalSiegeChaine de caractères5Code postal du siège social-
activitePrincipaleChaine de caractères6Code de l'activité principale de l'unité légale-
activitePrincipaleLibelleChaine de caractères-Libelle de l'activité principale de l'unité légale-
trancheEffectifsChaine de caractères2Code relatif à la tranche d'effectifs de l'unité légale-
valueDeclaredBooléen-Valeur déclarée-
isEconomieSocialeSolidaireBooléen-Enregistrement de la structure en tant que structure de l'ESS-
isActivitesArtisanalesBooléen-Présence d'un établissement dont l'activité principale est enregistrée au registre des Métiers-
isLocalisationEtrangerBooléen-Présence d'un établissement situé à l'étranger-
isEmployeurBooléen-Caractère employeur de l'unité légale-
communeSiegeChaine de caractères-Libellé de la commune du siège social-

Exemple

{"header": {
 "statut": 200,
 "message": "OK"},
"profil": {
 "empreinteSocietale": {
  "ECO": {
   "value": 87.7,
   "flag": "e",
   "uncertainty": 61.8,
   "year": "2019",
   "source": ", SIRENE",
   "info": "Valeur correspondante à l'empreinte des consommations de la branche d'activité \"activités juridiques, comptables, de gestion, d'architecture, d'ingénierie, de contrôle et d'analyses techniques\"",
   "code": "ECO",
   "unit": "%",
   "libelle": "Contribution à l'Economie nationale",
   "valueDeclared":false,


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/api/v2/defaultdata?activity={activity}

Paramètres

{siren} : numéro à 9 chiffres (paramètre obligatoire)
{geo} : espace économique, code à 3 lettres (paramètre obligatoire)
{flow} : numéro à 9 chiffres (paramètre obligatoire)

Résultat

La réponse est fournie au format json.

Le retour est structuré en deux parties :

  • Le 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 ;
  • Le profil qui comprend l'empreinte sociétale et la description de l'unité légale (caractéristiques)

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