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).

JSON-Datenstruktur der Objekte (Antworten)

Die Antworten der Endpunkte dürfen flache oder verschachtelte JSON-Objekte zurückgeben. Beide Strukturen können verarbeitet werden.

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,
  "email": "[e-mail]",
  "username": "johnd",
}

In diesem Beispiel enthält das JSON-Objekt grundlegende Attribute wie eine eindeutige Kennung (ID), den Nutzernamen und die E-Mail-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": 1234,
  "email": "[e-mail]",
  "username": "johnd",
  "address": {
      "city": "kilcoole",
      "street": "new road",
      "number": 7682,
      "zipcode": "12926-3874"
  }
}

Hier hat das JSON-Objekt zusätzliche verschachtelte Strukturen für Adresse. Die Adressinformationen (untergeordnete Objekte) befinden sich in dem übergeordneten Objekt "address".