LoginService

Version: 2.1 · Dezember 2025

Der LoginService authentifiziert einen Benutzer und gibt einen authToken zurück, der von allen anderen Shivah-WS-Services benötigt wird.

---

Methoden

Methode	Beschreibung
getAuth	Erstellt ein Authentifizierungs-Token für den angegebenen Benutzer, sofern die Anmeldedaten gültig sind

getAuth

Action: http://dpd.com/common/service/LoginService/2.1/getAuth

Eingabe:

Name	Element
parameters	types:getAuth

Ausgabe:

Name	Element
parameters	types:getAuthResponse

Faults:

Name	Element
parameters	types_authentication:authenticationFault

---

Beispiele

getAuth — SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:ns="http://dpd.com/common/service/types/LoginService/2.1">
  <soapenv:Header/>
  <soapenv:Body>
    <ns:getAuth>
      <delisId>{your delisId}</delisId>
      <password>{your password}</password>
      <messageLanguage>de_CH</messageLanguage>
    </ns:getAuth>
  </soapenv:Body>
</soapenv:Envelope>

getAuth — REST

POST {baseUrl}/services/LoginService/getAuth

Anfragetext:

{
  "delisID": "{your delisId}",
  "password": "{your password}",
  "messageLanguage": "de_CH"
}

Antwort (Erfolg):

{
  "getAuthResponse": {
    "return": {
      "delisId": "{your delisId}",
      "customerUid": "{your customerUid}",
      "authToken": "{your authToken}",
      "depot": "{your sendingDepot}",
      "authTokenExpires": "2021-07-16T05:39:03.9133333Z"
    }
  },
  "status": {
    "type": "OK",
    "code": "200",
    "message": "valid"
  }
}

Antwort (Fehler):

{
  "getAuthResponse": null,
  "status": {
    "type": "AuthenticationFault",
    "code": "DELICOM_ERR_AUTHENTICATION",
    "message": "Authentication failure, check delisId and password."
  }
}

---

Komplexe Typen

Namespace: types

URL: http://dpd.com/common/service/types/LoginService/2.1

Login

Enthält die nach erfolgreicher Authentifizierung zurückgegebenen Anmeldeinformationen.

Feld	Typ / Vorkommen	Beschreibung
delisId	xsd:string / 1..1	Die DELIS-Id des Benutzers
customerUid	xsd:string / 1..1	Die Kunden-UID des Benutzers (in der Regel identisch mit der DELIS-Id, ausser bei Unterkonten)
authToken	xsd:string / 1..1	JWT (HS256), das für andere Webservice-Aufrufe benötigt wird. Variable Länge — reservieren Sie mindestens 2048 Zeichen
depot	xsd:string / 1..1	Das Depot, dem der Benutzer zugeordnet ist
authTokenExpires	xsd:dateTime / 1..1	UTC-Datum und -Uhrzeit, zu dem das Token abläuft

getAuth

Feld	Typ / Vorkommen	Beschreibung
delisId	xsd:string / 1..1	Die DELIS-Id des Benutzers
password	xsd:string / 1..1	Das Passwort des Benutzers
messageLanguage	xsd:string / 1..1 · Länge: 5	Sprache für Meldungen: de_CH, fr_CH, it_CH, en_CH

getAuthResponse

Feld	Typ / Vorkommen	Beschreibung
return	types:Login / 1..1	Das Ergebnisobjekt der Anmeldung

Namespace: types_authentication

URL: http://dpd.com/common/service/types/Authentication/2.1

authenticationFault

Feld	Typ / Vorkommen	Beschreibung
errorCode	xsd:string / 1..1	Der Fehlercode
errorMessage	xsd:string / 1..1 · maxLength: 255	Der Fehlermeldungstext

---

Elemente

Namespace: types

Element	Typ	Beschreibung
getAuth	types:getAuth / 1..1	Eingabeparameter von getAuth
getAuthResponse	types:getAuthResponse / 1..1	Ausgabeparameter von getAuth

Namespace: types_authentication

Element	Typ	Beschreibung
authenticationFault	Anonymer komplexer Typ	Element für Authentifizierungsfehler

---

Einstiegspunkte

Umgebung	Protokoll	URL
Stage	SOAP	https://shivah-st.dpd.ch/external/soap/services/LoginService
Live	SOAP	https://shivah.dpd.ch/external/soap/services/LoginService
Stage	REST	https://shivah-st.dpd.ch/external/rest/services/LoginService/getAuth
Live	REST	https://shivah.dpd.ch/external/rest/services/LoginService/getAuth