Diese Dokumentation beschreibt alle API-Methoden für die folgenden Aktionen:

• Abrufen von Listen von Objekten (List-Methode)
• Listenfilterung (Listenmethode mit Filterdaten)
• detaillierte Informationen über ein Objekt abrufen (show-Methode)
• Abrufen von Daten für das Formular zum Hinzufügen von Objekten (Add-Methode)
• Daten als neues Objekt speichern (store-Methode)
• Abrufen von Daten für das Objektaktualisierungsformular (Bearbeitungsmethode)
• Speichern der Daten des aktualisierten Objekts (Update-Methode)

Die API akzeptiert nur Anfragen von einer begrenzten Liste von IP-Adressen (z. B. von der Account-Site eines Kunden oder einer Backoffice-Site).

Jede Anfrage an die API von einer IP-Adresse, die nicht auf der Zulassungsliste steht, wird abgelehnt.

Dies geschieht, um DDoS-Angriffe auf die API, Versuche zur Fälschung von Anfragen und Hacker-Experimente zu verhindern.

Benutzer greifen immer auf die öffentliche Seite der Plattform (Kundenbüro oder Backoffice) zu, und diese Seite selbst fordert die erforderlichen Daten von der API der Plattform an. Da die IP-Adresse der Website fest ist, wird sie auf der Liste der zugelassenen Websites aufgeführt.

Alle API-Anforderungen werden mit den folgenden HTTP-Methoden gestellt:

• GET zum Auflisten, Anzeigen, Hinzufügen und Bearbeiten
• POST für Laden
• PUT für Aktualisierung
• DELETE zum Löschen

Jeder Abschnitt der API enthält eine URL, an die eine Anfrage gestellt wird, um die relevanten Daten zu erhalten.

Die HTTP-Request-Methode wird vor jeder URL angegeben.

Jede API-Anfrage muss immer 4 Variablen enthalten:

1. data (json-String mit Datenarray für API)
2. user (json-String mit einem Array von Daten über den aktuellen Benutzer)
3. time (aktuelle Uhrzeit in UTC-Zeitzone)
4. hash (digitale Signatur in Form eines Hashs, um zu verifizieren, dass die Anfrage an die API definitiv von einer autorisierten Quelle stammt)

Wenn die Anfrage erfolgreich ist, gibt die API immer zwei Variablen zurück:

1. status = true (Erfolgsstatus)
2. data (json-String mit Datenarray von API)

Wenn die Anfrage fehlschlägt, zeigt die API die Variablen an:

1. status = false (Fehlerstatus)
2. error (Textzeichenfolge, die den Fehler beschreibt)

Jede API-Anforderung muss eine Hash-Variable enthalten, die die digitale Signatur der Anforderung darstellt.

hash = md5($json . $time . $salt)

• md5, sha256, bcrypt — verfügbaren Verschlüsselungsalgorithmen
• $json — json-String mit Anforderungsdaten
• $time — Uhrzeit im Format "TT.MM.JJJJ HH:MM:SS"
• $salt — fester eindeutiger Wert ("Salz") für die Plattform-API