Modification de Usage de l'API
Aller à la navigation
Aller à la recherche
La modification peut être annulée. Veuillez vérifier les différences ci-dessous pour voir si c’est bien ce que vous voulez faire, puis publier ces changements pour finaliser l’annulation de cette modification.
Version actuelle | Votre texte | ||
Ligne 1 : | Ligne 1 : | ||
== Informations générales == | == Informations générales == | ||
L'API (Application Programming Interface) Poids-Plume permet d'accéder aux données en utilisant des outils informatiques, plutôt que via les visualisations proposées sur le site web. C'est le point d'entrée privilégié si vous souhaitez analyser les données du projet, ou encore télécharger les données de votre mangeoire. | L'API (Application Programming Interface) Poids-Plume permet d'accéder aux données en utilisant des outils informatiques, plutôt que via les visualisations proposées sur le site web. C'est le point d'entrée privilégié si vous souhaitez analyser les données du projet, ou encore télécharger les données de votre mangeoire. | ||
Ligne 23 : | Ligne 21 : | ||
* '''sig''': Un HMAC sha-256 de votre requête et de votre clé d'API (voir code bash ci-dessous) | * '''sig''': Un HMAC sha-256 de votre requête et de votre clé d'API (voir code bash ci-dessous) | ||
La code de réponse http de la page peut être 400 (Bad request) si les | La code de réponse http de la page peut être 400 (Bad request) si les paramêtres ci-dessus sont mal définis, 403 (Forbidden) si l'accès est refusé ou 404 si aucune donnée correspondante n'a été trouvée. Un message plus explicite expliquant pourquoi la requête a raté est renvoyé si besoin. Si la requête en bien formulée, un code de réponse 200 (OK) est renvoyé, et les données sont transférées au client. | ||
Concrètement, les données se présentent sous la forme d'un fichier '.xz' contenant des données tabulaires au format texte (les valeurs étant séparées par des tabulations, voir aussi les | Concrètement, les données se présentent sous la forme d'un fichier '.xz' contenant des données tabulaires au format texte (les valeurs étant séparées par des tabulations, voir aussi les informatiosn sur les [[Données_téléchargées|données téléchargées]]). Il faut extraire | ||
ce fichier (avec '''tar -xf''' par exemple), puis les données peuvent être (enfin) lues avec votre logiciel préféré. En pratique, on utilisera la plupart du temps des outils | ce fichier (avec '''tar -xf''' par exemple), puis les données peuvent être (enfin) lues avec votre logiciel préféré. En pratique, on utilisera la plupart du temps des outils intermédiaire pour effectuer ce travail. | ||
=== Outils === | === Outils === | ||
Ligne 33 : | Ligne 31 : | ||
Le script bash ci-dessous devrait pouvoir vous permettre d'effectuer une requête de données via l'API en téléchargeant des données pour une combinaison mangeoire/date/type de données. Il faut remplacer les champs '''API_USER''' et '''API_KEY''' par leurs valeurs (attention à ne pas faire fuiter ces informations publiquement !). Il peut servir également d'une implémentation de référence pour d'autres implémentations. | Le script bash ci-dessous devrait pouvoir vous permettre d'effectuer une requête de données via l'API en téléchargeant des données pour une combinaison mangeoire/date/type de données. Il faut remplacer les champs '''API_USER''' et '''API_KEY''' par leurs valeurs (attention à ne pas faire fuiter ces informations publiquement !). Il peut servir également d'une implémentation de référence pour d'autres implémentations. | ||
#!/bin/bash | #!/bin/bash | ||
Ligne 65 : | Ligne 61 : | ||
--output "${DATATYPE}_${FEEDER}_$DATE.xz" \ | --output "${DATATYPE}_${FEEDER}_$DATE.xz" \ | ||
"https://data.poids-plume.fr/data.php" | "https://data.poids-plume.fr/data.php" | ||
tar -xf "${DATATYPE}_${FEEDER}_$DATE.xz" | |||