API

Aus MV-Software Wiki
Wechseln zu: Navigation, Suche

Was ist eine API?

Eine API (Schnittstelle zur Anwendungsentwicklung; von engl. application programming interface) ist ein Programmteil, der zur Verfügung gestellt wird, um in anderen Programmen eingebunden zu werden. Die APIs von MV-Software werden mit einer Dokumentation zur Verfügung gestellt. Diese findest du auf den folgenden Seiten.

Welche APIs kann ich verwenden?

MV-Software stellt dir für deine Produkte APIs aus folgenden Services zur Verfügung:

NoRoX

Warum sollte ich APIs von MV-Software nutzen?

Die Schnittstellen der Services von MV-Software ermöglichen dir den einfachen Aufruf bestimmter Funktionen. Die APIs sind bewusst einfach gehalten und ermöglichen es somit Anfängern und Experten, die jeweiligen Services in ihre Programme einzubinden. Meist sind die APIs einfache GET-Requests, welche bestimmte Parameter enthalten und als Antwort ein einfach zu verwendendes JSON-Result liefern. Die APIs von MV-Software sind detailliert dokumentiert, sodass es einfach ist, die Funktionsweise zu verstehen und die gelieferte Antwort auszuwerten und weiterzuverarbeiten. Außerdem werden dir einfache Beispiele zur Verfügung gestellt.

Was muss ich bei der Nutzung der APIs beachten?

Versionen

Die APIs werden immer wieder aktualisiert und somit an die Bedürfnisse und Möglichkeiten der Services angepasst. Steht in einem Service beispielsweise eine neue Funktion zur Verfügung, wird diese bald auch in der entsprechenden API zu finden sein. Die Funktionen, die in Version 1.0 zur Verfügung stehen können auch mit Version 1.1 verwendet werden, aber nicht mit Version 2.0!

Was bedeutet das konkret?

Wenn eine Funktion zu einer API hinzugefügt wird oder so verändert wird, dass diese intern anders funktioniert aber das selbe Ergebnis liefert, ist keine weitere Aktion deinerseits nötig. Sollte eine Funktion aber entfernt oder so verändert werden, dass das gelieferte Ergebnis mit den alten Möglichkeiten nicht mehr verarbeitet werden kann, musst du deine API-Anbindung so überarbeiten, dass diese mit der neuen Version im Einklang ist.

Ein Beispiel

Du hast eine API-Funktion eingebunden, welche in der alten Version beispielsweise folgendes Ergebnis liefert: {"Result":"irgendwas"}.

Sollte eine Änderung innerhalb der API allerdings folgendes Ergebnis liefern: {"Result":"etwas anderes"}, ist keine Änderung deinerseits nötig, denn das Ergebnis lässt sich genauso auswerten wie zuvor. Die Versionsnummer würde nicht öffentlich angehoben werden, intern jedoch die Minor-Versionsnummer (z. B. von 1.0 auf 1.1).

Sollte die API nun so verändert werden, dass das Ergebnis in der neuen Version folgendermaßen aussieht {"result":"irgendwas"}, wird die Major-Versionsnummer angehoben (z. B. von 1.0 auf 2.0). Die neue Version ist somit nicht mehr mit der alten kompatibel, deine Funktionen müssen also wahrscheinlich umgeschrieben werden.

Erreichbarkeit

Es wird angestrebt, dass die APIs zu jeder Zeit erreichbar sind, jedoch kann dies nicht garantiert werden. Sollten eine oder mehrere APIs nicht verfügbar sein, bitten wir dich, uns dies mitzuteilen.

Fehler

Obwohl die APIs erst nach zahlreichen Tests freigegeben werden, können unvorhergesehene Szenarios Fehler hervorrufen, die in den Tests nicht bekannt wurden. In einem solchen Fall schreibe bitte eine Fehlermeldung in den MV-Software BugTracker (aktuell nicht verfügbar). Der Fehler wird danach nach Möglichkeit schnellstmöglich behoben.