Verbinden Sie Spendesk mit Ihren anderen Business-Tools oder erstellen Sie eine Partner-Integration mithilfe der Spendesk-API. Dieser Artikel behandelt die Entwicklerressourcen, wer API-Zugangsdaten erstellen kann, und wie.
Für: Kontoinhaber und Admins von Unternehmen im Premium-Plan (Kunden) sowie Technologiepartner, die Integrationen mit Spendesk entwickeln.
Inhaltsverzeichnis
Bevor Sie beginnen
Das Entwicklerportal entdecken
API-Zugangsdaten erstellen
API-Zugriff einrichten
Fehlerbehebung
Bevor Sie beginnen
👥 Kontoinhaber und Admins können API-Zugangsdaten in Spendesk erstellen und verwalten.
🔒 Die API-Verwaltung ist im Premium-Plan enthalten.
Das Entwicklerportal entdecken
Beginnen Sie mit dem Entwicklerportal 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
Im Premium-Plan erstellt ein Kontoinhaber oder Admin die API-Zugangsdaten unter Einstellungen > Integrationen > API-Zugriffsverwaltung. Eine vorherige Anfrage bei Spendesk ist nicht nötig.
Mit API-Zugangsdaten können Entwickler sich mit Ihrer Spendesk-Entität verbinden und Informationen abrufen oder bearbeiten, basierend auf den Berechtigungen (Scopes), die Sie erteilen.
Hinweis: Einige API-Funktionen sind experimentell, ihre Scopes sind auf Anfrage verfügbar, zum Beispiel Rechnungen, die Suche nach Verbindlichkeiten, Buchhaltungsexporte, Bestellungen, Karten und Transaktionen sowie Webhooks. Wenden Sie sich dafür an Ihren Customer Success Manager oder schreiben Sie an support-public-api@spendesk.com und nennen Sie die benötigten Scopes. Siehe Getting access im Entwicklerportal.
Sie arbeiten mit einem externen Integrator? Für eine Integration Ihres eigenen Unternehmens, etwa ein BI-Tool oder ein Data Warehouse, erstellen Sie die Zugangsdaten selbst und geben sie sicher an Ihren Integrator weiter. Wenn Sie ein Technologiepartner sind, der eine Integration für mehrere Spendesk-Kunden entwickelt, wenden Sie sich stattdessen an das Partnerschaftsteam von Spendesk: Jeder Kunde genehmigt dann Ihre App, ohne dass Zugangsdaten geteilt werden.
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-Zugriffsverwaltung
Klicken Sie auf Neuen Schlüssel erstellen
Geben Sie einen Namen für diesen API-Zugriff ein
Geben Sie eine Beschreibung ein, die den Zweck nennt, 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) und geben Sie sie über einen Passwort-Manager oder einen sicheren Link weiter. 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 API-Zugriffsverwaltung unter Einstellungen > Integrationen nicht.
Ursache: Ihr Unternehmen ist nicht im Premium-Plan, oder Sie sind weder Kontoinhaber noch Admin.
Lösung: Prüfen Sie den Plan Ihres Unternehmens unter Einstellungen > Abrechnung. Wenn es nicht der Premium-Plan ist, wenden Sie sich an Ihren Account Manager. Wenn Sie weder Kontoinhaber noch Admin sind, bitten Sie eine dieser Personen, die Zugangsdaten zu erstellen.
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 weder Kontoinhaber noch Admin Ihrer Spendesk-Entität.
Lösung: Bitten Sie einen Kontoinhaber oder Admin, die Zugangsdaten zu erstellen oder Ihnen die Admin-Rolle zuzuweisen.
Symptom: Ein benötigter Scope fehlt in der Liste, oder Aufrufe eines Endpunkts werden abgelehnt.
Ursache: Der Endpunkt ist experimentell und sein Scope wurde Ihrem Unternehmen noch nicht freigegeben.
Lösung: Wenden Sie sich an Ihren Customer Success Manager oder schreiben Sie an support-public-api@spendesk.com mit den benötigten Scopes. Erstellen Sie nach der Freigabe neue Zugangsdaten mit diesen Scopes.
📋 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.