Ankündigung: Update der mite.api

[Update 1.3.] Wie angekündigt wurde die aktualisierte mite.api heute veröffentlicht. Bitte hier entlang zur neuen Dokumentation.

Am kommenden Sonntag, den 1. März wird unsere offene Datenschnittstelle, die mite.api, aktualisiert werden. Frische, zusätzliche Funktionen werden bald bereitstehen. Eure Wünsche, die uns seit der Veröffentlichung der API im August vergangenen Jahres erreichten, sollen Eingang finden – vorneweg das ausführliche Feedback von Billomat (merci!).

Werte Entwickler: bitte werft einen Blick auf die nachfolgend detailliert erläuterten Änderungen. Kleinere Umbauten auch auf eurer Seite können notwendig werden.

/times wird zu /daily

Die alte URI wird allerdings weiterhin funktionieren.

/timesheets wird zu /time_entries

Die alte URI wird weiterhin funktionieren. Die Root-Tags der ausgegebenen XML-Daten verändern sich jedoch dauerhaft von timesheets zu time_entries bzw. von timesheet zu time_entry.

/time_entries erlaubt vollen Zugriff

Im Gegensatz zur alten Ressource /timesheets kann nun über /time_entries auf alle Zeiten aller Benutzer zugegriffen werden. WICHTIG: Bei einem normalen GET auf /time_entries.xml werden nun alle Zeiteneinträge aller Benutzer angezeigt. Diese Liste kann jedoch nun gefiltert werden (s.u.).

/time_entries mit Filter- und Gruppierungkriterien

Filtern nach:

• customer_id
• project_id
• service_id
• user_id
• billable: »true« oder »false«
• note (Freitextsuche)
• at: today, yesterday, this_week, last_week, this_month, last_month oder einzelner Tag (im Format YYYY-MM-DD)
• from, to (beide im Format YYYY-MM-DD)

Gruppieren mit »group_by« Parameter nach:

• customer
• project
• service
• user
• day
• week
• month
• year

Mehre Parameter werden mit Komma getrennt (bspw.: »user, service«). Die Reihenfolge ist entscheidend für die Sortierung der Ausgabe.

/time_entries und /projects mit Namen der verbundenen Ressourcen

Für Zeiteinträge und Projekte wird für alle verbundenen Ressourcen nicht nur die ID, sondern auch der Name ausgeben. Beispielsweise wird unter /projects zusätzlich das Attribut »customer_name« ausgegeben, unter /time_entries »customer_name«, »project_name«, »service_name« und »user_name«.

JSON

Die API unterstützt neben XML nun auch das JSON-Format.

Einfachere Authentifizierung

Neben der Authentifizierung über den API-Schlüssel unterstützt die mite.api nun auch die Benutzung der normalen Anmeldedaten E-Mail und Passwort.

Die Dokumentation der neuen, ab kommendem Sonntag gültigen Version steht ab sofort bereit. Gut Code, ihr Tüftler!

Julia in Neue Features, Maschinenraum