Verwaltung deiner Benutzeradressen
Beschreibung:
TYRIOS ermöglicht es, Benutzeradressen direkt über die API zu verwalten. Hier sind die allgemeinen Regeln für die Nutzung der Benutzer-API:
- TYRIOS hängt von verschiedenen Modulkonfigurationen ab. Es hängt von deiner Konfiguration ab, ob ein Endpunkt verfügbar ist.
- Es hängt von deinen Rechten ab, ob du einen bestimmten Endpunkt aufrufen kannst.
- TYRIOS ist ein aspektorientiertes System. Es hängt von der konkreten Konfiguration ab, welche Felder verfügbar sind und Prozesse. In diesem Dokument werden wir die typische Struktur besprechen.
Authentifizierung
Die API-Endpunkte von TYRIOS sind nur für autorisierte Nutzer verfügbar. Daher muss der Benutzer authentifiziert werden. Es gibt zwei verschiedene Arten der Authentifizierung:
- Authentifizierung durch BASIC-Authentifizierung. Das Benutzerkonto muss über ein aktiviertes REST API-Token verfügen. Du musst einen entsprechenden BASIC-Authentifizierungs-Header senden.
- Authentifizierung durch die Registrierung einer mobilen App. Du musst ein entsprechendes App-Registrierungs-Token senden.
Datenstruktur
Benutzeradressen werden als UserAddressData-Objekte realisiert, die typischerweise mit anderen Objekten wie UserData-Objekten verbunden sind
Aufgrund der aspektorientierten Natur von TYRIOS ist es sehr wahrscheinlich, dass deine konkrete Datenstruktur ein wenig von dieser allgemeinen Beschreibung abweicht. Wir empfehlen dir, bestehende Datenobjekte anzufordern, um die genaue Datenstruktur zu erfahren.
API-Endpunkte
Auf UserAddressData kann nicht direkt zugegriffen werden. Sie sind immer mit einem anderen Objekt verknüpft und können nur über dieses Objekt aufgerufen werden.
API-Endpunkte für UserData-bezogene Adressen
Der allgemeine Endpunkt für die benutzerbezogene Adressverwaltung lautet
https://[instance.de]/service/UserAddressManagement/address/[userID]
Er erfordert immer einen authentifizierten Benutzer.
Alle Benutzeradressen auflisten
Um alle Adressen aufzulisten, musst du eine GET-Anfrage an folgenden Endpunkt stellen
https://[instance.de]/service/UserAddressManagement/address/[userID]
die Daten unterstützen die folgenden GET-Parameter
- query: Du kannst eine Textabfrage hinzufügen, die in name, preName, company, nickName oder user id durchsucht wird
- limit: Anzahl der Elemente, Standardwert ist 100
Die Antwort ist ein Array von UserAddressData-Objekten.
Eine benutzerspezifische Adresse erstellen
Um eine benutzerspezifische Adresse zu erstellen, musst du eine PUT-Anfrage an den folgenden Endpunkt senden
https://[instance.de]/service/UserAddressManagement/address/[userID]
als Payload musst du ein UserAddressData-Objekt als JSON-Objekt senden.
- die ID muss null sein
- Das UserData-Objekt wird automatisch zugewiesen und muss in deinem Payload null sein
- Das CustomerData-Objekt muss null sein
Ein minimales Beispiel zum Speichern des Objekts ist:
{
"Geschlecht": "Firma", // Art der Adresse, mögliche Werte: männlich, weiblich, Firma, Verein, Stadt, Organisation, Behörde
"Name": "Mustermann", // Nachname der Kontaktadresse, erforderlich, wenn Firma nicht angegeben ist
"Vorname": "Max",
"Straße": "Teststraße", // Straßenname, erforderlich, wenn keine PostOfficeBoxy angegeben ist
"streetNo": "12",
"postCode": "88605",
"city": "Meßkirch",
"country": "de" // Ländercode im ISO 3166-1 Alpha-2 Format
}
Als Antwort erhältst du die vollständig gespeicherte Adresse mit ID.
Eine benutzerspezifische Adresse aktualisieren
Um eine benutzerspezifische Adresse zu aktualisieren, musst du eine POST-Anfrage an den folgenden Endpunkt senden
https://[instance.de]/service/UserAddressManagement/address/[userID]/[addressID]
als Payload musst du ein UserAddressData-Objekt als JSON-Objekt senden. Bitte beachte, dass die konkreten Datenfelder von deiner Installation abhängen. Wir empfehlen daher, zuerst die Adresse zu laden, die entsprechenden Felder zu aktualisieren und die Daten zurückzusenden.
Die Antwort ist das aktualisierte UserAddressData-Objekt.
Eine benutzerspezifische Adresse löschen
Um eine benutzerspezifische Adresse zu löschen, musst du eine DELETE-Anfrage an den folgenden Endpunkt senden
https://[instance.de]/service/UserAddressManagement/address/[userID]/[addressID]