Native Integration mit der Spendesk API erstellen
Verbinden Sie Spendesk mit Ihren anderen Business-Tools oder erstellen Sie eine Partner-Integration mithilfe der Spendesk API. Dieser Artikel behandelt Entwicklerressourcen, die Einrichtung von Zugangsdaten und Voraussetzungen.
Für: Kontoinhaber (Account Owner) im Premium-Plan (Kunden) und Technologiepartner, die Integrationen mit Spendesk entwickeln.
Inhaltsverzeichnis
Bevor Sie beginnen
Das Entwicklerportal entdecken
API-Zugangsdaten erstellen
API-Zugriff einrichten
Fehlerbehebung
Bevor Sie beginnen
👥 Nur Kontoinhaber (Account Owner) können API-Zugangsdaten in Spendesk erstellen und verwalten.
Das Entwicklerportal entdecken
Beginnen Sie mit der Erkundung des speziellen Entwicklerportals für die Spendesk API. Dort finden Sie: Dokumentation, Änderungsprotokoll (Changelog), Postman-Collection, Webhook-Verwaltung.
Wenn Sie eine Buchhaltungsintegration entwickeln, um Ausgabendaten aus Spendesk abzurufen, benötigen Sie Zugriff auf diese Funktionen: Verbindlichkeiten (Payables) abrufen, Anhänge zu Verbindlichkeiten abrufen, Abrechnungen (Settlements) abrufen, Bankgebühren abrufen, Wallet-Aufladungen abrufen, Wallet-Übersicht abrufen, Mitglieder abrufen, Lieferanten abrufen, Analytische Felder und Werte abrufen, Kostenstellen abrufen, Ausgabenkategorien abrufen.
API-Zugangsdaten erstellen
Wenden Sie sich direkt oder über den Spendesk-Kundensupport an das Spendesk-Vertriebsteam, um API-Zugriff anzufragen. Nach der Freigabe verwalten Sie Ihre API-Zugangsdaten unter Einstellungen > Integrationen > API-Zugriff verwalten.
Mit API-Zugangsdaten können Entwickler sich mit Ihrer Spendesk-Entität verbinden und Informationen abrufen oder bearbeiten, basierend auf den von Ihnen erteilten Berechtigungen.
🔒 Der API-Zugriff ist nur im Premium-Plan verfügbar.
API-Zugriff einrichten
Folgen Sie diesen Schritten, um eine neue API-Client-ID und ein neues Client-Secret zu erstellen:
Navigieren Sie zu Einstellungen > Integrationen > API-Zugriff verwalten
Klicken Sie auf Neuen Schlüssel erstellen
Geben Sie einen Namen für diesen API-Zugriff ein
Geben Sie eine Beschreibung für diesen API-Zugriff ein und nennen Sie den Zweck, damit er später leicht identifizierbar ist
Wählen Sie ein Ablaufdatum (bis zu einem Jahr ab heute)
Wählen Sie die Berechtigungen (Scopes) aus, die diesen Zugangsdaten erteilt werden sollen
Aktivieren Sie das Kontrollkästchen, um zu bestätigen, dass diese Zugangsdaten auf die ausgewählten Funktionen und Daten zugreifen werden
Klicken Sie auf API-Schlüssel erstellen
Nachdem Sie auf API-Schlüssel erstellen geklickt haben, wird ein Fenster mit Ihrer Client-ID und Ihrem Client-Secret angezeigt.
⚠️ Das Client-Secret wird Ihnen nur einmal im Klartext angezeigt. Es kann nicht erneut abgerufen werden – wenn Sie es verlieren, müssen Sie neue Zugangsdaten generieren.
💡 Wenn Sie Zugangsdaten mit einem externen Entwicklungsteam teilen, wählen Sie die kürzestmögliche praktikable Ablaufdauer (zum Beispiel einen Monat). Sie können später jederzeit neue Zugangsdaten mit derselben oder einer längeren Gültigkeitsdauer erstellen. Bestehende Zugangsdaten können nicht verlängert werden – Sie müssen neue erstellen.
Fehlerbehebung
Symptom: Sie sehen die Option „API-Zugriff verwalten" unter Einstellungen > Integrationen nicht.
Ursache: Ihr Unternehmen befindet sich nicht im Premium-Plan, oder Sie wurden noch nicht für den API-Zugriff freigeschaltet.
Lösung: Wenden Sie sich an den Spendesk-Kundensupport oder Ihren Account Manager, um API-Zugriff anzufragen. Bestätigen Sie den Plan Ihres Unternehmens unter Einstellungen > Abrechnung.
Symptom: Sie haben Ihr Client-Secret verloren.
Ursache: Das Client-Secret wird nur einmal, bei der Erstellung, angezeigt und kann danach nicht erneut abgerufen werden.
Lösung: Generieren Sie neue API-Zugangsdaten, indem Sie die Schritte unter API-Zugriff einrichten wiederholen. Widerrufen Sie die alten, nicht mehr genutzten Zugangsdaten.
Symptom: Sie können keinen neuen API-Schlüssel erstellen.
Ursache: Sie sind nicht der Kontoinhaber (Account Owner) Ihrer Spendesk-Entität.
Lösung: Bitten Sie Ihren aktuellen Kontoinhaber (Account Owner), die Zugangsdaten zu erstellen oder die Rolle des Kontoinhabers auf Sie zu übertragen.
📋 Speichern Sie API-Zugangsdaten in einem sicheren Passwort-Tresor und teilen Sie sie niemals über Messaging-Dienste oder E-Mail. Überprüfen Sie gespeicherte Zugangsdaten regelmäßig und widerrufen Sie alle nicht mehr genutzten.