Voraussetzung der eigenen Schnittstelle/API

Um die Anbindung einer anderen oder eigenen Schnittstelle/API an die Plattform zu ermöglichen müssen die auf dieser Seite aufgeführten Anforderungen erfüllt sein.

Allgemeine Anforderungen

• Art der API: REST (Representational State Transfer) API.

• Unterstützte Anfragemethoden: GET, POST, PATCH, PUT, DELETE.

• Datenformat: JSON (JavaScript Object Notation).

  • Einschränkungen zu der Struktur kommen im folgenden Punkt "Flache JSON-Datenstruktur der Objekte"

Flache JSON-Datenstruktur der Objekte

Aktuell müssen die Antworten der Endpunkte flache JSON-Objekte zurückgeben.

Die Möglichkeit zur Verarbeitung von verschachtelte JSON-Objekten ist derzeit in Arbeit.

Beispiel flache JSON-Datenstruktur

Dies bedeutet, dass die Antwort von Endpunkten einfache JSON-Objekte sind, die keine verschachtelten Unterstrukturen aufweisen. Ein Beispiel für eine flache JSON-Datenstruktur ist wie folgt:

{
  "id": 1234,
  "name": "John Doe",
  "age": 30,
  "email": "[e-mail]",
  "address": "123 Main Street"
}

In diesem Beispiel enthält das JSON-Objekt grundlegende Attribute wie eine eindeutige Kennung (ID), den Namen, das Alter, die E-Mail-Adresse und die Adresse der Person. Diese Attribute sind alle auf derselben Ebene und es gibt keine weiteren verschachtelten Strukturen.

Beispiel verschachtelte JSON-Datenstruktur

Im Gegensatz dazu können verschachtelte JSON-Datenstrukturen weitere Ebenen von Objekten enthalten. Ein Beispiel dafür ist wie folgt:

{
  "id": 5678,
  "name": "Jane Smith",
  "age": 25,
  "contact": {
    "email": "[e-mail]",
    "phone": "555-123-4567"
  },
  "address": {
    "street": "456 Elm Street",
    "city": "Anytown",
    "state": "CA",
    "zip": "12345"
  }
}

Hier hat das JSON-Objekt zusätzliche verschachtelte Strukturen für Kontaktinformationen und Adresse. Die Kontaktinformationen sind in einem separaten Objekt "contact" enthalten, das die E-Mail-Adresse und die Telefonnummer enthält. Ebenso ist die Adresse in einem separaten Objekt "address" enthalten, das Straße, Stadt, Bundesland und Postleitzahl enthält.