Mittels TEAMBOX API kann programmgesteuert auf die TEAMBOX zugegriffen werden und somit TEAMBOX Daten in Applikationen integrieren oder mit der TEAMBOX interagieren.
So bietet die API zum Beispiel Zugriff auf folgende Endpoints:
- AddressSearch: Adresssuche (Vorname, Nachname, Firma …)
- Area: Bereich (Name, Beschreibung, …)
- AttendanceTime: Anwesenheitszeit (Mitarbeiter, Datum, Start, …)
- Authentification: Zuständig für die Authentifizierung
- Client: Kunde (Nummer, Name, Kürzel, …)
- Compay: Firma (Name, Adresse, Tel, …)
- Contact: Kontaktperson (Vorname, Nachname, Geschlecht, …)
- Currency: Währung (Name, ISO, …)
- Departement: Abteilung (Bezeichnung, Sortierung, …)
- Employee: Mitarbeiter (Username, Abteilung, Funktion, …)
- EmployeeFunction: Mitarbeiterfunktion (Bezeichnung, Sortierung, …)
- Feature: Feature (Name, aktiv, …)
- File: File (hochgeladene Files können über Token abgerufen werden)
- Holiday: Feiertage (Datum, Name, …)
- LeaveAccount: Ferienguthaben (Abwesenheit, Verfügbar, …)
- Leave: zum beantragen von Abwesenheiten wie Urlaub/Ferien usw.
- LeaveType: Art der Abwesenheit (Name, Farbe, …)
- Location: Standort (Name, Beschreibung, …)
- Phase: Phase (Name, Beschreibung, …)
- Project: Job (Job-Nr., Name, Budgetjahr, …)
- Rate: Tarif (Name, Einheit, …)
- Report: Report (Titel, Spalten, Filter, …)
- Service: Leistung für Zeiterfassung (Name, intern, …)
- StaffExpenseInvoice: Spesenabrechnung (Name, Datum, Positionen, …)
- Sticker: Sticker (Name, Kategorie, …)
- Subsidiary: Mandanten (Name, Kürzel, Währung, …)
- Team: Teams (Name, Bezeichnung, …)
- TimeEntry: Zeiteinträge (Datum, User, Anzahl, …)
- Todo: Arbeitspaket/Aufgabe (Titel, Beginn, Ende, …)
- Utils: Utils zum Beispiel zum Abrufen der API Spezifikation
Um die API nutzen zu können, braucht es einen TEAMBOX User.
Die Authentifizierung passiert dabei mittels “Bearer Token”. Dieser muss in einem ersten Schritt über die TEAMBOX erzeugt werden.
Die Berechtigungen des Users gelten auch für die API. Somit kann der User nur jene Daten über die API abrufen, für jene er in der TEAMBOX die jeweiligen Zugriffsrechte besitzt.
Die API Documentation ist dabei zentrale Übersicht und Beschreibung aller Endpoints, welche von der API zu Verfügung gestellt werden.
Mittels Button “Try it out” bietet die API Documentation zusätzlich die Möglichkeit, die Endpoints der API zu testen. Aber Vorsicht: Hierbei wird auf die Live Daten der TEAMBOX zugegriffen, sollten Sie also einen Endpoint testen, welcher zum Beispiel einen neuen Zeiteintrag hinzufügt, wird dieser in der TEAMBOX angelegt.
Um den “Try it out” Button nutzen zu können muss in einen ersten Schritt ein API Token generieren werden und anschliessend über den Button “Authorize” authentifizieren.
Dies kann wie folgt gemacht werden:
1. Token generieren
Hierzu beim Endpoint /authentication/getToken auf den Button “Try it out” klicken. Anschliessend kann der Username und das Password im Editor angepasst werden. Um den Token zu generieren, muss dann nur noch auf “Execute” geklickt werden.
Wenn die Authentifizierung erfolgreich war, erhalten Sie einen API Token. Diesen kann in der Server Response gesehen und kopiert weredn.
2. API Authentifikation mittels Token
Nun kann die API Authentifizierung vorgenommen werden. Dazu einfach auf den Butten “Authorize” klicken, im erscheinenden Feld Value “Bearer” sowie angehängt den kopierten Token eingeben und abschliessend auf “Authorize” klicken. Danach kann der “Try it out” Button in allen Endpoints verwendet werden.
3. Token-Verwaltungs UI
Bei den Persönliche Einstellungen, gibt es eine Registerkarte “API Tokens”. Hier kann der User eine beliebige Anzahl von Token für den persönlichen Gebrauch erstellen. Der Wert des Tokens wird nach der Erstellung automatisch in die Zwischenablage des Users kopiert. Zusätzlich wird dazu auch eine Meldung bzw. E-Mail generiert.
