API

Documentation et non exhaustive de l'API.

Authentification

L'authentification actuellement n'est possible que de façon générale, via un jeton "administrateur".

Il existe plusieurs possibilité techniques pour réaliser cette authentification, correspondant à différents outils et différentes époques. Pour rappel ce projet logiciel avait vocation à être un drop-in replacement d'un projet plus ancien.

Ces possibilités sont :

• La fourniture d'un paramètre key={token} dans la query string. (Déprécié ⚠️)
• La fourniture d'un paramètre {key: token} dans la corps de la requête pour les requêtes de type POST (en JSON ou URLEncoded suivant le type de requête. (Déprécié ⚠️)
• La fourniture d'un en-tête HTTP Authorization: Token {token} (Recommandé ✅)

La grande majorité des API exposant des données statistiques sont librement accessibles sans authentification.

Statistiques

GET /stats (http://tickets.coworking-metz.fr/stats)

Retourne des chiffres-clés sur la fréquentation, le nombre de coworkeurs, de nouveaux coworkeurs au cours des périodes écoulées (jours, semaine, mois, année, depuis le début).

Les valeurs sont ici en français snake_case, et la réponse disponible en JSON uniquement

Exemple de réponse :

{
  "nb_coworkers_veille": 21,
  "nb_coworkers_semaine_precedente": 58,
  "nb_coworkers_mois_precedent": 74,
  "nb_coworkers_annee_precedente": 137,
  "nb_coworkers_debut": 550,
  "nb_jours_presence_veille": 21,
  "nb_jours_presence_semaine_precedente": 146,
  "nb_jours_presence_mois_precedent": 511,
  "nb_jours_presence_annee_precedente": 5351,
  "nb_jours_presence_debut": 33310,
  "nb_jours_coworkes_veille": 17,
  "nb_jours_coworkes_semaine_precedente": 120,
  "nb_jours_coworkes_mois_precedent": 416.5,
  "nb_jours_coworkes_annee_precedente": 4446,
  "nb_jours_coworkes_debut": 27117,
  "nb_nvx_coworkers_mois_precedent": 8,
  "nb_nvx_coworkers_annee_precedente": 53
}

GET /stats/:periodType

TODO

GET /stats/incomes/:periodType

TODO

GET /api/users-stats 🔒

TODO