Schnellstart
Um ein PVS an den Abrechnungsdienst anzuschließen, müssen Sie folgende Schritte ausführen:
Sie benötigen eine Möglichkeit, die GraphQL-API des Abrechnungsdienstes anzusprechen (GraphQL-Client). Die Internetseite www.graphlql.org bietet einen Überblick über verfügbare Clients für verschiedene verbreitete Programmiersprachen. Die Entwicklung eines eigenen Clients auf Basis einer reinen HTTPS-Kommunkation ist ebenfalls möglich
Der Abrechnungsdienst stellt unter der Adresse https://api.play.abrechnung.io/graphql einen Testserver bereit, auf dem Entwickler ihre Software testen können. Zum Zugriff auf diesen Testserver benötigen Sie pro Institutionskennzeichen (IK) einen API-Key und zur Kennzeichnung des PVS eine PartnerId. Beides können Sie unter dev@abrechnung.io anfordern. Bitte nennen Sie in der E-Mail die IK, mit denen Sie testen möchten. Beachten Sie, dass der Abrechnungsdienst nur IK mit gültiger Prüfziffer verarbeitet. Wenn Sie kein IK nennen, ordnet der Abrechnungsdienst dem API-Key ein privates IK zu, dass mit "99" beginnt. Näheres zur Verwendung des API-Keys finden Sie unter Authorisierung.
Machen Sie sich mit den Grundlagen und Begriffen des Abrechnungsdienstes vertraut.
Realisieren Sie als erstes die Funktion aktuelle Konfiguration abrufen.
Anschließend können Sie die Funktionen Abrechnungsvorgang einreichen und Abrechnungsvorgang stornieren zur Ihrer Software hinzufügen.
Die Funktionen Zur Abrechnungshistorie abspringen und Abrechnungsauftrag erteilen können die Anwender des PVS auch über das Kundenportal erreichen. Es handelt sich daher um optionale Funktionen, die gut in den Kontext vieler PVS passen, die aber entweder nicht oder später realisiert werden können.
Produktivumgebung
Die Produktivumgebung erreicht Ihr PVS unter der Adresse https://api.abrechnung.io/graphql. Sie verhält sich genauso wie die Testumbegebung, ist aber nur mit API-Keys erreichbar, die der Abrechnungsdienst an Kunden ausgibt.