SOAP API: autentifikácia a App Keys

Vytvorenie App Keys, získanie SecurityToken a odosielanie autentifikovaných SOAP requestov na legacy eConnect API.

Pred použitím legacy SOAP API potrebujete App Keys a musíte získať SecurityToken cez endpoint Login. Tento článok krok za krokom vysvetľuje, ako to funguje.

Dôležité: Toto je legacy SOAP API. Pre nové integrácie odporúčame REST API, ktorá používa OAuth 2.0.

Vytvorenie App Keys

App Keys pozostávajú z Consumer Key a Consumer Secret. Vytvoríte ich na platforme eConnect v menu Verbindingen. Na to potrebujete rolu administrátora.

K dispozícii sú dva typy aplikácií:

TypViditeľnosťVysvetlenieGeneric AppVerejnáNázov je vopred vyplnený spoločnosťou eConnect. Vhodné pre štandardné integrácie.Own AppSúkromnáSami si zvolíte názov a voliteľne logo. Vhodné pre zákazkové prepojenia.

Pre variant pre účtovníkov sa používajú App Integration Requests: klient cez platformu udelí povolenie na prístup k svojej administratíve. To je relevantné, ak ako dodávateľ softvéru pracujete v mene viacerých klientov.

Priebeh autentifikácie

Autentifikácia prebieha v dvoch krokoch:

Krok 1: Login

Zavolajte endpoint Login s Vaším Consumer Key a Consumer Secret. Dostanete späť SecurityToken.

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

Krok 2: Odoslanie SecurityToken

SecurityToken odošlite v SOAP hlavičke pri všetkých nasledujúcich volaniach. Token je platný 4 hodiny. Môžete tiež vyžiadať nový token na každú reláciu.

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

Krok 3: Získanie informácií o účte

Po úspešnom prihlásení zavolajte GetAccountParties na získanie Vášho EConnectPartyId (XCNL čísla). Toto ID potrebujete pri odosielaní a prijímaní dokumentov.

Endpoint a WSDL
VlastnosťHodnotaEndpointhttps://api.everbinding.nl/soap/v3.1?subscriptionKey={subscriptionKey}WSDLDostupné cez sales@econnect.euProtokolSOAP 1.1 cez HTTPS/SSL

WSDL obsahuje kompletnú špecifikáciu všetkých dostupných endpointov, dátových typov a chybových kódov. WSDL môžete importovať do nástrojov ako SoapUI alebo Visual Studio na automatické generovanie klientského kódu.

Časté chyby

Transfer-Encoding=chunked: SOAP API nepodporuje chunked transfer encoding. Uistite sa, že Váš HTTP klient odosiela hlavičku content-length namiesto použitia chunked encoding. Ide o jednu z najčastejších implementačných chýb.

Vypršaný token: ak je Váš SecurityToken starší ako 4 hodiny, dostanete chybu autentifikácie (séria chybových kódov 600). Vyžiadajte nový token cez Login.

Chýbajúci subscriptionKey: bez platného subscriptionKey v URL endpointu sú všetky requesty zamietnuté. Skontrolujte, či je kľúč správny a stále aktívny.

Spracovanie chýb

SOAP API vracia štruktúrované chybové kódy vo formáte ERR + operačný kód + séria + ID. Série chybových kódov označujú typ chyby:

SériaTyp100Upozornenie200Funkčná300Oprávnenia400Validácia600Autentifikácia800Komunikácia900Neznáma

Zvažujete prechod na OAuth2 a REST API? Pozrite si PSB dokumentáciu na psb.econnect.eu pre moderný autentifikačný tok.

Prechod na REST API

Súvisiace