Benutzerverwaltung
Allgemeine Benutzerverwaltung
Abrufen einer paginierten Benutzerliste
Dieser Endpunkt ermöglicht es einem Administrator, eine paginierte Liste von Benutzern unter seinem Konto abzurufen. Die Antwort enthält detaillierte Informationen für jeden Benutzer wie persönliche Attribute, Kontaktdaten und Metadaten im Zusammenhang mit ihrem Konto. Anwendungsbeispiel: Senden Sie eine GET-Anfrage an client-management/clients/ mit dem entsprechenden API-KEY-Token im Authorization-Header. Antwortstruktur:
users (array): Eine Liste von Benutzerobjekten, wobei jedes Objekt die folgenden Felder enthält:
created_at (string, date-time): Zeitstempel der Benutzererstellung.
weight (number): Das Gewicht des Benutzers.
age (string): Das Alter des Benutzers.
ycom (number): Der YCOM-Wert des Benutzers.
height (number): Die Größe des Benutzers.
phone (string): Die Telefonnummer des Benutzers.
leg_length (number): Die Beinlänge des Benutzers.
display_name (string): Der Anzeigename des Benutzers.
shoeSize (string): Die Schuhgröße des Benutzers.
email (string): Die E-Mail-Adresse des Benutzers.
gender (string): Das Geschlecht des Benutzers.
brand (string): Die mit dem Benutzer verbundene Marke.
shoeModel (string): Das Modell des Schuhs des Benutzers.
user_uid (string): Der eindeutige Identifikator des Benutzers.
Hinweise:
Ein gültiger API-KEY-Token ist erforderlich, um auf diesen Endpunkt zuzugreifen.
Falls keine Benutzer vorhanden sind oder ein Fehler auftritt, wird eine entsprechende Fehlermeldung zurückgegeben.
Geben Sie Ihren Bearer-Token (Firebase Auth) im Format ein: Bearer
Die Benutzerliste wurde erfolgreich abgerufen.
Ungültige Anfrage - Ungültige Abfrageparameter oder fehlende erforderliche Daten.
Nicht autorisiert - Fehlender oder ungültiger Zugriffstoken.
Verboten - Der Benutzer hat nicht die erforderlichen Berechtigungen.
Nicht gefunden - Benutzer nicht gefunden oder Abruf fehlgeschlagen.
Interner Serverfehler - Ein unerwarteter Fehler ist aufgetreten.
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"
}
]
}Einen neuen Benutzer erstellen
Dieser Endpunkt ermöglicht es einem authentifizierten Administrator, einen neuen Benutzer unter seinem Konto zu erstellen. Der Administrator muss die E-Mail-Adresse und den Anzeigenamen des Benutzers angeben und kann optional weitere Felder hinzufügen. Anwendungsbeispiel: Senden Sie eine POST-Anfrage an /clients/ mit einer JSON-Nutzlast, die die erforderlichen Felder enthält. Ein gültiger API-KEY-Token muss im Authorization-Header enthalten sein.
Anfrageparameter
display_name (string)
email (string, gültige E-Mail)
age (integer)
gender (male | female)
shoeSize (float)
weight (float)
height (float) Antwortstruktur: Bei Erfolg (HTTP 201) gibt der Endpunkt ein JSON-Objekt mit einem
userData-Feld zurück, das die folgenden Schlüssel und Datentypen enthält:user_uid (string): Ein eindeutiger Identifikator für den neu erstellten Benutzer.
display_name (string)
email (string, gültige E-Mail)
age (integer)
gender (male | female)
shoeSize (float)
weight (float)
height (float)
profile_photo (file, JPEG/PNG) - optionales Bild; nur verfügbar mit
multipart/form-data.
Im Fehlerfall (z.B. fehlende Parameter, nicht autorisierter Zugriff oder ein interner Fehler) wird ein JSON-Objekt mit einem error-Feld (string) zurückgegeben.
Geben Sie Ihren Bearer-Token (Firebase Auth) im Format ein: Bearer
Optionale JSON-kodierte Liste bevorzugter Aktivitätstypen. Erlaubte Werte: 'Running', 'Vertical Jump', 'Weightlifting', 'Mobility Assessment'.
Beispiel: ["Running", "Weightlifting"]
Optionales JPEG/PNG-Bild.
Benutzer erfolgreich erstellt.
Ungültige Anfrage - Fehlende oder ungültige Parameter.
Nicht autorisiert - Fehlender oder ungültiger Zugriffstoken.
Verboten - Der Benutzer ist nicht berechtigt, Benutzer zu erstellen.
Nicht gefunden - Benutzererstellungslimit für Pro-Plan erreicht.
Interner Serverfehler - Ein unerwarteter Fehler ist aufgetreten.
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"
]
}
}Einen Benutzer löschen
Dieser Endpunkt ermöglicht es einem authentifizierten Administrator, einen Benutzer aus seinem Konto zu löschen. Der Administrator muss den eindeutigen Identifikator des zu löschenden Benutzers im Anfragekörper angeben. Anfragekörper:
user_uid (string, erforderlich): Der eindeutige Identifikator des zu löschenden Benutzers. Antwortstruktur: Bei Erfolg (HTTP 200) gibt der Endpunkt ein JSON-Objekt mit einem message-Feld vom Typ string zurück, das die Löschung bestätigt. Im Fehlerfall (z.B. wenn die Benutzer-UID fehlt, der Benutzer nicht gefunden wird oder ein interner Fehler auftritt) wird ein JSON-Objekt mit einem error-Feld (string) zurückgegeben.
Geben Sie Ihren Bearer-Token (Firebase Auth) im Format ein: Bearer
UID des zu löschenden Benutzers
Benutzer erfolgreich gelöscht.
Bestätigungsmeldung, die anzeigt, dass der Benutzer gelöscht wurde.
Ungültige Anfrage - Fehlende erforderliche Benutzer-UID.
Nicht autorisiert - Fehlender oder ungültiger Zugriffstoken.
Verboten - Der Benutzer ist nicht berechtigt, Benutzer zu löschen.
Nicht gefunden - Benutzer nicht gefunden oder nicht unter Administrator.
Interner Serverfehler - Ein unerwarteter Fehler ist aufgetreten.
DELETE /client-management/clients/?user_uid=text HTTP/1.1
Host: api.aikynetix.app
Authorization: YOUR_API_KEY
Accept: */*
{
"message": "text"
}Benutzerinformationen aktualisieren
Dieser Endpunkt ermöglicht es einem authentifizierten Administrator, ausgewählte Felder eines bestehenden Benutzers mit Query-String-Parametern zu aktualisieren. Erforderlicher Query-Parameter
user_uid (string) - die UID des zu aktualisierenden Benutzers. Optionale Query-Parameter - geben Sie einen oder mehrere der folgenden an:
display_name (string) - neuer Anzeigename
email (string, gültige E-Mail) - neue E-Mail-Adresse
age (integer)
gender (string, einer von
male,female)shoeSize (float)
weight (float)
height (float) Antwort (HTTP 200)
json { "message": "Benutzerinformationen erfolgreich aktualisiert." }Wenn die Validierung fehlschlägt oder der Benutzer nicht gefunden wird, enthält die Antwort ein error-Feld mit Details.
Geben Sie Ihren Bearer-Token (Firebase Auth) im Format ein: Bearer
Optionale JSON-kodierte Liste bevorzugter Aktivitätstypen. Erlaubte Werte: 'Running', 'Vertical Jump', 'Weightlifting', 'Mobility Assessment'.
Beispiel: ["Running", "Weightlifting"]
Optionales JPEG/PNG-Bild.
Benutzerinformationen erfolgreich aktualisiert.
Bestätigungsmeldung, die die erfolgreiche Aktualisierung anzeigt.
Ungültige Anfrage - Fehlende erforderliche Felder oder ungültige Daten.
Nicht autorisiert - Fehlender oder ungültiger Zugriffstoken.
Verboten - Der Benutzer ist nicht berechtigt, Benutzerinformationen zu aktualisieren.
Interner Serverfehler - Ein unerwarteter Fehler ist aufgetreten.
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"
}Benutzer filtern und paginieren
Dieser Endpunkt ermöglicht es einem authentifizierten Administrator, die Benutzer unter seinem Konto zu filtern und zu paginieren. Sie können optional Query-Parameter angeben, um die Paginierung zu steuern:
start_after_id (string, optional): Die UID, nach der mit dem Abrufen von Benutzern begonnen werden soll (für Vorwärtspaginierung).
limit (integer, optional): Die maximale Anzahl der abzurufenden Benutzer. Standardmäßig 5, falls nicht angegeben.
Sie können Benutzer auch nach verschiedenen Kriterien filtern, wie z.B.:
admin_uid (string, optional): Die UID des Administrators, nach der Benutzer gefiltert werden sollen.
start_date (string, optional): Untere Grenze (inklusive) für die letzte Sitzung des Benutzers im Format
YYYY-MM-DD.end_date (string, optional): Obere Grenze (inklusive) für die letzte Sitzung des Benutzers im Format
YYYY-MM-DD.gender (string, optional): Filter nach Geschlecht (
maleoderfemale).preferable_activities (array, optional): Filter nach bevorzugten Aktivitäten des Benutzers.
Antwortstruktur (HTTP 200): Die Antwort gibt ein JSON-Objekt mit den folgenden Feldern zurück:
query_count (integer): Gesamtanzahl der Benutzer unter dem Administrator.
users (array): Ein Array von Benutzerobjekten. Jedes Benutzerobjekt enthält:
created_at (string, date-time): Zeitstempel der Benutzererstellung.
weight (number): Das Gewicht des Benutzers.
age (string): Das Alter des Benutzers.
ycom (number): Der YCOM-Wert des Benutzers.
height (number): Die Größe des Benutzers.
phone (string): Die Telefonnummer des Benutzers.
leg_length (number): Die Beinlänge des Benutzers.
display_name (string): Der Anzeigename des Benutzers.
shoeSize (string): Die Schuhgröße des Benutzers.
email (string): Die E-Mail-Adresse des Benutzers.
gender (string): Das Geschlecht des Benutzers.
brand (string): Die mit dem Benutzer verbundene Marke.
shoeModel (string): Das Modell des Schuhs des Benutzers.
user_uid (string): Der eindeutige Identifikator des Benutzers.
first_uid (string): Die UID des ersten Benutzers auf der aktuellen Seite.
last_uid (string): Die UID des letzten Benutzers auf der aktuellen Seite. Hinweise:
Ein gültiger API-KEY-Token ist erforderlich.
Wenn keine Benutzer gefunden werden, wird eine Fehlermeldung mit Statuscode 404 zurückgegeben.
Geben Sie Ihren Bearer-Token (Firebase Auth) im Format ein: Bearer
UID des Administrators (der den Benutzer erstellt hat), nach der Benutzer gefiltert werden sollen.
Untere Grenze (inklusive) für last_session im Format YYYY-MM-DD.
Obere Grenze (inklusive) für last_session im Format YYYY-MM-DD.
Filter nach Geschlecht (male oder female).
JSON-Array bevorzugter Aktivitäten.
Die gefilterte Benutzerliste wurde erfolgreich abgerufen.
Gesamtanzahl der Benutzer unter dem Administrator.
UID des ersten Benutzers auf der aktuellen Seite.
UID des letzten Benutzers auf der aktuellen Seite.
Nicht autorisiert - Fehlender oder ungültiger Zugriffstoken.
Verboten - Der Anfragende hat keine Administratorberechtigungen.
Nicht gefunden - Keine Benutzer unter dem Administrator gefunden oder ein Fehler ist während des Abrufs aufgetreten.
Interner Serverfehler - Ein unerwarteter Fehler ist während des Abrufs aufgetreten.
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"
}Speichert eine Notiz pro Client. Falls note weggelassen oder leer ist, wird die vorherige Notiz gelöscht (als null gespeichert). Dokumentenstruktur:
"text": "Hamstring strain - reduce speed work for 2 wks", // oder null
"updated_at": "2025-07-14T09:32:11.123Z"
} ```Geben Sie Ihren Bearer-Token (Firebase Auth) im Format ein: Bearer
Freiform-Notiztext (≤ 100 kB). Falls weggelassen oder leer, wird die Notiz gelöscht.
Notiz erfolgreich gespeichert/ersetzt.
Ungültige Anfrage - Die Benutzer-UID fehlt oder ist ungültig.
Nicht autorisiert - Fehlender oder ungültiger Token.
Verboten - Der Anfragende hat keine Administratorberechtigungen.
Nicht gefunden - Der Benutzer wurde nicht gefunden oder ist nicht unter dem Administrator.
Interner Serverfehler - Ein unerwarteter Fehler ist aufgetreten.
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: 59
{
"note": "Hamstring strain - reduce speed work for 2 weeks"
}{
"message": "text"
}Benutzerdetails abrufen
Dieser Endpunkt ermöglicht es einem authentifizierten Administrator, detaillierte Informationen für einen bestimmten Benutzer unter seinem Konto abzurufen. Der Benutzer wird durch den eindeutigen user_uid-Parameter in der URL identifiziert. Pfadparameter:
user_uid (string, erforderlich): Der eindeutige Identifikator des Benutzers. Antwortstruktur (HTTP 200): Gibt ein JSON-Objekt mit den folgenden Feldern und Datentypen zurück:
created_at (string, date-time): Zeitstempel der Benutzererstellung.
weight (number): Das Gewicht des Benutzers.
age (string): Das Alter des Benutzers.
ycom (number): Der YCOM-Wert des Benutzers.
height (number): Die Größe des Benutzers.
phone (string): Die Telefonnummer des Benutzers.
leg_length (number): Die Beinlänge des Benutzers.
display_name (string): Der Anzeigename des Benutzers.
shoeSize (string): Die Schuhgröße des Benutzers.
email (string): Die E-Mail-Adresse des Benutzers.
gender (string): Das Geschlecht des Benutzers.
brand (string): Die mit dem Benutzer verbundene Marke.
shoeModel (string): Das Modell des Schuhs des Benutzers.
user_uid (string): Der eindeutige Identifikator des Benutzers. Beispiel für eine erfolgreiche Antwort:
Geben Sie Ihren Bearer-Token (Firebase Auth) im Format ein: Bearer
Benutzerdetails erfolgreich abgerufen.
Zeitstempel der Benutzererstellung.
Das Gewicht des Benutzers.
Das Alter des Benutzers.
Der YCOM-Wert des Benutzers.
Die Größe des Benutzers.
Die Telefonnummer des Benutzers.
Die Beinlänge des Benutzers.
Der Anzeigename des Benutzers.
Die Schuhgröße des Benutzers.
Die E-Mail-Adresse des Benutzers.
Das Geschlecht des Benutzers.
Die mit dem Benutzer verbundene Marke.
Das Modell des Schuhs des Benutzers.
Öffentliche URL des Profilfotos.
Der eindeutige Identifikator des Benutzers.
Ungültige Anfrage - Die Benutzer-UID fehlt oder ist ungültig.
Nicht autorisiert - Fehlender oder ungültiger Token.
Verboten - Der Anfragende hat keine Administratorberechtigungen.
Nicht gefunden - Der Benutzer wurde nicht gefunden oder ist nicht unter dem Administrator.
Interner Serverfehler - Ein unerwarteter Fehler ist aufgetreten.
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"
}Zuletzt aktualisiert
War das hilfreich?