API Refuges.info

Introduction à l'API

Refuges.info est un service web personnel et non commercial permettant de se renseigner sur les hébergements de montagnes destinés aux randonneurs. Ce service est collaboratif et les informations sur les refuges (coordonnées, commentaires et discussions) ont été renseignées par l'ensemble des utilisateur du service.

L'API Refuges permet de recevoir dans de nombreux formats une liste de points, des informations détaillées sur un point ou encore les résultats de requêtes spéciales telles que la recherche de points ou les nouvelles contributions. L'API est disponible en lecture seule uniquement, et aucune autentification ou clé d'API n'est requise.

Nous vous invitons à vous abonner à la newsletter de l'API (en haut à droite) de manière à être informé des évolutions qui pourraient apparaître et afin de nous aider à établir des statistiques d'utilisations de l'API. Note : Les mails sont stockés sur notre serveur mais ne seront en aucun cas partagés à des tiers. En vous abonnant vous acceptez tout de même de recevoir un mail de notre part, ce qui ne va pas arriver souvent ;).

Les données du site Refuges.info sous sont licence CC By-Sa 2.0, cependant l'API permet aussi de retourner des données provenant d'OpenStreetMap via sa fonction de recherche, ces données sont sous licence ODbL. Plus d'informations sur la licence des contenus, la licence d'OpenStreetMap, et le code source du site ou vous pouvez contribuer avec plaisir.

Sommaire de l'API

Export d'une liste de points

Informations détaillées sur un point

Requêtes à la base de donnée

Export d'une liste de points

Sélection de la zone via une bbox

La requête GET/api/bbox permet de retourner une liste de points au sein d'une bbox. Les paramètres sont définis dans le tableau suivant, et vous trouverez au dessous des exemples de structuration des réponses.

ParamètreDescriptionValeur par défautExemples
bbox Requis Les dimensions de la bbox à exporter : ouest, sud, est, nord. Il est possible de sélectionner la planète entière via la valeur world. Aucune -13.00,44.05,17.00,49.79, world...
format Optionnel Le format de l'export. geojson geojson, kmz, kml, gml, gpx, csv, xml, rss
format_texte Optionnel Le formatage du texte, que vous devrez retravailler par la suite. bbcode bbcode, texte, markdown, html
nb_coms Optionnel Nombre de commentaires maximum à retourner. Retourne aucun commentaire pour 0. Retourne les n commentaires les plus récents. 0 18...
nb_points Optionnel Nombre de points à exporter (le choix est fait par un algorithme interne avec prioritées élevées pour les abris et cabanes, et faibles pour refuges, sommets, cols...). all retournera tous les points de la zone, mais à utiliser avec précautions (lecture illisible et charge serveur importante). 121 1500,all...
detail Optionnel Les détails du point, par défaut uniquement long, lat, altitude, nom, type, id et lien. complet est disponible uniquement lorsque format est geojson, xml.
Aussi disponible en gpx (pour avoir un fichier léger) et en rss (complet conseillé pour afficher les remarques diverses).
simple simple, complet
type_points Optionnel Les types de point à exporter, parmis la liste suivante : cabane, refuge, gite, pt_eau, sommet, pt_passage, bivouac et lac
ou leur équivament numérique: 7, 10, 9, 23, 6, 3, 19, 16. La valeur all sélectionne tous les types.
all all, cabane,refuge,gite...

Notons que lorsque les variables booléennes, sont à 1 pour VRAI et 0 pour FAUX (par exemple pour les informations complémentaires). Lorsqu'une variable est non définie (NULL), c'est tout simplement que nous le champ n'a pas de valeur car il n'a pas lieu d'être (couvertures pour un sommet par exemple) ou que la valeur est inconnue.

Voici un exemple de requête : api/bbox?bbox=5.5,45.1,6.5,45.6&type_points=all&nb_points=2

Sélection de la zone via des massifs

La requête GET/api/massif permet de retourner une liste de points au sein d'un ou plusieurs massif(s). Les paramètres sont définis dans le tableau suivant, et vous trouverez au dessous des exemples de structuration des réponses.

ParamètreDescriptionValeur par défautExemples
massif Requis L'id du ou des massif(s) à exporter (ces ids peuvent être récupérés via la requête GET/api/polygones). Les ids sont séparés par des virgules lorsqu'ils sont plusieurs. Aucune 8,9,11, 352...
bbox Optionnel Ajoute une contrainte de zone au points à rechercher. Seul les points du massif ET inclus dans la bbos seront retournés. Il est possible de sélectionner la planète entière via la valeur world. world -13.00,44.05,17.00,49.79, world...
format Optionnel Le format de l'export. geojson geojson, kmz, kml, gml, gpx, csv, xml, rss
format_texte Optionnel Le formatage du texte, que vous devrez retravailler par la suite. bbcode bbcode, texte, markdown, html
nb_coms Optionnel Nombre de commentaires maximum à retourner. Retourne aucun commentaire pour 0. Retourne les n commentaires les plus récents. 0 18...
nb_points Optionnel Nombre de points à exporter (le choix est fait par un algorithme interne avec prioritées élevées pour les abris et cabanes, et faibles pour refuges, sommets, cols...). all retournera tous les points de la zone, mais à utiliser avec précautions (lecture illisible et charge serveur importante). 121 1500,all...
detail Optionnel Les détails du point, par défaut uniquement long, lat, altitude, nom, type, id. complet est disponible uniquement lorsque format est geojson, xml.
Aussi disponible en gpx (pour avoir un fichier léger) et en rss (complet conseillé pour afficher les remarques diverses).
simple simple, complet
type_points Optionnel Les types de point à exporter, parmis la liste suivante : cabane, refuge, gite, pt_eau, sommet, pt_passage, bivouac et lac
ou leur équivament numérique: 7, 10, 9, 23, 6, 3, 19, 16. La valeur all sélectionne tous les types.
all all, cabane,refuge,gite...

