Zum Hauptinhalt springen

Neuen Kunden erstellen

Dieser Endpoint erstellt einen neuen Kunden mit allen erforderlichen Daten. Der Kunde wird automatisch mit der Identität aus dem API-Schlüssel verknüpft.

Endpoint-Details

HTTP-Methode: POST

URL: /external/v1/customers

Authentifizierung: API-Schlüssel (erforderlich)

Parameter

HeaderTypErforderlichBeschreibung
X-Api-KeystringJaAPI-Schlüssel für die Authentifizierung

Request Body

{
"birthday": "1990-05-15",
"gender": 0,
"bodyWeight": 75.5,
"bodySize": 180,
"bodyFat": 18.5,
"hipCircumference": 95,
"neckCircumference": 38,
"waistCircumference": 85,
"language": "de-CH",
"note": "Kundennotiz",
"address": {
"firstname": "Max",
"lastname": "Mustermann",
"email": "max.mustermann@example.com",
"street": "Musterstrasse",
"streetNumber": "42",
"additional": "3. Stock",
"zip": "8000",
"city": "Zürich",
"country": "756",
"phone": "+41 44 123 45 67",
"mobilePhone": "+41 79 123 45 67",
"salutation": 10
}
}

Request-Felder

Customer-Felder

FeldTypErforderlichBeschreibung
birthdayDateTime?NeinGeburtsdatum des Kunden
genderintJaGeschlecht: 0 (männlich) oder 1 (weiblich)
bodyWeightdoubleNeinKörpergewicht in kg
bodySizeintNeinKörpergröße in cm
bodyFatdoubleNeinKörperfettanteil in %
hipCircumferenceintNeinHüftumfang in cm
neckCircumferenceintNeinNackenumfang in cm
waistCircumferenceintNeinBauchumfang in cm
languagestring?NeinSprache (de-CH, de-DE, en-US)
notestring?NeinKundennotiz
addressobjectJaHauptadresse des Kunden

Address-Felder

FeldTypErforderlichBeschreibung
firstnamestringJaVorname
lastnamestringJaNachname
emailstring?NeinE-Mail-Adresse
streetstring?NeinStraße
streetNumberstring?NeinHausnummer
additionalstring?NeinAdresszusatz
zipstring?NeinPostleitzahl
citystring?NeinStadt
countrystringJaLand (ISO-3166-Code, z.B. 756 für Schweiz)
phonestring?NeinTelefonnummer
mobilePhonestring?NeinMobiltelefonnummer
salutationintJaAnrede: 10 (Herr), 20 (Frau), 30 (Dr.)

Response

Erfolgreiche Response (200 OK)

{
"id": 12345,
"success": true,
"errorMessage": null
}

Fehlerhafte Response (400 Bad Request)

{
"id": 0,
"success": false,
"errorMessage": "Firstname is required"
}

Response-Felder

FeldTypBeschreibung
idlongDie ID des neu erstellten Kunden (bei Erfolg)
successbooleanGibt an, ob der Kunde erfolgreich erstellt wurde
errorMessagestring?Fehlermeldung, falls ein Fehler aufgetreten ist (ansonsten null)

Status-Codes

CodeBeschreibung
200OK - Anfrage wurde verarbeitet (prüfe success-Feld)
400Bad Request - Anfragedaten sind ungültig oder unvollständig
401Unauthorized - API-Schlüssel ist ungültig oder fehlt
500Internal Server Error - Interner Serverfehler

Validierungsregeln

Pflichtfelder

  • gender
  • address.firstname
  • address.lastname
  • address.country
  • address.salutation

Wertebereich

  • gender: Muss 0 (männlich) oder 1 (weiblich) sein
  • language: Muss ein gültiger Kultur-Code sein (de-CH, de-DE, en-US)
  • address.salutation: Muss 10 (Herr), 20 (Frau) oder 30 (Dr.) sein

Funktionsweise

  1. Authentifizierung über API-Schlüssel
  2. Validierung der Request-Daten (Pflichtfelder, Wertebereiche)
  3. Erstellung des Kunden in der Datenbank
  4. Verknüpfung des Kunden mit der Identität
  5. Rückgabe der Kunden-ID

Wichtige Hinweise

  • Der Kunde wird automatisch mit der Identität aus dem API-Schlüssel verknüpft
  • Die Hauptadresse wird als primäre Adresse des Kunden gespeichert
  • Wenn kein birthday angegeben wird, wird 1900-01-01 als Standardwert verwendet