API (Programmierschnittstelle)

Einführung

wachstum.at bietet eine REST/HTTP-API (Programmierschnittstelle), die es erlaubt, wichtige Funktionen von wachstum.at in andere Software-Anwendungen von Drittanbietern (zB Krankenhausinformationssysteme, Praxissoftware etc.) zu integrieren. Dabei deckt die API alle wichtigen Funktionen von wachstum.at ab, nämlich:

Hinweis: Für eine einfachere Lesbarkeit wird in dieser Dokumentation überall die vereinfachende Bezeichnung "Patient" anstelle von "Kinder, Patientinnen und Patienten" verwendet.

Die API arbeitet mit den Datenformaten XML und JSON zur Übergabe von Messdaten eines Patienten sowie zum Abruf der daraus berechneten Parameter eines Patienten.. Beide Datenformate unterstützen vollständig die selben Funktionen, wir empfehlen die Nutzung des moderneren und effizienteren JSON-Formats, bieten aber XML für Drittsysteme an, die noch nicht mit JSON umgehen können. Der Unterschied liegt neben dem Datenformat auch in den URL der einzelnen API-Endpunkte.

Für JSON steht eine umfangreiche, interaktive Dokumentation im OpenAPI/Swagger-Format zur Verfügung. In dieser Dokumentation wird daher beispielhaft das XML-Format verwendet.

Bitte beachten Sie, dass die Nutzung der API kostenpflichtig ist und es einen gesonderten Lizenzvertrags für die Nutzung bedarf. Gerne stellen wir aber einen kostenlosen, temporären API-Zugriff zur Verfügung. Bitte kontaktieren Sie uns, um einen API-Schlüssel zu erhalten. Loggen Sie sich dann in Folge ein, um die angezeigten Beispiele zu personalisieren und gleich mit Ihrem konkreten API-Schlüssel anzuzeigen.

Inhalt