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 des points ou encore les résultats de requêtes spéciales telles que la recherche de 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.
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 point d'eau par exemple) ou que la valeur est inconnue.
Voici un exemple de requête : api/massif?massif=351&type_points=all&nb_points=22
Les requêtes GET /api/box /api/massif /api/point permettent de retourner les informations détaillées de points de la base de donnée. Les paramètres sont définis dans le tableau suivant, et vous trouverez au dessous des exemples de structuration des réponses.
| Paramètre de sélection | Description | Valeur par défaut | Exemples |
|---|---|---|---|
| bbox | Optionnel Ajoute une contrainte de zone aux points à rechercher. Le point ne 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... |
| massif | /api/massif : Optionnel les id des massifs à 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... |
| id | /api/point : Requis l'id d'un seul point | Aucune | 2536, 104,457... |
| types_point | Optionnel les id des types de points à exporter, séparés par des virgules lorsqu'ils sont plusieurs. | Aucun | 7(cabane non gardée), 9(gîte d'étape), 10(refuge gardé)... |
| depuis | Optionnel Sélectionne les points modifiés depuis une date. | 0 | Secondes depuis 1/1/1970 |
| nb_points | Optionnel Nombre maximum 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, ...). all retournera tous les points de la zone, mais à utiliser avec précautions (lecture illisible et charge serveur importante). |
bbox:250 massif:250 point:1 |
1500,all... |
| cache | Optionnel Nombre de secondes pendant lesquelles le résultat de la requette sera mis en cache par l'explorateur. | 60 | 86400, ... |
| Paramètre de contenu | Description | Valeur par défaut | Exemples |
| detail | Optionnel N'est disponible que lorsque format est geojson. icone : longitude, latitude, altitude, nom, type, id & icone. simple : idem + état, places & lien. complet : toutes les informations disponibles sur les points. fiche : idem + les commentaires. |
simple | icone, simple, complet, fiche |
| 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. | html | bbcode, texte, markdown, html |
| cache | Optionnel Nombre de secondes pendant lesquelles le résultat de la requette sera mis en cache par l'explorateur. | 60 | 86400, ... |
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 point d'eau par exemple) ou que la valeur est inconnue.
Voici un exemple de requête : api/point?id=583&format=xml&format_texte=html
La requête GET/api/commentaires permet de retourner les commentairess 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_point | Requis L'id du point ou des points dont on veut les commentaires | Aucune | 2536 583,2536... |
| format_texte | Optionnel Le formatage du texte, que vous devrez retravailler par la suite. | bbcode | bbcode, texte, markdown, html |
| format | Fixe Le format de l'export. | json | Le seul format json est accepté |
| cache | Optionnel Nombre de secondes pendant lesquelles le résultat de la requette sera mis en cache par l'explorateur. | 60 | 86400, ... |
Voici un exemple de requête : api/commentaires?id=583&format_texte=html
La requête GET/api/contributions permet de retourner les dernières contributions sur refuges.info.
| Paramètre de sélection | 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 point d'eau ou passages délicats), commentaires et forums (ne concerne pas le forum de développement). | points,commentaires | points,commentaires,forums, forums... |
| 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 ... |
| nombre | Optionnel Le nombre de contributions à retourner, 100 par défaut. | 15 | 42... |
| Paramètre de contenu | Description | Valeur par défaut | Exemples |
| format | Optionnel Le format de l'export. | rss | json, csv, xml, rss |
| format_texte | Optionnel Le formatage du texte, que vous devrez retravailler par la suite. | bbcode | bbcode, texte, markdown, html |
| 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 |
| cache | Optionnel Nombre de secondes pendant lesquelles le résultat de la requette sera mis en cache par l'explorateur. | 60 | 86400, ... |
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 point d'eau 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 de sélection | Description | Valeur par défaut | Exemples |
|---|---|---|---|
| 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... | |
| Paramètre de contenu | Description | Valeur par défaut | Exemples |
| format | Optionnel Le format de l'export des polygones. | geojson | geojson, gml. |
| 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