Notons que lorsque les variables booléennes, sont à 1 pour VRAI et 0 pour FAUX (par exemple pour les informations complémentaires). Lorsqu'une variable est non définie (NULL), c'est tout simplement que nous le champ n'a pas de valeur car il n'a pas lieu d'être (couvertures pour un sommet par exemple) ou que la valeur est inconnue.

Voici un exemple de requête : api/massif?massif=351&type_points=all&nb_points=22

Informations détaillées sur un point

La requête GET/api/point permet de retourner les informations détaillées d'un point de la base de donnée à partir de son ID. Les paramètres sont définis dans le tableau suivant, et vous trouverez au dessous des exemples de structuration des réponses.

ParamètreDescriptionValeur par défautExemples
id Requis L'id du point dont on veut des informations Aucune 2536...
bbox Optionnel Ajoute une contrainte de zone au point à rechercher. Le point sera retourné que s'il est inclu dans la bbox. Il est possible de sélectionner la planète entière via la valeur world. world -13.00,44.05,17.00,49.79, world...
format Optionnel Le format de l'export. geojson geojson, kmz, kml, gml, gpx, csv, xml, rss
format_texte Optionnel Le formatage du texte, que vous devrez retravailler par la suite. bbcode bbcode, texte, markdown, html
nb_coms Optionnel Nombre de commentaires maximum à retourner. Retourne aucun commentaire pour 0. Retourne les n commentaires les plus récents. 5 18...
nb_points_proches Optionnel Nombre de points proches à retourner. Retourne les n points les plus proches, dans un rayon de 5 km autour du point. 3 6...
detail Optionnel Les détails du point, par défaut uniquement long, lat, altitude, nom, type, id. complet est disponible uniquement lorsque format est geojson, xml.
Aussi disponible en gpx (pour avoir un fichier léger) et en rss (complet conseillé pour afficher les remarques diverses).
complet simple, complet

Notons que lorsque les variables booléennes, sont à 1 pour VRAI et 0 pour FAUX (par exemple pour les informations complémentaires). Lorsqu'une variable est non définie (NULL), c'est tout simplement que nous le champ n'a pas de valeur car il n'a pas lieu d'être (couvertures pour un sommet par exemple) ou que la valeur est inconnue.

Voici un exemple de requête : api/point?id=583&format=xml&format_texte=html&nb_coms=100&nb_points_proches=5

Requêtes à la base de donnée

Recherche dans la base de données

En cours de développement

Dernières contributions

La requête GET/api/contributions permet de retourner les dernières contributions sur refuges.info.

ParamètreDescriptionValeur par défautExemples
type Optionnel Le ou les types de contributions à lister, à choisir parmis points (tous les ajouts de points), refuges (tous les ajouts de points pouvant servir d'abris, exclut donc lac, sources...), commentaires et forums (ne concerne pas le forum de développement). points,commentaires points,commentaires,forums, forums...
format Optionnel Le format de l'export. json json, csv, xml, rss
format_texte Optionnel Le formatage du texte, que vous devrez retravailler par la suite. bbcode bbcode, texte, markdown, html
nombre Optionnel Le nombre de contributions à retourner, bloqué à 100 (nous contacter si ce n'est pas suffisant). 15 42...
massif Optionnel L'id du ou des massif(s) à exporter (ces ids peuvent être récupérés via la requête GET/api/polygones). Les ids sont séparés par des virgules lorsqu'ils sont plusieurs. Tous les massifs 8,9,11, 352...

Notons que lorsque les variables booléennes, sont à 1 pour VRAI et 0 pour FAUX (par exemple pour les informations complémentaires). Lorsqu'une variable est non définie (NULL), c'est tout simplement que nous le champ n'a pas de valeur car il n'a pas lieu d'être (couvertures pour un sommet par exemple) ou que la valeur est inconnue.

Voici un exemple de requête : api/contributions?format=rss&format_texte=html&massif=351

Polygones de la base de donnée (massifs, parcs, cartes...)

La requête GET/api/polygones permet de retourner tous les polygones de la base de donnée, incluant massifs, emprises de cartes, limites administratives...

ParamètreDescriptionValeur par défautExemples
format Optionnel Le format de l'export des polygones. geojson geojson, gml.
massif Optionnel L'id du ou des massif(s) à exporter (ces ids peuvent être récupérés via la requête GET/api/polygones). Les ids sont séparés par des virgules lorsqu'ils sont plusieurs. Tous les massifs 8,9,11, 352...
bbox Optionnel Les dimensions de la bbox à exporter : ouest, sud, est, nord. Il est possible de sélectionner la planète entière via la valeur world. world -13.00,44.05,17.00,49.79, world...
intersection Optionnel Retourne tous les polygones ayant une intersection avec celui-ci. 352, 50...
type_polygon Optionnel Les types de polygones à exporter, par exemple 1 pour les massifs. Les séparer par une virgule lorsqu'ils sont plusieurs. Tous les polygones 8,9,11, 352...
type_geom Optionnel Le types de géométrie rendu: "polygones" affiche des polygones pleins et coloriés tandis que "polylines" n'affiche que le contour. polygones polygones, polylines

Voici un exemple de requête : api/polygones?format=gml