Ctrlk
WebsitePlatform
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Gestion des Utilisateurs

Gestion générale des utilisateurs

Récupérer une liste paginée d'utilisateurs

get

Récupérer une liste paginée d'utilisateurs

Ce point de terminaison permet à un administrateur de récupérer une liste paginée d'utilisateurs sous son compte. La réponse inclut des informations détaillées pour chaque utilisateur telles que les attributs personnels, les coordonnées et les métadonnées liées à leur compte. Exemple d'utilisation : Envoyez une requête GET à client-management/clients/ avec le token API-KEY approprié dans l'en-tête d'autorisation. Structure de la réponse :

  • users (tableau) : Une liste d'objets utilisateur, où chaque objet inclut les champs suivants :

    • created_at (string, date-time) : Horodatage de création de l'utilisateur.

    • weight (nombre) : Poids de l'utilisateur.

    • age (string) : Âge de l'utilisateur.

    • ycom (nombre) : Valeur YCOM de l'utilisateur.

    • height (nombre) : Taille de l'utilisateur.

    • phone (string) : Numéro de téléphone de l'utilisateur.

    • leg_length (nombre) : Longueur de jambe de l'utilisateur.

    • display_name (string) : Nom d'affichage de l'utilisateur.

    • shoeSize (string) : Pointure de l'utilisateur.

    • email (string) : Adresse e-mail de l'utilisateur.

    • gender (string) : Genre de l'utilisateur.

    • brand (string) : Marque associée à l'utilisateur.

    • shoeModel (string) : Modèle de chaussure de l'utilisateur.

    • user_uid (string) : Identifiant unique de l'utilisateur.

Notes :

  • Un token API-KEY valide est requis pour accéder à ce point de terminaison.

  • S'il n'y a pas d'utilisateurs ou en cas d'erreur, un message d'erreur approprié est retourné.

Autorisations
AuthorizationstringRequis

Entrez votre token Bearer (authentification Firebase) au format : Bearer

Réponses
200

Liste d'utilisateurs récupérée avec succès.

