Aller au contenu
Codes et API

Apidae

En bref
Pour qui
Développeurs et data scientists qui travaillent en R.
Mise à jour
Script du dépôt, recopié à chaque génération du portail.

Ce que fait le script, ses paquets, l'authentification demandée, puis le code complet (secrets masqués).

Données utilisées

L'API ou le service Apidae (https://dev.apidae-tourisme.com/).

Récupère les sélections du projet ApidaeTourisme : Réseau et base de données touristiques alimentés par les offices de tourisme d'Auvergne-Rhône-Alpes et d'autres territoires : hébergements, activités, événements, sites. Accessible par une API avec clé. du hackathon, puis les objets touristiques (offres, lieux, événements) de ces sélections.

ScriptApidae.R
LangageR
Paquetshttr2, jsonlite, dplyr, tibble
AuthentificationClé d'APIDonnées et outils : Interface de programmation. Adresse web qu'un programme interroge pour recevoir des données (souvent en JSON) au lieu de télécharger un fichier. Certaines demandent une clé d'accès, à ne jamais publier. et identifiant de projet (9657) : clé du hackathon dans l'Excel du SSP CloudDonnées et outils : Plateforme de travail de l'Insee pour la statistique publique (logiciel Onyxia) : RStudio, Jupyter ou VS Code dans le navigateur, et un stockage S3 où sont déposées les données du hackathon..
Documentationhttps://dev.apidae-tourisme.com/

La fiche du script : le fichier R du dépôt (lien vers GitHub), les paquets à installer avec install.packages(), l'accès demandé et la documentation de l'API.

Accès

Clé d'API et identifiant de projet (9657) : clé du hackathon dans l'Excel du SSP Cloud. Ne jamais publier une clé dans le dépôt : la lire depuis une variable d'environnement (Sys.getenv("MA_CLE")).

Ce que fait le script

  1. Lister les sélections disponibles dans le projet (referentiel/selections).
  2. Choisir les identifiants de sélection à interroger.
  3. Interroger recherche/list-objets-touristiques (100 premiers objets par défaut, à paginer avec first et count).

Code

Apidae.R
### Récupérer la sélection Apidae et les identifiants ### library(httr2) library(jsonlite) projet_id <- 9657 requete <- list( projetId = projet_id, apiKey = "<MOT_DE_PASSE_DU_HACKATHON>" #Clé pour le hackathon dispo dans l'excel données à disposition ) reponse <- request( "https://api.apidae-tourisme.com/api/v002/referentiel/selections/" ) |> req_body_form( query = toJSON(requete, auto_unbox = TRUE) ) |> req_perform() selections <- resp_body_json(reponse) selections ### Visualiser la sélection possible dans le projet ### str(selections) ### Ouvrir les jeux de données ### # Installer les packages si nécessaire install.packages(c("httr2", "jsonlite", "dplyr", "tibble")) # Charger les packages library(httr2) library(jsonlite) library(dplyr) library(tibble) # --------------------------------------------------------- # 1. Informations de connexion Apidae # --------------------------------------------------------- projet_id <- 9657 selection_id <- list(211884,211888,211889,211890,211891,211892,211905,211906,211908,211911,211914,211999) #Modifier ici la sélection api_key <- "<MOT_DE_PASSE_DU_HACKATHON>" # --------------------------------------------------------- # 2. Construire la requête (ici sur les 100 premiers, à modifier) # --------------------------------------------------------- requete <- list( projetId = projet_id, apiKey = api_key, selectionIds = selection_id, count = 100, first = 0 ) # --------------------------------------------------------- # 3. Interroger l'API Apidae # --------------------------------------------------------- url <- "https://api.apidae-tourisme.com/api/v002/recherche/list-objets-touristiques/" reponse <- request(url) |> req_method("POST") |> req_body_form( query = toJSON(requete, auto_unbox = TRUE) ) |> req_error(is_error = function(resp) FALSE) |> req_perform() # --------------------------------------------------------- # 4. Récupérer les données # --------------------------------------------------------- donnees <- resp_body_json(reponse) # Afficher la structure de la réponse str(donnees) names(donnees$objetsTouristiques[[1]]) #colonnes dispos

Limites

À garder en tête

  • Les clés, jetons et identifiants sont masqués ici ; les vrais sont dans l'Excel du SSP Cloud et ne doivent jamais être publiés.
  • Script fourni avec le hackathon, non relancé par le portail : les quotas, les adresses d'API et les versions de paquets peuvent avoir changé.