Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
weiteres:webservices [2013/08/15 11:59] pfeiffer angelegt |
weiteres:webservices [2022/02/21 17:25] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
====== Webservices ====== | ====== Webservices ====== | ||
+ | |||
+ | Bei Bedarf steht sowohl eine SOAP wie auch eine JSON-RPC Schnittstelle zur Verfügung um Daten aus taginet von Fremdsystemen aus abzurufen. | ||
+ | |||
+ | ===== SOAP ===== | ||
+ | Der Zugriffspunkt lautet: https:// | ||
+ | |||
+ | Zugehörige WSDL-Datei: https:// | ||
+ | |||
+ | |||
+ | ===== JSON-RPC ===== | ||
+ | Der Zugriffspunkt lautet: https:// | ||
+ | |||
+ | Die SMD-Datei kann mittels GET unter obiger URL abgerufen werden. | ||
+ | |||
+ | |||
+ | |||
+ | ===== Konfiguration ===== | ||
+ | Die Benutzung der Webservices muss zunächst durch die Centerboard AG freigeschaltet werden: | ||
+ | * // | ||
+ | * Die Benutzer welche mittels API zugreifen möchten müssen die Berechtigungsgruppe // | ||
+ | Die berechtigten Benutzer erstellen dann selbstständig unter "Mein tagiNet" | ||
+ | |||
+ | ===== Funktionen ===== | ||
Momentan existieren folgende Funktionen: | Momentan existieren folgende Funktionen: | ||
- | getVertragspartner: | + | ==== getKinder ==== |
- | | + | |
- | 'elternid' (technische ID der Vertragspartner in tagiNet; wenn nicht angegeben, dann werden alle Eltern aufgelistet) | + | * Grunddaten sämtlicher Kinder |
- | | + | |
+ | * ' | ||
+ | |||
+ | ==== getEmails ==== | ||
+ | |||
+ | * E-Mails der zum heutigen Tag aktiven Vertragspartner | ||
+ | * Argumente: | ||
+ | * 'key' (API-Key zwingend) | ||
+ | |||
+ | ==== getVertragspartner ==== | ||
+ | |||
+ | * Listet alle (oder den einen) Vertragspartner plus zugehörige Kinder (mit Monatsbeitrag Kind) in einem mehrdimensionalen Array | ||
+ | * Argumente: | ||
+ | * ' | ||
+ | * ' | ||
- | getKontostand: | + | ==== getKontostand |
- | | + | |
- | ' | + | * Gibt den aktuellen Kontostand (Stand heute) als Float zurück |
- | Gibt den aktuellen Kontostand (Stand heute) als Float zurück | + | |
+ | | ||
+ | * ' | ||
- | getKontoauszug: | + | ==== getKontoauszug |
- | | + | |
- | ' | + | * Listet alle Kontobewegungen einer Familie in einem mehrdimensionalen Array |
- | Listet alle Kontobewegungen einer Familie in einem mehrdimensionalen Array | + | * Argumente: |
+ | * ' | ||
+ | | ||