Die CATAMA API für Kundendaten, gibt Ihnen die Daten als JSON zurück und antwortet mit den Keys “data” (mit den Kundendaten), dem Feld “status” (1 oder 0) für den Erfolg des Abrufs sowie einer Nachricht “message” die ggf. eine Fehlermeldung enthält. Die Funktion steht für CATAMA Enterprise Unlimited Instanzen zur Verfügung.

GET – Zum Auslesen sämtlichen Kundendatensätze

Endpunkt:
https://ihre-catama-url/api/customers/list

Pflichtparameter:
token – String = Token für den API-Aufruf

Optionale Parameter:
offset – Integer = Angabe ab welchem Datensatz die Datenselektion erfolgen soll (nur in Kombi mit take)
take – Integer = Anzahl an Datensätzen, die selektiert werden sollen (nur in Kombi mit offset)
typeid – Integer = Filteroption nach dem Kunden-Typ (Wiederverkäufer, Endkunde etc.)

Beispiel – Abruf der Daten für sämtliche Kunden
https://ihre-catama-url/api/customers/list?token=IHRGEHEIMERCATAMATOKEN

Beispiel – Abruf der Daten für Kunden ab dem 10. Datensatz (offset = 10), mit maximal 10 Datensätzen als Rückgabe-Inhalt (take=10) übergeben
https://ihre-catama-url/api/customers/list?token=IHRGEHEIMERCATAMATOKEN&take=10&offset=10

Filter nach Type-ID (am Beispiel von typeid=3 für Wiederverkäufer)
https://ihre-catama-url/api/customers/list?token=IHRGEHEIMERCATAMATOKEN&typeid=3

GET – Zum Auslesen spezifischer Kundendaten

Endpunkt:
https://ihre-catama-url/api/customers/byid

Pflichtparameter:
id – Integer = ID des Kunden (Kundennummer)
token – String = Token für den API-Aufruf

Beispiel – Abruf der Daten für Kunde mit KD1
https://ihre-catama-url/api/customers/byid?id=1&token=IHRGEHEIMERCATAMATOKEN