Récupérer le planning
Le scénario est le suivant : une application à destination des membres du club affiche le planning de la semaine.
Avant de commencer
Soyons certains que nous parlons des mêmes notions.
Le contact
Il s’agit du client qui souhaite faire une réservation. Pour ne pas confondre avec son éventuel statut (prospect, client, ancien client ...), on le nommera contact dans ce document.
L'activité
Il s'agit de la typologie d'exercices qui sont pratiqués lors d'un cours de fitness.
Le studio
Il s'agit du lieu physique où aura lieu le cours, un club peut avoir plusieurs studios et un studio est lié à un club.
Comprendre les calendriers
Un calendrier regroupe différents cours et un cours peut appartenir à plusieurs calendriers. Ce sont autant de vues différentes de l'ensemble des cours disponibles.
Par exemple, un cours de cycling qui a lieu dans le studio 1 du club de Paris 18eme avec le coach John sera disponible sur les calendriers suivants :
- le calendrier du cycling
- le calendrier du studio 1
- le calendrier de John
A noter qu'il n'existe pas de calendrier lié au club, on sollicite pour cela l'ensemble des calendriers des studios du club.
Requêter les cours d'une période
Préalablement à la prise de réservation, il est habituel de proposer la liste des cours prévus sur une période. Vous allez donc requêter une liste complète ou une vue partielle liée aux calendriers désirés.
Faire une requête GET à l'API Resamania comme suit :
https://{api_base_url}/{client_token}/events?startedAt={started_at}&endedAt={ended_At}&calendars[]={calendar_id}
Se référer au tableau ci dessous pour les paramètres de la requête
paramètre | description |
---|---|
api_base_url | L'url de l'API que vous souhaitez utiliser. Celle-ci varie selon les environnements d'intégration et de production |
client_token | Chaque chaîne de club possède son identifiant Resamania appelé client_token |
started_at | Date et heure de début incluse (format YYYY-MM-ddTHH:mm:ss, exemple 2019-09-30T00:00:00) |
ended_at | Date et heure de fin incluse (format YYYY-MM-ddTHH:mm:ss, exemple 2019-09-30T24:00:00) |
calendars[] | Liste des calendriers souhaités. Un calendrier est identifié par l'id textuel de sa ressource. Par exemple pour un coach /{client_token}/coaches/{id} |
Connaître les activités
Lors de l'affichage du planning, interroger le référentiel des activités est un incontournable.
Faire une requête GET à l'API Resamania comme suit :
https://{api_base_url}/{client_token}/activities?archived=true
Se référer au tableau ci dessous pour les paramètres de la requête
paramètre | description |
---|---|
api_base_url | L'url de l'API que vous souhaitez utiliser. Celle-ci varie selon les environnements d'intégration et de production |
client_token | Chaque chaîne de club possède son identifiant Resamania appelé client_token |
archived | Inclue les activités archivées (false par défaut) |
Connaître les studios
De même que pour les activités, le référentiel de studio est une requête que l'on ne peut s'économiser.
Faire une requête GET à l'API Resamania comme suit :
https://{api_base_url}/{client_token}/studios
Connaître les coachs
Dernier référentiel inévitable lors de l'interrogation des calendriers, la liste des coachs.
Faire une requête GET à l'API Resamania comme suit :
https://{api_base_url}/{client_token}/coaches