Einführung

SpikeTime bietet eine API, mit der eigene Software an die SpikeTime-Anwendung angebunden werden kann. Die SpikeTime API ist RESTful und wird mit den üblichen HTTP Verben GET, POST, PUT, DELETE aufgerufen. Daten werden im JSON-Format übertragen.

Der URI für die API über den alle Zugriffe erfolgen ist:

https://www.spiketime.de/api

Authentifizierung

Die Authentifizierung erfolgt über einen API-Key. Der API Key kann in den Benutzer-Einstellungen ausgelesen werden. Dieser Key muss im Header der Anfrage als “XAPIKEY” mitgegeben werden.

Methoden

Die API kann momentan:

  • Zeiteinträge
  • Projekte
  • Kunden
  • Stundensätze

… anlegen, ändern, auflisten, anzeigen und löschen.

Dokumentation

Um direkt mit der API loslegen zu können bieten wir die Dokumentation inklusive Beispielaufrufen in einer POSTMAN Collection an. POSTMAN ist unter http://www.getpostman.com/ kostenlos erhältlich (Google Chrome wird als WebBrowser benötigt).

Die Collection mit allen Beispielaufrufen ist unter dieser Adresse direkt zum Download verfügbar.

Die Collection wird nach der Installation von POSTMAN folgendermaßen eingebunden:

Schritt 1 – Klick auf Import Collection

Collection Import für die SpikeTime API

Schritt 2 – URL angeben und Import klicken

Import API aus URL

Danach stehen alle vorbereiteten Methoden im Collections-Tab bereit.

SpikeTime REST Api Collection

 

Die Dokumentation jeder einzelnen Anfrage ist durch einen Klick auf die Anfrage in der Liste sichtbar. Ebenso jeweils eine Beispielanfrage und eine Beispielantwort des SpikeTime-Servers.

SpikeTime Rest API Beispiel

 

Der API Key wird durch Klick auf “Headers” und ersetzen von “YOUR_API_KEY” durch den API Key, der in den Einstellungen der SpikeTime-Anwendung zu finden ist, festgelegt.

apikeypostman

Fragen

Bei Fragen zur API kannst du dich jederzeit an uns wenden mail@spiketime.de