SOAP API: Authentifizierung und App Keys

App Keys erstellen, ein SecurityToken abrufen und authentifizierte SOAP-Anfragen an die Legacy eConnect API senden.

Bevor Sie die Legacy SOAP API verwenden können, benötigen Sie App Keys und müssen ein SecurityToken über den Login-Endpoint abrufen. Dieser Artikel erklärt Schritt für Schritt, wie das funktioniert.

Wichtig: Dies ist die Legacy SOAP API. Für neue Integrationen empfehlen wir die REST API, die OAuth 2.0 verwendet.

App Keys erstellen

App Keys bestehen aus einem Consumer Key und einem Consumer Secret. Sie erstellen diese in der eConnect-Plattform unter dem Menü Verbindungen. Dafür benötigen Sie eine Administratorrolle.

Es stehen zwei App-Typen zur Verfügung:

TypSichtbarkeitHinweisGeneric AppÖffentlichName ist von eConnect vorausgefüllt. Geeignet für Standardintegrationen.Own AppPrivatSie wählen selbst einen Namen und optional ein Logo. Geeignet für Maßwerkkopplungen.

Für die Steuerberater-Variante verwenden Sie App Integration Requests: Der Kunde erteilt über die Plattform die Berechtigung für den Zugriff auf seine Buchhaltung. Dies ist relevant, wenn Sie als Softwareanbieter im Namen mehrerer Kunden arbeiten.

Authentifizierungsablauf

Die Authentifizierung verläuft in zwei Schritten:

Schritt 1: Login

Rufen Sie den Login-Endpoint mit Ihrem Consumer Key und Consumer Secret auf. Sie erhalten ein SecurityToken zurück.

<Login>
  <ConsumerKey>jouw-consumer-key</ConsumerKey>
  <ConsumerSecret>jouw-consumer-secret</ConsumerSecret>
</Login>

Schritt 2: SecurityToken mitgeben

Geben Sie das SecurityToken im SOAP-Header bei allen Folgeaufrufen mit. Das Token ist 4 Stunden gültig. Sie können auch pro Sitzung ein neues Token anfordern.

<soap:Header>
  <SecurityToken>ontvangen-security-token</SecurityToken>
</soap:Header>

Schritt 3: Kontoinformationen abrufen

Nach einem erfolgreichen Login rufen Sie GetAccountParties auf, um Ihre EConnectPartyId (XCNL-Nummer) abzurufen. Diese ID benötigen Sie beim Versenden und Empfangen von Dokumenten.

Endpoint und WSDL
EigenschaftWertEndpointhttps://api.everbinding.nl/soap/v3.1?subscriptionKey={subscriptionKey}WSDLVerfügbar über sales@econnect.euProtokollSOAP 1.1 über HTTPS/SSL

Die WSDL enthält die vollständige Spezifikation aller verfügbaren Endpoints, Datentypen und Fehlercodes. Sie können die WSDL in Tools wie SoapUI oder Visual Studio importieren, um automatisch Client-Code zu generieren.

Häufige Fehler

Transfer-Encoding=chunked: Die SOAP API unterstützt kein Chunked Transfer Encoding. Stellen Sie sicher, dass Ihr HTTP-Client den Content-Length-Header sendet, anstatt Chunked Encoding zu verwenden. Dies ist einer der häufigsten Implementierungsfehler.

Token abgelaufen: Wenn Ihr SecurityToken älter als 4 Stunden ist, erhalten Sie einen Authentifizierungsfehler (Fehlercodeserie 600). Fordern Sie über Login ein neues Token an.

Kein subscriptionKey: Ohne gültigen subscriptionKey in der Endpoint-URL werden alle Anfragen abgelehnt. Überprüfen Sie, ob der Schlüssel korrekt und noch aktiv ist.

Fehlerbehandlung

Die SOAP API gibt strukturierte Fehlercodes im Format ERR + Opcode + Serie + ID zurück. Die Fehlercode-Serien geben den Fehlertyp an:

SerieTyp100Warnung200Funktional300Berechtigungen400Validierung600Authentifizierung800Kommunikation900Unbekannt

Erwägen Sie den Umstieg auf OAuth2 und die REST API? Sehen Sie sich die PSB-Dokumentation auf psb.econnect.eu an für den modernen Authentifizierungsablauf.

Auf die REST API umsteigen

Verwandt