Zum Hauptinhalt gehen
Top

Erstellen Sie eine Business-API-Anwendung und generieren Sie Ihre Zugangsdaten

Um die Soldo Business API in Ihrem Produktionskonto zu nutzen, müssen Sie eine Anwendung in der Soldo Web-App erstellen. Dieser Vorgang generiert die Zugangsdaten, mit denen Ihr System sich sicher bei der API authentifiziert.

Wichtig: Diese Einrichtung gewährt Zugriff auf echte Daten. Wenn Sie testen oder eine Integration entwickeln, empfehlen wir, zunächst im Sandbox-Modus zu starten.

Anwendung erstellen

  1. Melden Sie sich in der Soldo Web-App an.
  2. Gehen Sie über das Hauptnavigationsmenü zu Integrationen > Business API.
  3. Wählen Sie Anwendung erstellen.
    WC_BusinessAPI_MainNoApplication_CreateAnnotated_202512_Surface_EN.png
  4. Geben Sie einen Namen für Ihre Anwendung ein.
Tipp: Dieser sollte die Integration oder das Tool widerspiegeln, mit dem sie verknüpft ist.
  1. Geben Sie einen öffentlichen Schlüssel ein. Sie müssen ein gültiges RSA-2048-Bit-Schlüsselpaar im PEM-Format generieren.

Was ist ein Schlüsselpaar?

  • Öffentlicher Schlüssel: Wird mit Soldo geteilt. Denken Sie daran wie an einen Benutzernamen – er identifiziert Ihre Anwendung.
  • Privater Schlüssel: Wird geheim gehalten. Er wird verwendet, um Ihre API-Anfragen sicher zu signieren.

Anweisungen zum Erstellen eines Schlüsselpaares mit openssl finden Sie während des Einrichtungsprozesses.

  1. Wählen Sie Weiter.

WC_BusinessAPI_CreateAnnotated_202512_Surface_EN.png

  1. Wählen Sie die Scopes aus, die Ihre Anwendung benötigt, und klicken Sie dann auf Weiter. Sie können diese später bei Bedarf bearbeiten.
Tipp: Scopes definieren, auf welche Bereiche Ihres Soldo-Kontos die Anwendung zugreifen kann. Sie können für jeden Bereich Lese- oder Vollzugriff gewähren.

WC_BusinessAPI_ScopesSelectAnnotated_202512_Surface_EN.png

  1. Überprüfen Sie Ihre Einstellungen und bestätigen Sie die Geschäftsbedingungen.
    WC_BusinessAPI_TermsAnnotated_202512_Surface_EN.png
  2. Wählen Sie Anwendung erstellen

WC_BusinessAPI_TermsAgreeAnnotated_202512_Surface_EN.png

Nach der Erstellung werden Ihre Zugangsdaten in einem Popup angezeigt:

  • Client-ID – identifiziert Ihre Anwendung
  • Client-Secret – wird für die Standardauthentifizierung verwendet
  • Fingerprint-Token – wird für die erweiterte Authentifizierung oder das Herunterladen von Anhängen verwendet
Wichtig: Diese Zugangsdaten werden nur einmal angezeigt. Stellen Sie sicher, dass Sie sie kopieren und sicher speichern, bevor Sie das Popup schließen.

WC_BusinessAPI_CredentialsAnnotated_202512_Surface_EN.png

Was passiert, wenn ich meine API-Zugangsdaten verliere?

Sie können diese jederzeit neu generieren. Gehen Sie zu Integrationen > Business API, wählen Sie die Anwendung aus und klicken Sie auf Zugangsdaten neu generieren. Dadurch werden ein neues Client-Secret und ein neuer Fingerprint-Token generiert. Ihre Client-ID bleibt gleich.

Nächste Schritte

Nachdem Sie Ihre Anwendung in der Web-App erstellt und Ihre Zugangsdaten generiert haben, sind Sie bereit, mit der Soldo Business API zu starten. 

Die vollständige API-Dokumentation finden Sie in unserem Business API Developer Portal.

Verfügbarkeit

Wer: Super-Admins
Preismodell(e): Unlimited
0 Die Leute haben abgestimmt. Sum of votes: 0