API VisuGPX

Interrogez les serveurs de VisuGPX depuis votre propre application pour soumettre des fichiers ou récupérer des données ! Tout accès à cet API nécessite un compte VisuGPX et la CLE API liée.

POST

/api/upload

Headers (* = requis):

• cle* -> clé API du compte premium (vous pouvez la demander ou la renouveller dans la page de modification du profil)

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 :

curl -X POST -H "cle: 617ace176f11786eab7811" -F "gpx=@/path/to/file.gpx" -F "name=Nom de la trace" -F "activity=vtt" "https://www.visugpx.com/api/upload"

Réponse :

POST

/api/modify/{id}

Headers (* = requis):

• cle* -> clé API du compte premium (vous pouvez la demander ou la renouveller dans la page de modification du profil)

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 :

curl -X POST -H "cle: 617ace176f11786eab7811" -F "gpx=@/path/to/file.gpx" -F "titre=Titre de la trace" -F "activity=vtt" "https://www.visugpx.com/api/modify/K32b7Eq0Uu"

Réponse :

Fichier JSON {"modified": id} avec id = id de la trace modifiée ou ERROR: Type [Voir]

POST

/api/delete/{id}

Headers (* = requis):

• cle* -> clé API du compte premium (vous pouvez la demander ou la renouveller dans la page de modification du profil)

Exemple cURL :

curl -X POST -H "cle: 617ace176f11786eab7811" "https://www.visugpx.com/api/delete/K32b7Eq0Uu"

Réponse :

Fichier JSON {"deleted": id} avec id = id de la trace supprimée ou ERROR: Type [Voir]

POST

/api/folder

Headers (* = requis):

• cle* -> clé API du compte premium (vous pouvez la demander ou la renouveller dans la page de modification du profil)

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 :

create : curl -X POST -H "cle: 617ace176f11786eab7811" -F "action=create" -F "name=NomDuDossier" -F "parent=0" "https://www.visugpx.com/api/folder"
delete : curl -X POST -H "cle: 617ace176f11786eab7811" -F "action=delete" -F "id=IdDuDossier" "https://www.visugpx.com/api/folder"
list : curl -X POST -H "cle: 617ace176f11786eab7811" -F "action=list" "https://www.visugpx.com/api/folder"

Réponse :

create : Fichier JSON {"created": id} avec id = id du dossier créé
delete : Fichier JSON {"deleted": id} avec id = id du dossier supprimé
list : Fichier JSON [Voir]

Ou ERROR: Type [Voir]

GET

/api/activities

Headers (* = requis) :

• cle* -> clé API du compte (vous pouvez la demander ou la renouveller dans la page de modification du profil)

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 :

curl -X GET -H "cle: 617ace176f11786eab7811" "https://www.visugpx.com/api/activities?activity=vr&flux=1"

Réponse :

GET

/api/activity/{id}

Headers (* = requis) :

• cle* -> clé API du compte (vous pouvez la demander ou la renouveller dans la page de modification du profil)

Exemple cURL :

curl -X GET -H "cle: 617ace176f11786eab7811" "https://www.visugpx.com/api/activity/K32b7Eq0Uu"

Réponse :