 |
API Sirene - Documentation des services |
 |
Service informations : Appel du service. En-tête de la requête, variables de la réponse et résultat
Le service informations permet de connaître l'état de chaque collection (disponible ou non), ainsi que les dates de rafraîchissement.
Présentation du service
Il s’agit d'un service simple, s'appelant sans paramètre et renvoyant des informations sur les autres services d'API Sirene.Le service distingue pour chaque type de données (collection) trois dates :
dateDerniereMiseADisposition
Les données sont mises à jour quotidiennement et intègrent les modifications enregistrées au répertoire Sirene la veille. Une fois par jour, les données consultées basculent de J-2 à J-1. En pratique quelques milliers d'unités voient leur situation évoluer, la grande majorité des unités restent inchangées. Pour un traitement d'un utilisateur qui utilise la pagination, cette bascule pourrait engendrer des incohérences entre une page appelée juste avant la dateDerniereMiseADisposition et une page appelée juste après (présence d'un même établissement sur les 2 pages par exemple).
dateDernierTraitementMaximum
Toutes les données enregistrées dans le répertoire Sirene jusqu'à cette date sont accessibles par le service API Sirene. Cette date intéresse un utilisateur cherchant à mettre à jour une copie des données.
dateDernierTraitementDeMasse
Entre 1 et 3 fois dans l'année, des traitements de gestion peuvent impacter un très grand nombre d'unités (par exemple la mise à jour annuelle des effectifs peut concerner plus de 3 millions d'unités légales en une seule fois)
Cette date intéresse un utilisateur cherchant à mettre à jour une copie des données. Elle permet de savoir que la mise à jour est exceptionnellement volumineuse ce qui peut impliquer un traitement différent. Concrètement, si le jour de dateDernierTraitementUniteLegale (ou Etablissement) est le même jour que dateDernierTraitementDeMasse, le volume de mise à jour est très important (plus de 200 000 Unités légales et leurs établissements). Une information sur le contenu de cette mise à jour sera disponible sur le catalogue des API.
En fonction de son besoin, l'utilisateur pourra effectuer la mise à jour normalement, ignorer la journée ou repartir d'un fichier stock de data.gouv.fr.
Appel du service
Il s’agit d’un service web de type REST, qui s’appuie donc uniquement sur les protocoles et standards utilisés sur le web. 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. L’authentification se fait en passant votre clé d’accès dans l’en-tête Authorization.
L’appel utilise la clé d’accès fourni par le catalogue. Chaque appel compte dans votre quota d'interrogations de l'API Sirene.
URL d’accès au service des refus d'immatriculation au RCS :
https://api.insee.fr/api-sirene/3.11/informations
Attention : Prochainement, la présence de l’en-tête content-type dans une requête GET générera systématiquement une erreur HTTP 415
En-tête de la requête
Le seul format de données produit correspond à Accept application/json.
Le contenu de la réponse peut être compressé afin de limiter sa taille. L'algorithme de compression utilisé est le gzip.
Pour recevoir une réponse compressée, il faut ajouter dans l'en-tête HTTP le paramètre Accept-Encoding et le valoriser à gzip.
Résultat
Le résultat est fourni au format Json. Le retour est structuré en 3 parties :
Commentaires
Le sercice informations est disponible sur la console. Pour en savoir plus