< Zurück zur sevDesk Webseite

sevDesk API

sevDesk bietet dir die Möglichkeit, Daten über eine Schnittstelle – die sevDesk API – zu verwalten und darüber alle fast alle Funktionen abzubilden, die über unsere Web-Oberfläche auch vorhanden wären.
Über die API kannst du dadurch tagtägliche Geschäftsprozesse automatisieren und sparst dir wertvolle Zeit, um dich um die wichtigeren Dinge zu kümmern.

Die sevDesk API ist eine REST API.
Ressourcen die du in unserer API findest tragen meist den selben Namen wie das entsprechende Modal, das du in sevDesk verwenden würdest, oder manchmal auch ein Synonym davon, da es unterschiedliche Varianten gibt.
Beispiele dafür wären zum Beispiel:

  • Invoice für das Rechnungs-Modal
  • Voucher für das Belege-Modal
  • CreditNote für das Gutschriften-Modal

OpenAPI-Spezifikation

Eine vollständige Auflistung aller Ressourcen der API, sowie die Operationen (Requests) die darauf ausgeführt werden können, findest du in unserer OpenAPI-Spezifikation.

Anmerkung_2020-05-19_144310.jpg

Leider ist diese momentan nicht mehr auf dem aktuellsten Stand, weswegen so manches Modal das du in sevDesk vorfindest noch keine äquivalente Ressource dort besitzt und die Bodies mancher Requests nicht mehr valide wären.
Wir arbeiten bereits mit Hochdruck an einer neuen Version der Spezifikation mit einer verbesserten Oberfläche, um dir die Arbeit mit unserer API zu erleichtern und unnötige Testerei und Suche zu ersparen.

Tipp

Sehr hilfreich ist es bis dahin auch, wenn man in der sevDesk Oberfläche die einzelnen Calls über die Developer Console eines Browsers nachvollzieht. Die Web-Oberfläche verwendet auch die API. 

API-Overview

Da wir dich bis dahin aber nicht alleine lassen möchten, stellen wir dir schon jetzt die Alpha-Version unserer in Arbeit befindlicher API-Overview zur Verfügung.


Anmerkung_2020-05-19_144434.jpg

Diese bietet dir eine ausführliche Einführung in unsere API und führt dich von der Authentifizierung, über den ersten Request, bis hin zu einer ebenso ausführlichen Erklärung der größten und meist genutzten sevDesk Modale und deren Nutzung über die API.
Die API-Overview soll dabei die OpenAPI-Spezifikation nicht ersetzten, sondern sie Komplementieren und dient dir vor allem als Einstiegspunkt, falls dies dein erster Kontakt mit unserer API ist.

Du findest sie hier.

Wichtig

Da es sich wie gesagt noch um die Alpha-Version handelt, bestehen noch diverse Bugs die aber zum großen Teil im UI zu finden sind.
Alle Unstimmigkeiten die du außerhalb von diesem findest, kannst du uns aber sehr gerne zukommen lassen!
Neben der OpenAPI-Spezifikation arbeiten wir gleichzeitig auch an der Overview und von dir gemeldete Fehler werden überprüft und berücksichtigt.

Bei Fragen oder Problemen stehen wir gerne mit unserem technischen Support zur Hilfe bereit.

 

 

0 Kommentare

Zu diesem Beitrag können keine Kommentare hinterlassen werden.