API VTTour
L'API vous permet d'effectuer des requêtes sur la base topos/sorties de VTTour pour alimenter votre propre application. Chaque requête doit être signée dans le header avec un paramètre "cle" à récupérer depuis la page de modification de votre profil.
Conditions d'utilisation de l'API
- L'utilisation de l'API est ouverte à toutes les applications, qu'elles soient commerciales ou non.
- Une application = une clé. Le nombre de transactions est limité à 1000 pour 24 heures et 60 par minute. Vous avez plus de besoins ? merci de nous contacter. Vos statistiques de consommation sont disponibles sur la page stats.
- Les données sur VTTour sont sous licence CC by-sa 4.0 (Données collaborative du topoguide) et CC-by-nc-nd 4.0 (Données personnelle = sorties textes et photos). Vous pouvez les utiliser dans le respect de la licence, de façon brute ou compliée.
- Chaque page qui présente des données issues de l'API (qu'elles soient brutes ou compilées) doit fournir un lien vers la ressource liée sur VTTour.fr (ou directement vers l'index dans le cas de données compilées) et citer l'auteur le cas échéant. L'utilisation de photos hors contexte est soumise à autorisation préalable de l'auteur.
Besoin d'aide ? Besoins particuliers ? Merci de nous contacter !
GET
/api/departements
Récupère la liste des departements
Exemple cURL :
curl -X GET -H "cle: yYOlbMcps8rOuUCdVDTwbawLXO26IHLM" "https://vttour.fr/api/departements"
Réponse :
GET
/api/massifs
Récupère la liste des massifs
Exemple cURL :
curl -X GET -H "cle: yYOlbMcps8rOuUCdVDTwbawLXO26IHLM" "https://vttour.fr/api/massifs"
Réponse :
JSON exemple
Massifs ou
JSON {"ERROR":"type"}
GET
/api/topos
Récupère une liste de topos
Paramètres (facultatifs) :
- d -> id_departements (recherche les topos liés aux départements ex 38,05,73,74)
- ll -> lat,lon (recherche les topos proche de la position lat,lon fournie)
- f -> from id (recherche les topos dont l'id est supérieur ou égal à f)
- n -> nombre maximum de résultats retournés, 100 par défaut, 1000 maximum
- p -> numéro de page, 1 par défaut
Exemple cURL :
curl -X GET -H "cle: yYOlbMcps8rOuUCdVDTwbawLXO26IHLM" "https://vttour.fr/api/topos?ll=45.5,7.1"
Réponse :
JSON exemple
Topos ou
JSON {"ERROR":"type"}
GET
/api/topo/{id}
Récupère le topo {id}
Exemple cURL :
curl -X GET -H "cle: yYOlbMcps8rOuUCdVDTwbawLXO26IHLM" "https://vttour.fr/api/topo/125"
Réponse :
JSON exemple
Topo ou
JSON {"ERROR":"type"}
GET
/api/sorties
Récupère une liste de sorties, triées par date DESC
Paramètres (facultatifs) :
- a -> année (ex : a=2023 retournera les sorties de l'année 2023)
- f -> from id (retourne les sorties dont l'id est supérieur ou égal à f)
- dept -> id département
- ll -> lat,lon (recherche autour de la position lat,lon)
- depart -> depuis le départ id_depart
- g -> fichier GPX associé (g=1)
- u -> id auteur ou id participant
- n -> nombre maximum de résultats retournés, 100 par défaut, 1000 maximum
- p -> numéro de page, 1 par défaut
Exemple cURL :
curl -X GET -H "cle: yYOlbMcps8rOuUCdVDTwbawLXO26IHLM" "https://vttour.fr/api/sorties?a=2023&dept=05"
Réponse :
JSON exemple
Sorties ou
JSON {"ERROR":"type"}
GET
/api/sentiers
Récupère une liste de sentiers
Paramètres (facultatifs) :
- f -> from id (retourne les sentiers dont l'id est supérieur ou égal à f)
- ll -> lat,lon (recherche autour de la position lat,lon)
- massif -> id_massif
- dept -> id département
- n -> nombre maximum de résultats retournés, 100 par défaut, 1000 maximum
- p -> numéro de page, 1 par défaut
Exemple cURL :
curl -X GET -H "cle: yYOlbMcps8rOuUCdVDTwbawLXO26IHLM" "https://vttour.fr/api/sentiers?m=12"
Réponse :
JSON exemple
sentiers ou
JSON {"ERROR":"type"}