Webcams SpotAiR - API
URL d'accès
L'URL d'accès à l'API est : https://webcams.spotair.mobi/get.php
Clef d'accès
Pour accéder -gratuitement- à ces données, vous devez tout d'abord me demander une clef d'accès.
Ce fonctionnement est mis en place pour éventuellement contrôler et éviter les abus. En effet les serveurs
du site ne sont pas dimensionnés pour encaisser un trafic important (cf règles à respecter).
Pour obtenir votre clef, envoyez moi un message motivé à
webcams@spotair.mobi, j'y répondrai volontiers favorablement.
Règles à respecter
Une fois votre clef d'accès obtenue, vous vous engagez à l'utiliser à condition :
- de respecter la licence à laquelle sont soumises les données des webcams (cf
mentions légales)
- d'accéder de façon mesurée (au maximum 1 fois par jour par terminal) au serveur.
Je vous encourage vivement à utiliser et bien maitriser le paramètre 'derniereMaj' de l'API (cf ci-dessous).
Pour la bonne marche du serveur, je me réserve le droit de vous couper l'accès si vous ne respectez pas ces règles.
Paramètres de la requête
L'API peut être accédée par les méthodes GET ou POST. Je vous recommande la méthode POST.
Les paramètres sont les suivants, sauf mention contraire, la plupart ne sont pas obligatoires :
- apiKey (obligatoire) : la clef d'accès à l'API (attention à l'encoder si vous utilisez la méthode GET)
- sortie (obligatoire) : format des données des balises, 'json' pour un format JSON, 'csv' pour un format CSV
- derniereMaj (recommandé !) : timestamp unix (en secondes) depuis la dernière MAJ. Cela permet d'avoir un différentiel des webcams
ajoutées, modifiées ou supprimées depuis la dernière MAJ. Cela permet de limiter le volume de données transférées en
ne retournant que les données qui ont changé
- pays : code pays des webcams à retourner (2 lettres ISO)
- id : id de la webcam à retourner
- etat : 'I' pour les webcams invalides (=supprimées), 'V' pour les webcams valides. Par défaut aucune sélection n'est
faite sur l'état des webcams retournées
- statutsKo : '0' pour les webcams en ligne et non figées (par défaut), '1' pour les webcams hors ligne ou figées seulement,
'2' pour toutes les webcams
- coordonnees : pour ne récupérer que les webcams dans une zone donnée, au format 'latmin,latmax,lngmin,lngmax' où
latmin et latmax sont les latitudes mini et maxi, lngmin et lngmax les longitudes mini et maxi (au format décimal)
Format de la réponse
La réponse est de type JSON avec les attributs suivants :
- code : entier, 0 si aucune erreur, >0 si erreur
- msg : chaine de caractères, 'OK' si aucune erreur, un message explicite sur la nature de l'erreur sinon
- data : la liste des webcams en cas de succès, au format JSON ou CSV selon la demande
Si le format demandé est JSON :
- id : l'identifiant unique de la webcam (entier)
- etat : 'V' pour valide, 'I' pour invalide (=supprimée)
- nom : le nom de la webcam (chaine de caractères)
- pays : code ISO du pays sur 2 lettres
- pratiques : masque binaire des pratiques (2^0 : parapente, 2^1 : kite, 2^2 : ski, 2^3 : autres)
- latitude : la latitude (décimal)
- longitude : la longitude (décimal)
- altitude : l'altitude en mètres (entier)
- direction : direction vers laquelle pointe la webcam (mesurée en degrés entiers par rapport au Nord dans le sens horaire)
- champ : amplitude en degrés du champ de vision
- url_image (nullable) : l'URL de l'image
- periodicite (nullable) : la périodicité en minutes à laquelle est mise à jour l'image
- decalage_periodicite (nullable) : le décalage de périodicité
- fuseau_horaire (nullable) : le fuseau horaire du lieu où se trouve la webcam
- code_locale (nullable) : le code langue du lieu où se trouve la webcam
- largeur : largeur de l'image en pixels
- hauteur : hauteur de l'image en pixels
- url_page (nullable) : l'URL de la page d'accueil de la webcam
- description (nullable) : description textuelle
- statut_enligne : 'E' pour en ligne, 'H' pour hors ligne
- statut_variable : 'V' pour variable, 'F' pour figée
Si le format demandé est CSV : les valeurs apparaissent dans l'ordre cité ci-dessus pour le JSON.