SOAP API: autentizace a App Keys

Vytvoření App Keys, získání SecurityToken a odesílání autentizovaných SOAP requestů na legacy eConnect API.

Před použitím legacy SOAP API potřebujete App Keys a musíte získat SecurityToken přes endpoint Login. Tento článek krok za krokem vysvětluje, jak to funguje.

Důležité: Toto je legacy SOAP API. Pro nové integrace doporučujeme REST API, které používá OAuth 2.0.

Vytvoření App Keys

App Keys sestávají z Consumer Key a Consumer Secret. Vytvoříte je na platformě eConnect v menu Verbindingen. K tomu potřebujete roli administrátora.

K dispozici jsou dva typy aplikací:

TypViditelnostVysvětleníGeneric AppVeřejnáNázev je předem vyplněn společností eConnect. Vhodné pro standardní integrace.Own AppSoukromáSami si zvolíte název a volitelně logo. Vhodné pro zakázkové propojení.

Pro variantu pro účetní se používají App Integration Requests: klient přes platformu udělí povolení k přístupu ke své administrativě. To je relevantní, pokud jako dodavatel softwaru pracujete jménem více klientů.

Průběh autentizace

Autentizace probíhá ve dvou krocích:

Krok 1: Login

Zavolejte endpoint Login s Vaším Consumer Key a Consumer Secret. Dostanete zpět SecurityToken.

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

Krok 2: Odeslání SecurityToken

SecurityToken odešlete v SOAP hlavičce při všech následujících voláních. Token je platný 4 hodiny. Můžete také vyžádat nový token pro každou relaci.

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

Krok 3: Získání informací o účtu

Po úspěšném přihlášení zavolejte GetAccountParties pro získání Vašeho EConnectPartyId (XCNL čísla). Toto ID potřebujete při odesílání a přijímání dokumentů.

Endpoint a WSDL
VlastnostHodnotaEndpointhttps://api.everbinding.nl/soap/v3.1?subscriptionKey={subscriptionKey}WSDLDostupné přes sales@econnect.euProtokolSOAP 1.1 přes HTTPS/SSL

WSDL obsahuje kompletní specifikaci všech dostupných endpointů, datových typů a chybových kódů. WSDL můžete importovat do nástrojů jako SoapUI nebo Visual Studio pro automatické generování klientského kódu.

Časté chyby

Transfer-Encoding=chunked: SOAP API nepodporuje chunked transfer encoding. Ujistěte se, že Váš HTTP klient odesílá hlavičku content-length místo použití chunked encoding. Jde o jednu z nejčastějších implementačních chyb.

Vypršený token: pokud je Váš SecurityToken starší než 4 hodiny, dostanete chybu autentizace (série chybových kódů 600). Vyžádejte nový token přes Login.

Chybějící subscriptionKey: bez platného subscriptionKey v URL endpointu jsou všechny requesty zamítnuty. Zkontrolujte, zda je klíč správný a stále aktivní.

Zpracování chyb

SOAP API vrací strukturované chybové kódy ve formátu ERR + operační kód + série + ID. Série chybových kódů označují typ chyby:

SérieTyp100Upozornění200Funkční300Oprávnění400Validace600Autentizace800Komunikace900Neznámá

Zvažujete přechod na OAuth2 a REST API? Podívejte se na PSB dokumentaci na psb.econnect.eu pro moderní autentizační tok.

Přechod na REST API

Související