Tafa API-Dokumentation

kid-purification

Kids und die Tagesfamilien-App sprechen dieselbe Sprache.

Die Tafa-API nimmt Stammdaten aus Kids entgegen, prüft sie und schreibt sie in die Datenbank der App. Zurück nach Kids gehen die Monatsrapporte: zusammengerechnet und bereit für die Abrechnung.

So läuft ein Abgleich

  1. 01

    Annehmen

    Kids schickt Eltern, Kinder, Tageseltern und Verträge im eigenen Format. Monatsrapporte werden auf Abruf für einen Monat zurückgegeben.

  2. 02

    Zuordnen

    Jeder Satz wird über die Kids-ID mit Elternteil, Kind, Tageseltern und Vermittlerin verknüpft. Fehlt ein Bezug, bleibt dieser Satz stehen und wird einzeln gemeldet.

  3. 03

    Übernehmen

    Neue Einträge werden angelegt, bekannte aktualisiert. Einladungen für Tageseltern können dabei mit ausgelöst werden.

Was übertragen wird

Fünf Bereiche, jeder mit eigener Route unter /api/v1.

  • Eltern

    POST · PUT

    Namen, E-Mail und Mobilnummer von Mutter und Vater, adressiert über die Eltern-ID.

    /api/v1/parent
  • Kinder

    POST · PUT

    Vor- und Nachname, Zugehörigkeit zu den Eltern und das Austrittsdatum.

    /api/v1/child
  • Tageseltern

    POST · PUT

    Adresse, Kontakt, Mitarbeitendennummer und zuständige Vermittlerin. Austritt und Einladung werden mitgeführt.

    /api/v1/user
  • Verträge

    POST · PUT · DELETE

    Betreuung von–bis, Ferienvertrag und Platzierungen mit Wochentag, Zeiten und Bereitschaft.

    /api/v1/contract
  • Rapporte

    GET · POST

    Eingereichte Monate, zusammengerechnet nach Arbeitszeit, Wartezeit, Mahlzeiten, Übernachtungen, Kilometern und Spesen. Ein Monat kann geschlossen werden.

    /api/v1/reports

Schnittstelle

Aufrufe unter /api/v1 brauchen einen API-Schlüssel im Header Authorization. Felder, Antworten und Fehler stehen in der OpenAPI-Beschreibung.

Dokumentation öffnen

Tafa API 1.1 · Daten aus Kids für die Tagesfamilienbetreuung