teamspace bringt eine REST-API mit, über die du Daten aus deiner Installation auslesen und neue Daten anlegen kannst – aus eigenen Skripten, aus Fremdsystemen oder von Geräten wie einem Zeiterfassungsterminal. Statt über die Oberfläche zu klicken, sprichst du teamspace direkt über HTTP-Anfragen an.
Die API folgt durchgängig denselben Prinzipien: Jede Ressource hat eine Adresse (URL), die Anfrage erfolgt mit den üblichen HTTP-Methoden (GET zum Lesen, POST zum Anlegen, PUT zum Ändern), und die Authentifizierung läuft über ein Gerätepasswort (API-Token) per Basic Auth.
Standards, auf denen die API aufbaut
Die API setzt auf etablierten Web-Standards auf – wer sie kennt, findet sich schnell zurecht:
- REST – Ressourcen werden über URLs angesprochen, Aktionen über HTTP-Methoden ausgedrückt.
- HATEOAS – Antworten enthalten Links (
href) zu verwandten Ressourcen. Statt IDs selbst zusammenzubauen, folgst du den Verknüpfungen, die die API mitliefert. - JSON – Anfragen und Antworten sind JSON-Objekte.
- Basic Auth – jede Anfrage authentifiziert sich per HTTP Basic Authentication (Geräte-ID und Token).
Im Aufbau: Die API wird laufend erweitert. Aktuell sind vor allem die Bereiche Zeiterfassung (Projektliste, Zeiten buchen, Check-In/Out), CRM (Kontakte und Organisationen) sowie Kosten/Spesen gut zugänglich. Weitere Ressourcen kommen mit neuen teamspace-Versionen hinzu.
Wofür sich die API eignet
- Eigene Integrationen: Daten zwischen teamspace und einem Fremdsystem abgleichen (z. B. ein Webshop legt Kontakte oder Belege an).
- Automatisierung: wiederkehrende Massenvorgänge per Skript erledigen, statt sie einzeln zu klicken.
- Geräte & Terminals: ein Zeiterfassungsterminal checkt Mitarbeiter ein und aus – über eine eigene, neutrale Zugangsberechtigung.
- Auswertungen: Daten regelmäßig auslesen und in eigene Reports oder Dashboards überführen.
Was du zum Start brauchst
- Eine teamspace-Installation mit ihrer Server-Adresse (z. B.
https://app1.teamspace.de). - Zugangsdaten für die API – ein Gerätepasswort (API-Token) oder eine API-Zugangsberechtigung. Wie du dich anmeldest, steht in Authentifizieren: Gerätepasswort & API-Token.
- Grundverständnis von REST/HTTP – welche URL welche Ressource anspricht, erklärt Aufbau der API-Adressen.
Wegweiser durch das Thema
- Adressen verstehen: Aufbau der API-Adressen (URL-Struktur) – wie sich Collection, Element-ID, Matrix-Parameter und Query zu einer URL zusammensetzen.
- Anmelden: Authentifizieren: Gerätepasswort & API-Token – Gerätepasswort anlegen und per Basic Auth nutzen.
- Geräte & Dienste: API-Zugangsberechtigung für Terminals & Dienste – neutrale Autorisierung ohne persönlichen Nutzer.
- Üben: Kontakt über die API anlegen – ein vollständiger Anwendungsfall Schritt für Schritt.
- Belege: Spesen & Belege über die API anlegen und die Feldreferenz: Spesen- und Belegfelder.
- Sicher betreiben: API-Sicherheit & Berechtigungen.
Werkzeuge zum Ausprobieren
- API-Explorer: eine eingebaute Browser-App, mit der du die API durchsuchst und siehst, wie Ressourcen und Beziehungen aufgebaut sind. Du erreichst sie unter
<server>/htdocs/apps/apiexplorer/index.html(öffentliches Beispiel:https://sync.projectfacts.de/htdocs/apps/apiexplorer/index.html). - Datenmodell als TypeScript: Die JSON-Repräsentationen liegen als TypeScript-Klassen unter
<server>/api/api/dto.ts– nützlich, um Felder und Typen nachzuschlagen. - Browser-Entwicklertools: Über sie verfolgst du die echte Kommunikation zwischen App und API.
Vollständige Referenz – der API Compact Guide: Die ausführliche Gesamtanleitung mit konkreten Request- und Response-Beispielen ist der API Compact Guide – als PDF, PowerPoint und online. Alle Downloads liegen auf der Seite API Compact Guide. Dieses Hilfecenter erklärt die Konzepte und die wichtigsten Abläufe; für vollständige Payloads ist der Compact Guide die maßgebliche Quelle.