API

Mit der API von didesk können andere Programme / Tools auf die Daten von didesk zugreifen und diese verändern.

API-Schlüssel

Für die Schnittstelle zu didesk benötigt der Drittanbieter einen sogenannten API-Schlüssel. Die Einstellungen der Schlüssel findest du unter Einstellungen -> Weitere Einstellungen -> API Schlüssel. Hierfür werden Administratorrechte benötigt.

API-Schlüssel erstellen

Um einen neuen API-Schlüssel zu erstellen, klicke auf den Button API Schlüssel erstellen. Gebe dem Schlüssel einen eindeutigen Namen und erteile die entsprechenden Berechtigungen. Klicke auf Speichern. Nun wird der API-Schlüssel angzeigt. Bitte kopiere diesen Schlüssel. Dieser kann, aus Sicherheitsgründen, nicht erneut angezeigt werden.

API-Schlüssel löschen

Über den Löschen-Button kannst du den API-Schlüssel entfernen. Der Drittanbieter hat dann keinen Zugriff mehr auf deine didesk Daten.

API-Schlüssel übermitteln

Bei einer Anfrage an die API muss der Schlüssel per GET Parameter als apiKey übergeben werden.

Aufruf / URL

Die Kommunikation mit der API erfolgt immer über folgende URL:

https://[PERSÖNLICHE-URL].didesk.de/papi/...

Die persönliche URL entspricht der individuellen Domain, über welche du dich bei didesk einloggst.

Verbindung prüfen

Mit folgendem Aufruf kann die Verbindung überprüft werden (Persönliche URL + apiKey ergänzen):

https://[PERSÖNLICHE-URL].didesk.de/papi/check?apiKey=XXXX

Wenn der Aufruf erfolgreich war, erhältst du folgende Antwort:

{
  "message": "success"
}

Pagination / Seiten

Ergebnisse pro Seite / per_page

Standardmäßig werden max. 100 Einträge pro Seite ausgegeben. Diese kann auf Wunsch angepasst werden. (maximal auf 200)

per_page=20 //Gibt 20 Ergebnisse pro Seite aus

Seite / page

Zeigt die übergebene Seite an. Wenn kein Wert gesetzt ist, wird immer die erste Seite ausgegeben.

page=2 //Gibt die zweite Seite aus, abhängig vom per_page Attribut

Ergebnis

Die API gibt bei einer Anfrage Informationen zu den verfügbaren Seiten aus:

total: Ergebnisse insgesamt,
per_page: Ergebnisse pro Seite,
current_page: aktuelle Seite,
last_page: letzte Seite,
first_page_url: URL zur ersten Seite,
last_page_url: URL zur letzten Seite,
next_page_url: URL zur nächsten Seite | null,
prev_page_url: URL zur vorherigen Seiten | null,
path: URL ohne Pagination,
from: Nummer des ersten Ergebnisses auf der aktuellen Seite,
to: Nummer des letzten Ergebnisses auf der aktuellen Seite

Allgemeine Filter

Die Ausgabe der API kann gefiltert werden indem gewisse Parameter mit der Anfrage übergeben werden. Im folgenden sind die allgemeinen Filter definiert. API Zugriffe auf verschiedene Module können weitere Filter bereitstellen, welche in der jeweiligen Dokumentation beschrieben werden.

Datum

Wenn gewünscht, können nur Datensätze ausgegeben werden, welche nach / vor einem definierten Datum erstellt wurden. Das Datum muss im Format JJJJ-MM-DD übergeben werden.

//gibt nur Datensätze aus, welche am 01.09.2024 oder später erstellt wurden
from_date=2024-09-01 

//gibt nur Datensätze aus, welche am 30.09.2024 oder früher erstellt wurden
to_date=2024-09-30