Hier findest du die APIs der in der d.velop cloud zur Verfügung stehenden Apps.

Da die APIs von einer Vielzahl von internen und externen Teams genutzt werden, setzen wir alles daran, keine inkompatiblen Änderungen zu machen. Beispielsweise bevorzugen wir die Verlinkung im Frontend statt die API unnötig breit zu machen. Darüber hinaus nutzen wir an vielen Stellen die JSON Hypertext Application Language, um Clients die Möglichkeit zu geben, die Endpunkte weiterführender Ressourcen zur Laufzeit zu ermitteln, statt diese Endpunkte fest im Code zu verdrahten. Damit deine Software davon profitiert, solltest du dich an die folgenden Regeln halten:

  • Insofern vorhanden, benutze die Hypermedia Links in den JSON Responses, um Links zu weiteren Ressourcen zur Laufzeit zu ermitteln und vermeide es, die URIs fest im Code zu hinterlegen.
  • Verwende ausschließlich die hier dokumentierten JSON Properties. In vielen Fällen enthält eine JSON Response zusätzliche Properties für das Frontend der dazugehörigen App. Diese nicht dokumentierten Properties sind aber nicht Bestandteil der öffentlichen API und können sich daher jederzeit ändern.
  • Entwickle deinen Client so, dass er mit unbekannten Properties umgehen kann, d.h. diese ggf. ignoriert, statt einen Fehler zu erzeugen.