API Refuges.info
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.
Vous pouvez nous suivre, rapporter des bugs ou soumettre des évolution de l'api sur la page github de refuges.info
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.
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ètre | Description | Valeur par défaut | Exemples |
|---|---|---|---|
| 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_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). | 250 | 1500,all... |
| cluster | Optionnel S'il y a plusieurs points dans un carré de <décimal> degrès de latitude et longitude (environ 100 km pour 1°), ils sont regroupés et représentés par un picto "cluster" (un cercle bleu avec le nombre de points regroupés). | Aucune | 0.1,<décimal> |
| detail | Optionnel N'est disponible que lorsque format est geojson. Quand simple uniquement long, lat, altitude, nom, type, id et icone. Quand complet toutes les informations disponibles sur les points. | 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
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ètre | Description | Valeur par défaut | Exemples |
|---|---|---|---|
| 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 aux points à rechercher. Seul les points du massif ET inclus dans la bbox 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_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 N'est disponible que lorsque format est geojson. Quand simple seul uniquement long, lat, altitude, nom, type, id et icone. Quand complet toutes les informations disponibles sur les points | 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
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ètre | Description | Valeur par défaut | Exemples |
|---|---|---|---|
| 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 |
| detail | Optionnel N'est disponible que lorsque format est geojson. Quand simple uniquement long, lat, altitude, nom, type, id et icone. Quand complet toutes les informations disponibles sur les points. | 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
En cours de développement
La requête GET/api/contributions permet de retourner les dernières contributions sur refuges.info.
| Paramètre | Description | Valeur par défaut | Exemples |
|---|---|---|---|
| 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, 100 par défaut. | 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... |
| ids_forum | Optionnel L'id du ou des forum(s) à exporter. Les ids sont séparés par des virgules lorsqu'ils sont plusieurs. | Tous les forums | 1,2,4,5,6 ... |
| avec_texte | Optionnel Faut-il exporter le texte des posts sur le forum ? | Faux | 0,1 |
| avec_photo | Optionnel Faut-il exporter la photo d'un commentaire ? | Faux | 0,1 |
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
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ètre | Description | Valeur par défaut | Exemples |
|---|---|---|---|
| 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