Zum Hauptinhalt springen

Erstellen Sie eine native Integration mit der Spendesk-API

Verbinden Sie Spendesk mit Ihren anderen Business-Tools oder erstellen Sie mithilfe der Spendesk API eine Partner-Integration. Dieser Artikel behandelt Entwicklerressourcen, die Einrichtung von Zugangsdaten und die erforderlichen Voraussetzungen.

Für: Kontoinhaber (Account Owner) von Kundenunternehmen mit dem Premium-Plan sowie Technologiepartner, die Integrationen mit Spendesk entwickeln.

Bevor Sie beginnen

Voraussetzung

Details

Rolle

Nur der Kontoinhaber (Account Owner) kann API-Zugangsdaten erstellen.

Plan

Nur im Premium-Plan verfügbar.

Einrichtung

Sie müssen von Spendesk für den API-Zugriff autorisiert worden sein, bevor Sie Zugangsdaten erstellen können.

👥 Nur Kontoinhaber 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 zu beantragen. Nach der Freigabe verwalten Sie Ihre API-Zugangsdaten unter Einstellungen > Integrationen > API-Zugriff verwalten.

Mit API-Zugangsdaten können Entwickler eine Verbindung zu Ihrer Spendesk-Entität herstellen und Informationen abrufen oder bearbeiten, abhängig von 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:

  1. Navigieren Sie zu Einstellungen > Integrationen > API-Zugriff verwalten.

  2. Klicken Sie auf Neuen Schlüssel erstellen.

  3. Geben Sie einen Namen für diesen API-Zugriff ein.

  4. Geben Sie eine Beschreibung für diesen API-Zugriff ein und nennen Sie seinen Zweck, damit er später leicht identifiziert werden kann.

  5. Wählen Sie ein Ablaufdatum aus, das bis zu einem Jahr ab heute liegen kann.

  6. Wählen Sie die Berechtigungen (Scopes) aus, die Sie diesem Satz von Zugangsdaten erteilen möchten.

  7. Aktivieren Sie das Kontrollkästchen, um zu bestätigen, dass diese Zugangsdaten auf die ausgewählten Funktionen und Daten zugreifen werden.

  8. 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.

⚠️ Sie sehen das Client Secret nur einmal im Klartext. Danach kann es nicht mehr 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ürzeste praktikable Gültigkeitsdauer, 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 Zugangsdaten erstellen.

Fehlerbehebung

Symptom: Sie sehen die Option „API-Zugriff verwalten“ unter Einstellungen > Integrationen nicht.

Ursache: Ihr Unternehmen nutzt nicht den 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 zu beantragen. 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 Zugangsdaten, die Sie nicht mehr verwenden.

Symptom: Sie können keinen neuen API-Schlüssel erstellen.

Ursache: Sie sind nicht der Kontoinhaber Ihrer Spendesk-Entität.

Lösung: Bitten Sie den aktuellen Kontoinhaber, 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 per E-Mail. Überprüfen Sie gespeicherte Zugangsdaten regelmäßig und widerrufen Sie alle Zugangsdaten, die Sie nicht mehr verwenden.

Verwandte Artikel

Hat dies deine Frage beantwortet?