Die CATAMA API für Kundendaten, gibt Ihnen die Daten als JSON zurück und antwortet mit den Keys „data“ (mit den Fahrzeugdaten und optional den dazu gehörenden Kundendaten), dem Feld „status“ (1 oder 0) für den Erfolg des Abrufs sowie einer Nachricht „message“, die ggf. eine Fehlermeldung enthält. Überdies können Sie die API zum Erstellen von Kundendaten (POST) nutzen. Die Funktion steht für CATAMA Enterprise Unlimited Instanzen zur Verfügung.
GET – Zum Auslesen der Kundendaten im Status „aktiv“
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, um nach Kundentyp zu filtern (1 = Endkunde, 2 = Werkstätten, 3 = Wiederverkäufer, 4 = Großkunden, 5 = Regionalhändler, 6 = Interessent, 99 = Interner Kunde)
Beispiele:
Abruf der Daten für sämtliche Kunden
https://ihre-catama-url/api/customers/list?token=IHRGEHEIMERCATAMATOKEN
Ab dem ersten Datensatz (0) werden 10 Datensätze übergeben
https://ihre-catama-url/api/customers/list?token=IHRGEHEIMERCATAMATOKEN&offset=0&take=10
https://ihre-catama-url/api/customers/list?token=IHRGEHEIMERCATAMATOKEN&typeid=3
GET – Zum Auslesen eines Kunden anhand der ID
Endpunkt:
https://ihre-catama-url/api/customers/byid
Pflichtparameter:
token – String = Token für den API-Aufruf
id – Integer = ID des Kunden (Kundennummer)
Beispiel – Abruf der Daten für Kundendatensatz mit ID 1 (KD1)
https://ihre-catama-url/api/customers/byid?id=1&token=IHRGEHEIMERCATAMATOKEN
POST – Zum Erzeugen eines neuen Kundendatensatzes
Endpunkt:
https://ihre-catama-url/api/customers/api/customers/create
Pflichtparameter:
token – String = Token für den API-Aufruf
title_id – Integer z.B. 1
company – String z.B. „404MEDIA.“
forename – String z.B. „Stefan“
lastname – String z.B. „Pingel“
extra – String z.B. „Stockwerk 1“
street – String z.B. „Töpferstraße 18“
zip – String z.B. „19336“
city – String z.B. „Bad Wilsnack“
country – String z.B. „Deutschland“
phone_mobile - String z.B. „4915170251996“
phone_primary – String z.B. „015170251996“
phone_secondary – String z.B. „4915170251996“
email_primary – String z.B. „info@404media.de“
email_secondary – String z.B. „foo@404media.de“
email_tertiary – String z.B. „spam@404media.de“
kind_id – Integer z.B. 2
type_id – Integer z.B. 1
bank_name – String z.B. „V&R Bank“
bank_account_holder – String z.B. „Stefan Pingel“
bank_iban – String z.B. „DE123123132123“
bank_bic – String z.B. „BICDEAS“
birthday - String z.B. „21.03.2000“
online_invoice – Integer z.B 1 (oder 0)
Die API gibt hier die übermittelten Daten als JSON zurück und antwortet im Key „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 oder „Success“.
Ferner wird der Key „customer_id“ mit der erzeugten Kundennummer zurückgegeben.
Ein Formular mit sämtlichen Werten für die title_id, kind_id, type_id finden Sie hier:
https://support.catama-software.de/api/formtest.html
Bei Fragen zur API, steht Ihnen unser Support jederzeit zur Verfügung.