application/json
get/client-management/clients/
GET /client-management/clients/ HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Accept: */*

{
  "users": [
    {
      "created_at": "2026-01-01T00:00:00.000Z",
      "weight": 1,
      "age": "text",
      "ycom": 1,
      "height": 1,
      "phone": "text",
      "leg_length": 1,
      "display_name": "text",
      "shoeSize": "text",
      "email": "name@gmail.com",
      "gender": "text",
      "brand": "text",
      "shoeModel": "text",
      "profile_photo": "https://example.com",
      "user_uid": "text"
    }
  ]
}

Créer un nouvel utilisateur

post

Créer un nouvel utilisateur

Ce point de terminaison permet à un administrateur authentifié de créer un nouvel utilisateur sous son compte. L'administrateur doit fournir l'e-mail et le nom d'affichage de l'utilisateur, et peut éventuellement inclure d'autres champs. Exemple d'utilisation : Envoyez une requête POST à /clients/ avec une charge utile JSON contenant les champs requis. Un token API-KEY valide doit être inclus dans l'en-tête d'autorisation.

Paramètres de la requête

  • display_name (string)

  • email (string, e-mail valide)

  • age (integer)

  • gender (male | female)

  • shoeSize (float)

  • weight (float)

  • height (float) Structure de la réponse : En cas de succès (HTTP 201), le point de terminaison retourne un objet JSON avec un champ userData contenant les clés et types de données suivants :

  • user_uid (string) : Un identifiant unique pour le nouvel utilisateur.

  • display_name (string)

  • email (string, e-mail valide)

  • age (integer)

  • gender (male | female)

  • shoeSize (float)

  • weight (float)

  • height (float)

  • profile_photo (fichier, JPEG/PNG) - image optionnelle ; disponible uniquement avec multipart/form-data. En cas d'erreur (par exemple, paramètres manquants, accès non autorisé ou erreur interne), un objet JSON avec un champ error (string) est retourné.

Autorisations
AuthorizationstringRequis

Entrez votre token Bearer (authentification Firebase) au format : Bearer

Corps
display_namestringRequis
emailstringRequis
ageintegerRequis
genderstringRequis
shoeSizenumberRequis
weightnumberRequis
heightnumberRequis
preferable_activitiesstringOptionnel

Liste optionnelle encodée en JSON des types d'activités préférés. Valeurs autorisées : 'Running', 'Vertical Jump', 'Weightlifting', 'Mobility Assessment'. Exemple : ["Running", "Weightlifting"]

profile_photostringOptionnel

Image JPEG/PNG optionnelle.

Réponses
201

Utilisateur créé avec succès.

application/json
post/client-management/clients/
POST /client-management/clients/ HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 151

"display_name='text'&email='text'&age=1&gender='text'&shoeSize=1&weight=1&height=1&preferable_activities='text'&profile_photo='text'"
{
  "userData": {
    "user_uid": "text",
    "display_name": "text",
    "email": "text",
    "age": 1,
    "gender": "text",
    "shoeSize": 1,
    "weight": 1,
    "height": 1,
    "profile_photo": "https://example.com",
    "preferable_activities": [
      "text"
    ]
  }
}

Mettre à jour les informations d'un utilisateur

put

Mettre à jour les informations d'un utilisateur

Ce point de terminaison permet à un administrateur authentifié de mettre à jour certains champs d'un utilisateur existant, en utilisant des paramètres de requête. Paramètre de requête requis

  • user_uid (string) - l'UID de l'utilisateur à mettre à jour. Paramètres de requête optionnels - fournissez un ou plusieurs des suivants :

  • display_name (string) - nouveau nom d'affichage

  • email (string, e-mail valide) - nouvelle adresse e-mail

  • age (integer)

  • gender (string, l'un des male, female)

  • shoeSize (float)

  • weight (float)

  • height (float) Réponse (HTTP 200) json { "message": "Informations utilisateur mises à jour avec succès." } Si la validation échoue ou si l'utilisateur n'est pas trouvé, la réponse contient un champ error avec des détails.

Autorisations
AuthorizationstringRequis

Entrez votre token Bearer (authentification Firebase) au format : Bearer

Corps
user_uidstringRequis
display_namestringOptionnel
emailstringOptionnel
ageintegerOptionnel
genderstringOptionnel
shoeSizenumberOptionnel
weightnumberOptionnel
heightnumberOptionnel
preferable_activitiesstringOptionnel

Liste optionnelle encodée en JSON des types d'activités préférés. Valeurs autorisées : 'Running', 'Vertical Jump', 'Weightlifting', 'Mobility Assessment'. Exemple : ["Running", "Weightlifting"]

profile_photostringOptionnel

Image JPEG/PNG optionnelle.

Réponses
200

Informations utilisateur mises à jour avec succès.

application/json
messagestringOptionnel

Message de confirmation indiquant la mise à jour réussie.

put/client-management/clients/
PUT /client-management/clients/ HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 169

"user_uid='text'&display_name='text'&email='text'&age=1&gender='text'&shoeSize=1&weight=1&height=1&preferable_activities='text'&profile_photo='text'"
{
  "message": "text"
}

Supprimer un utilisateur

delete

Supprimer un utilisateur

Ce point de terminaison permet à un administrateur authentifié de supprimer un utilisateur de son compte. L'administrateur doit fournir l'identifiant unique de l'utilisateur à supprimer dans le corps de la requête. Corps de la requête :

  • user_uid (string, requis) : L'identifiant unique de l'utilisateur à supprimer. Structure de la réponse : En cas de succès (HTTP 200), le point de terminaison retourne un objet JSON avec un champ message de type string confirmant la suppression. En cas d'erreur (par exemple, si l'UID utilisateur est manquant, l'utilisateur n'est pas trouvé ou une erreur interne se produit), un objet JSON avec un champ error (string) est retourné.

Autorisations
AuthorizationstringRequis

Entrez votre token Bearer (authentification Firebase) au format : Bearer

Paramètres de requête
user_uidstringRequis

UID de l'utilisateur à supprimer

Réponses
200

Utilisateur supprimé avec succès.

application/json
messagestringOptionnel

Message de confirmation indiquant que l'utilisateur a été supprimé.

delete/client-management/clients/
DELETE /client-management/clients/?user_uid=text HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "text"
}

Définir / remplacer une note pour un client

post

Stocke une note par client. Si note est omise ou vide, la note précédente est effacée (enregistrée comme null). Structure du document :

  "text": "Tension aux ischio-jambiers - réduire le travail de vitesse pendant 2 semaines",  // ou null
  "updated_at": "2025-07-14T09:32:11.123Z"
} ```
Autorisations
AuthorizationstringRequis

Entrez votre token Bearer (authentification Firebase) au format : Bearer

Paramètres de chemin
user_uidanyRequis
Corps
notestringRequis

Texte de note libre (≤ 100 kB). Si omis ou vide, la note est effacée.

Réponses
200

Note enregistrée / remplacée avec succès.

application/json
messagestringRequis
post/client-management/clients/save-notes/{user_uid}
POST /client-management/clients/save-notes/{user_uid} HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "note": "Tension aux ischio-jambiers - réduire le travail de vitesse pendant 2 semaines"
}
{
  "message": "text"
}

Filtrer et paginer les utilisateurs

get

Filtrer et paginer les utilisateurs

Ce point de terminaison permet à un administrateur authentifié de filtrer et paginer les utilisateurs sous son compte. Vous pouvez éventuellement spécifier des paramètres de requête pour contrôler la pagination :

  • start_after_id (string, optionnel) : L'UID après lequel commencer à récupérer les utilisateurs (pour la pagination avant).

  • limit (integer, optionnel) : Le nombre maximum d'utilisateurs à récupérer. Par défaut 5 si non fourni. Vous pouvez également filtrer les utilisateurs en fonction de divers critères :

  • admin_uid (string, optionnel) : L'UID de l'administrateur pour filtrer les utilisateurs.

  • start_date (string, optionnel) : Borne inférieure (inclusive) pour la dernière session de l'utilisateur au format YYYY-MM-DD.

  • end_date (string, optionnel) : Borne supérieure (inclusive) pour la dernière session de l'utilisateur au format YYYY-MM-DD.

  • gender (string, optionnel) : Filtrer par genre (male ou female).

  • preferable_activities (tableau, optionnel) : Filtrer par activités préférées de l'utilisateur. Structure de la réponse (HTTP 200) : La réponse retourne un objet JSON avec les champs suivants :

  • query_count (integer) : Nombre total d'utilisateurs sous l'administrateur.

  • users (tableau) : Un tableau d'objets utilisateur. Chaque objet utilisateur contient :

    • created_at (string, date-time) : Horodatage de création de l'utilisateur.

    • weight (nombre) : Poids de l'utilisateur.

    • age (string) : Âge de l'utilisateur.

    • ycom (nombre) : Valeur YCOM de l'utilisateur.

    • height (nombre) : Taille de l'utilisateur.

    • phone (string) : Numéro de téléphone de l'utilisateur.

    • leg_length (nombre) : Longueur de jambe de l'utilisateur.

    • display_name (string) : Nom d'affichage de l'utilisateur.

    • shoeSize (string) : Pointure de l'utilisateur.

    • email (string) : Adresse e-mail de l'utilisateur.

    • gender (string) : Genre de l'utilisateur.

    • brand (string) : Marque associée à l'utilisateur.

    • shoeModel (string) : Modèle de chaussure de l'utilisateur.

    • user_uid (string) : Identifiant unique de l'utilisateur.

  • first_uid (string) : L'UID du premier utilisateur dans la page actuelle.

  • last_uid (string) : L'UID du dernier utilisateur dans la page actuelle. Notes :

  • Un token API-KEY valide est requis.

  • Si aucun utilisateur n'est trouvé, un message d'erreur est retourné avec le code d'état 404.

Autorisations
AuthorizationstringRequis

Entrez votre token Bearer (authentification Firebase) au format : Bearer

Paramètres de requête
admin_uidstringOptionnel

UID de l'administrateur (qui a créé l'utilisateur) pour filtrer les utilisateurs.

start_datestringOptionnel

Borne inférieure (inclusive) pour last_session au format YYYY-MM-DD.

end_datestringOptionnel

Borne supérieure (inclusive) pour last_session au format YYYY-MM-DD.

genderstring · enumOptionnel

Filtrer par genre (male ou female).

Valeurs possibles:
preferable_activitiesstringOptionnel

Tableau JSON des activités préférées.

start_after_idstringOptionnel
limitintegerOptionnel
Réponses
200

Liste filtrée d'utilisateurs récupérée avec succès.

application/json
query_countintegerRequis

Nombre total d'utilisateurs sous l'administrateur.

first_uidstringRequis

UID du premier utilisateur dans la page actuelle.

last_uidstringRequis

UID du dernier utilisateur dans la page actuelle.

get/client-management/clients/filter/
GET /client-management/clients/filter/ HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Accept: */*

