Développeur · API v1
Vos parcours Compath, sur votre site.
L'API Compath renvoie les parcours de votre compte avec tout ce que l'application en connaît : trace, dénivelé, points de passage, points d'intérêt, textes et photos. De quoi construire une page « Nos itinéraires » toujours à jour, sans double saisie.
Obtenir une clé
La clé est liée à votre compte Compath et délivrée par notre équipe. Écrivez-nous en précisant l'adresse email de votre compte.
Lister vos parcours
GET /routes renvoie vos parcours page par page. Chacun porte un lien links.self vers son détail.
Lire un parcours
GET /routes/{id}renvoie toutes ses données, et les photos sous forme de tableau d'URL prêtes à afficher.
Démarrage rapide
Envoyez la clé dans l'en-tête Authorization: Bearer (ou X-API-Key) de chaque requête.
curl https://compath.store/api/v1/routes \
-H "Authorization: Bearer cpk_votre_cle"curl https://compath.store/api/v1/routes/{id} \
-H "Authorization: Bearer cpk_votre_cle"// Côté serveur uniquement (Node 18+, PHP, Python…)
const res = await fetch("https://compath.store/api/v1/routes?limit=50", {
headers: { Authorization: `Bearer ${process.env.COMPATH_API_KEY}` },
});
const { data, links } = await res.json();
for (const route of data) {
const detail = await fetch(route.links.self, {
headers: { Authorization: `Bearer ${process.env.COMPATH_API_KEY}` },
}).then((r) => r.json());
console.log(detail.data.name, detail.data.photos.map((p) => p.url));
}
// links.next donne la page suivante, null sur la dernière.?visibility=public. Une clé compromise se révoque sur simple demande.Référence
Spécification OpenAPI 3 : https://compath.store/api/v1/openapi, à importer dans Postman, Insomnia ou un générateur de client.