Ob Sie ein Spendesk-Kunde oder ein Partner sind, der mit der Verwendung der Spendesk-API zur Erstellung einer Integration beginnen möchte, dieser Artikel ist für Sie:
Für Kunden, um Spendesk mit Ihrem Finanz- und Geschäftstool-Stack zu verbinden.
Für Partner, um Ihr Angebot mit Spendesk zu erweitern und auszubauen.
Entdecken Sie unser API-Entwicklerportal
Zunächst können Sie unser dediziertes Entwicklerportal für die Spendesk-API überprüfen, wo Sie alle relevanten Informationen finden:
Dokumentation
Changelog
Postman-Sammlung
Webhooks-Verwaltung
Wenn Sie speziell eine Buchhaltungsintegration erstellen möchten, um Ausgabendaten von Spendesk abzurufen, benötigen Sie folgende Funktionen:
Retrieve payables
Retrieve payable attachments
Retrieve settlements
Retrieve bank fees
Retrieve wallet loads
Retrieve wallet summary
Retrieve members
Retrieve suppliers
Retrieve analytical fields and values
Retrieve cost centers
Retrieve expense categories
API-Anmeldedaten erstellen
Sobald Sie unser Entwicklerportal überprüft haben, müssen Sie sich entweder direkt oder über unseren Kundensupport an das Vertriebsteam von Spendesk wenden. Sie werden Ihnen den Zugang zur API ermöglichen. Anschließend können Sie Ihre API-Anmeldedaten unter Einstellungen > Integrationen > API-Zugriffsverwaltung verwalten.
API-Anmeldedaten ermöglichen es Entwicklern, sich mit Ihrer Spendesk-Entität zu verbinden, Informationen darin abzurufen und zu bearbeiten, entsprechend den von Ihnen erteilten Berechtigungen.
Voraussetzungen:
Sie müssen unter dem Preisplan 'Premium' oder 'Enterprise' sein.
Sie müssen der Kontoinhaber bei Spendesk sein, um API-Anmeldedaten zu erstellen.
API-Zugriff implementieren
Um eine neue API Client-ID und ein Client-Secret zu erstellen, stellen Sie sicher, dass Sie die Voraussetzungen erfüllen, und befolgen Sie dann diese Schritte:
Klicken Sie auf Neuen Schlüssel erstellen.
Geben Sie einen Namen und eine Beschreibung für diesen API-Zugriff ein. Es ist wichtig, den Zweck dieser Anmeldedaten zu erwähnen, damit jeder sie später leicht identifizieren kann.
Wählen Sie ein Ablaufdatum. Das Ablaufdatum kann nicht später als ein Jahr ab heute sein. Wenn Sie diese Anmeldedaten jedoch mit einem externen Entwicklungsteam teilen, machen Sie es so kurz wie praktisch möglich. Im Zweifelsfall beginnen Sie immer mit kürzeren Gültigkeitszeiträumen (z. B. einen Monat) - Sie können später jederzeit neue API-Anmeldedaten mit demselben oder einem längeren Gültigkeitszeitraum erstellen. Es ist jedoch nicht möglich, die Gültigkeit bestehender API-Anmeldedaten zu verlängern - neue müssen erstellt werden.
Wählen Sie die Berechtigungen aus, die Sie diesem Satz von Anmeldedaten gewähren möchten.
Aktivieren Sie das Kontrollkästchen, um zu bestätigen, dass die neuen API-Anmeldedaten Zugriff auf die oben ausgewählten Funktionen und Daten ermöglichen. Es ist wichtig zu beachten, dass die Berechtigungen strikt mit den Nutzungsanforderungen übereinstimmen sollten, um Risiken zu minimieren und sichere API-Operationen zu gewährleisten.
Sobald Sie auf API-Schlüssel erstellen klicken, sehen Sie ein Modal mit einer Client-ID und einem Client-Secret. Dies ist der einzige Moment, in dem Sie das Client-Secret im Klartext sehen werden - es ist nicht möglich, es erneut abzurufen.
Wichtige Hinweise:
Wenn Sie das Client-Secret verlieren, müssen Sie einen neuen Satz von Anmeldedaten generieren.
Speichern Sie API-Anmeldedaten in einem sicheren Passwort-Tresor und teilen Sie sie niemals über Messaging/E-Mail. Darüber hinaus wird empfohlen, regelmäßige Überprüfungen der gespeicherten Anmeldedaten durchzuführen und diejenigen zu widerrufen, die nicht mehr verwendet werden.