{
  "query_count": 1,
  "users": [
    {
      "created_at": "2026-01-01T00:00:00.000Z",
      "weight": 1,
      "age": "text",
      "ycom": 1,
      "height": 1,
      "phone": "text",
      "leg_length": 1,
      "display_name": "text",
      "shoeSize": "text",
      "email": "name@gmail.com",
      "gender": "text",
      "brand": "text",
      "shoeModel": "text",
      "profile_photo": "https://example.com",
      "user_uid": "text"
    }
  ],
  "first_uid": "text",
  "last_uid": "text"
}

Récupérer les détails d'un utilisateur spécifique

get

Récupérer les détails d'un utilisateur

Ce point de terminaison permet à un administrateur authentifié de récupérer des informations détaillées pour un utilisateur spécifique sous son compte. L'utilisateur est identifié par l'identifiant unique user_uid fourni dans l'URL. Paramètre de chemin :

  • user_uid (string, requis) : L'identifiant unique de l'utilisateur. Structure de la réponse (HTTP 200) : Retourne un objet JSON avec les champs et types de données suivants :

  • created_at (string, date-time) : Horodatage de création de l'utilisateur. - weight (nombre) : Poids de l'utilisateur. - age (string) : Âge de l'utilisateur. - ycom (nombre) : Valeur YCOM de l'utilisateur. - height (nombre) : Taille de l'utilisateur. - phone (string) : Numéro de téléphone de l'utilisateur. - leg_length (nombre) : Longueur de jambe de l'utilisateur. - display_name (string) : Nom d'affichage de l'utilisateur. - shoeSize (string) : Pointure de l'utilisateur. - email (string) : Adresse e-mail de l'utilisateur. - gender (string) : Genre de l'utilisateur. - brand (string) : Marque associée à l'utilisateur. - shoeModel (string) : Modèle de chaussure de l'utilisateur. - user_uid (string) : Identifiant unique de l'utilisateur. Exemple de réponse réussie :

  "created_at": "2024-12-02T19:17:30.371Z",
  "weight": 79,
  "age": "30",
  "ycom": 1.1,
  "height": 177,
  "phone": "92039023232",
  "leg_length": 0.9,
  "display_name": "User1",
  "shoeSize": "8",
  "email": "user1@gmail.com",
  "gender": "Male",
  "brand": "Nike",
  "shoeModel": "Peak-smart",
  "user_uid": "hoEwsdv2fsFs2fav"
} ```
**Notes :**
- Un token API-KEY valide avec des privilèges d'administrateur est requis.
- Si l'utilisateur spécifié n'existe pas ou n'est pas sous l'administrateur, une erreur 404 est retournée.
Autorisations
AuthorizationstringRequis

Entrez votre token Bearer (authentification Firebase) au format : Bearer

Paramètres de chemin
user_uidanyRequis
Réponses
200

Détails de l'utilisateur récupérés avec succès.

application/json
created_atstring · date-timeRequis

Horodatage de création de l'utilisateur.

weightnumberRequis

Poids de l'utilisateur.

agestringRequis

Âge de l'utilisateur.

ycomnumberRequis

Valeur YCOM de l'utilisateur.

heightnumberRequis

Taille de l'utilisateur.

phonestringRequis

Numéro de téléphone de l'utilisateur.

leg_lengthnumberRequis

Longueur de jambe de l'utilisateur.

display_namestringRequis

Nom d'affichage de l'utilisateur.

shoeSizestringRequis

Pointure de l'utilisateur.

emailstring · emailRequis

Adresse e-mail de l'utilisateur.

genderstringRequis

Genre de l'utilisateur.

brandstringRequis

Marque associée à l'utilisateur.

shoeModelstringRequis

Modèle de chaussure de l'utilisateur.

profile_photostring · uriOptionnel

URL publique de la photo de profil.

user_uidstringRequis

Identifiant unique de l'utilisateur.

get/client-management/clients/{user_uid}
GET /client-management/clients/{user_uid} HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Accept: */*

{
  "created_at": "2026-01-01T00:00:00.000Z",
  "weight": 1,
  "age": "text",
  "ycom": 1,
  "height": 1,
  "phone": "text",
  "leg_length": 1,
  "display_name": "text",
  "shoeSize": "text",
  "email": "name@gmail.com",
  "gender": "text",
  "brand": "text",
  "shoeModel": "text",
  "profile_photo": "https://example.com",
  "user_uid": "text"
}
PrécédentRéférence API
SuivantGestion de Tous les Sessions

Mis à jour

Ce contenu vous a-t-il été utile ?