Benutzer-Werkzeuge

Webseiten-Werkzeuge


weiteres:webservices

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
weiteres:webservices [2013/08/15 12:00]
pfeiffer
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://www.taginet.com/KRIPPENNAME/soap.php .
 +
 +Zugehörige WSDL-Datei: https://www.taginet.com/KRIPPENNAME/soap.php?wsdl
 +
 +
 +===== JSON-RPC =====
 +Der Zugriffspunkt lautet: https://www.taginet.com/KRIPPENNAME/json-rpc.php
 +
 +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:
 +  * //api_enabled// wird in der Konfiguration auf //Ja// gesetzt
 +  * Die Benutzer welche mittels API zugreifen möchten müssen die Berechtigungsgruppe //Webservices// eingeteilt werden.
 +Die berechtigten Benutzer erstellen dann selbstständig unter "Mein tagiNet" / "API-Key" einen individuellen API-Schlüssel.
 +
 +===== Funktionen =====
  
 Momentan existieren folgende Funktionen: Momentan existieren folgende Funktionen:
  
-getVertragspartner:  +==== getKinder ==== 
-   * Argumente: 'key' (API-Key zwingend) + 
-              'elternid' (technische ID der Vertragspartner in tagiNet; wenn nicht angegeben, dann werden alle Eltern aufgelistet+   * Grunddaten sämtlicher Kinder 
-   * Listet alle (oder den einen) Vertragspartner plus zugehörige Kinder (mit Monatsbeitrag Kind) in einem mehrdimensionalen Array+   * Argumente:  
 +      * 'key' (API-Key zwingend) 
 + 
 +==== 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:  
 +      * 'key' (API-Key zwingend),  
 +      * 'elternid' (technische ID der Vertragspartner in tagiNet; wenn nicht angegeben, dann werden alle Eltern aufgelistet)
        
-getKontostand: +==== getKontostand ==== 
-   * Argumente: 'key' (API-Key zwingend),  +
-                  'elternid' (technische ID der Vertragspartner in tagiNet; zwingend)+
    * Gibt den aktuellen Kontostand (Stand heute) als Float zurück    * Gibt den aktuellen Kontostand (Stand heute) als Float zurück
 +   * Argumente: 
 +       * 'key' (API-Key zwingend), 
 +       * 'elternid' (technische ID der Vertragspartner in tagiNet; zwingend)
        
-getKontoauszug: +==== getKontoauszug ==== 
-   * Argumente: 'key' (API-Key zwingend),  +
-                  'elternid' (technische ID der Vertragspartner in tagiNet; zwingend)+
    * Listet alle Kontobewegungen einer Familie in einem mehrdimensionalen Array    * Listet alle Kontobewegungen einer Familie in einem mehrdimensionalen Array
 +   * Argumente: 
 +      * 'key' (API-Key zwingend), 
 +      * 'elternid' (technische ID der Vertragspartner in tagiNet; zwingend)
 +
  
weiteres/webservices.1376560820.txt.gz · Zuletzt geändert: 2022/02/21 17:25 (Externe Bearbeitung)