Documentation API
Vous trouverez ci-dessous la documentation API.
Sécurisation des requêtes
Chaque requête doit être signée dans l'entête (header) de la demande, au choix :
- Avec un paramètre "cle:" suivi de la clé vous avez récupéré dans votre profil (si vous souhaitez seulement accéder à votre propre compte). Ce paramètre donne un accès en lecture/ecriture.
- Avec une autorisation de type "Authorization: Bearer" suivi du token d'accès associé à l'utilisateur tiers (Documentation Oauth2) (pour un accès au comptes d'utilisateurs tiers). Un scope est associé au token d'accès qui permet un accès en lecture uniquement, ou en lecture/écriture.
Vous trouverez ci-dessous tantôt des exemples utilisant la première solution, tantôt des exemples utilisant la deuxième solution
POST
/api/upload
Crée une nouvelle trace (scope "write" uniquement)
Paramètres (* = requis) :
- gpx* -> le fichier gpx
- name* -> nom de la trace, récupéré dans le fichier si vide
- activity* -> activité (rp: randonnée pédestre, mn: marche nordique, cap: course à pied, alp: Alpinisme, tra: trail, vr: cyclotourisme, vtt: VTT, vv: voyage à vélo, vae: vélo à assistance électrique, vte: VTT à assistance électrique, ski: ski de randonnée, sa: ski alpin, srn: ski de randonnée nordique, sf: ski nordique, raq: raquettes à neige, vol: vol libre, vom: vol motorisé, req: randonnée équestre, rol: rollers, vm: auto/moto/quad, km: kayak de mer, na: natation, pv: planche à voile, au: autre)
- desc -> description de la trace
- f -> lissage des altitudes (1: faible, 2: moyen, 3: fort)
- visibility -> Visibilité de la trace sur VisuGPX (0: privée, 1: cachée (=non indexée), 2: publique)
- folder -> numéro de dossier (facultatif, infobulle au survol des dossiers dans votre profil)
- lock -> 1: Interdit le téléchargement du fichier
- flux -> 1: Ajoute le fichier à votre flux
Exemple cURL (avec authorization: Bearer) :
curl -X POST -H "Authorization: Bearer JFV7ZFhdJqwQZ28MVDN4hJOFo" -F "gpx=@\path\to\file.gpx" -F "name=Nom de la trace" -F "activity=vtt" "https://www.visugpx.com/api/upload"
Réponse :
id de la trace hébergée ou
JSON {"ERROR":"
type"}
POST
/api/modify/{id}
Modifie une trace (scope "write" uniquement)
Paramètres (tous les champs sont facultatifs) :
- gpx -> le fichier gpx
- titre -> titre de la trace
- activity -> activité (rp: randonnée pédestre, mn: marche nordique, cap: course à pied, alp: Alpinisme, tra: trail, vr: cyclotourisme, vtt: VTT, vv: voyage à vélo, vae: vélo à assistance électrique, vte: VTT à assistance électrique, ski: ski de randonnée, sa: ski alpin, srn: ski de randonnée nordique, sf: ski nordique, raq: raquettes à neige, vol: vol libre, vom: vol motorisé, req: randonnée équestre, rol: rollers, vm: auto/moto/quad, km: kayak de mer, na: natation, pv: planche à voile, au: autre)
- desc -> description de la trace
- f -> lissage des altitudes (1: faible, 2: moyen, 3: fort)
- visibility -> Visibilité de la trace sur VisuGPX (0: privée, 1: cachée (=non indexée), 2: publique)
- folder -> numéro de dossier (infobulle au survol des dossiers dans votre profil)
- lock -> Interdit/Autorise le téléchargement du fichier (0: Autorise, 1: interdit)
- flux -> Ajoute/Enlève le fichier à votre flux (0: Enlève, 1: Ajoute)
Exemple cURL (avec clé) :
curl -X POST -H "cle: yYOlbMcps8rOuUCdVDTwbawLXO26IHLM" -F "gpx=@\path\to\file.gpx" -F "titre=Titre de la trace" -F "activity=vtt" "https://www.visugpx.com/api/modify/K32b7Eq0Uu"
Réponse :
JSON {"modified": id} avec id = id de la trace modifiée ou
JSON {"ERROR":"
type"}
POST
/api/delete/{id}
Supprime une trace (scope "write" uniquement)
Exemple cURL (avec authorization: Bearer) :
curl -X POST -H "Authorization: Bearer JFV7ZFhdJqwQZ28MVDN4hJOFo" "https://www.visugpx.com/api/delete/K32b7Eq0Uu"
Réponse :
JSON {"deleted": id} avec id = id de la trace supprimée ou
JSON {"ERROR":"
type"}
POST
/api/folder
Crée, supprime ou liste les dossier (scope "write" uniquement pour création et suppression)
Paramètres (* = requis) :
- action* -> create || delete || list
- id* -> id du dossier (requis seulement si demande de suppression)
- name* -> nom du fichier (requis seulement si demande de création)
- parent* -> id du dossier parent (requis seulement si demande de création, 0 si à la racine)
Exemple cURL (avec cle et authorization: Bearer) :
create : curl -X POST -H "cle: yYOlbMcps8rOuUCdVDTwbawLXO26IHLM" -F "action=create" -F "name=NomDuDossier" -F "parent=0" "https://www.visugpx.com/api/folder"
delete : curl -X POST -H "Authorization: Bearer JFV7ZFhdJqwQZ28MVDN4hJOFo" -F "action=delete" -F "id=IdDuDossier" "https://www.visugpx.com/api/folder"
list : curl -X POST -H "cle: yYOlbMcps8rOuUCdVDTwbawLXO26IHLM" -F "action=list" "https://www.visugpx.com/api/folder"
Réponse :
create : JSON {"created": id} avec id = id du dossier créé
delete : JSON {"deleted": id} avec id = id du dossier supprimé
list : JSON [
Voir]
Ou
JSON {"ERROR":"
type"}
GET
/api/activities
Récupère la liste des traces
Paramètres (facultatifs) :
- folder -> numéro de dossier (facultatif, infobulle au survol des dossiers dans votre profil)
- activity -> activité (rp: randonnée pédestre, mn: marche nordique, cap: course à pied, alp: Alpinisme, tra: trail, vr: cyclotourisme, vtt: VTT, vv: voyage à vélo, vae: vélo à assistance électrique, vte: VTT à assistance électrique, ski: ski de randonnée, sa: ski alpin, srn: ski de randonnée nordique, sf: ski nordique, raq: raquettes à neige, vol: vol libre, vom: vol motorisé, req: randonnée équestre, rol: rollers, vm: auto/moto/quad, km: kayak de mer, na: natation, pv: planche à voile, au: autre)
- flux -> 1: récupérer uniquement les traces du flux
Exemple cURL (avec authorization: Bearer):
curl -X GET -H "Authorization: Bearer JFV7ZFhdJqwQZ28MVDN4hJOFo" "https://www.visugpx.com/api/activities?activity=vr&flux=1"
Réponse :
JSON [
Voir] avec les données des traces retournées (id, titre, nom, description, distance, dénivelé, durée, flux, visibility, lat/lng départ, ville départ, date départ) ou
JSON {"ERROR":"
type"}
GET
/api/activity/{id}
Récupère les données d'une trace/activité
Exemple cURL (avec cle):
curl -X GET -H "cle: yYOlbMcps8rOuUCdVDTwbawLXO26IHLM" "https://www.visugpx.com/api/activity/K32b7Eq0Uu"
Réponse :
JSON [
Voir] avec les données de la trace retournée (id, titre, nom, description, distance, dénivelé, durée, flux, visibility, lat/lng départ, ville départ, date départ, dossier) ou
JSON {"ERROR":"
type"}
Connection
