Aller au contenu principal

LoginService

Version : 2.1 · Décembre 2025

Le LoginService authentifie un utilisateur et renvoie un authToken requis par tous les autres services Shivah WS.


Méthodes​

MéthodeDescription
getAuthCrée un jeton d'authentification pour l'utilisateur indiqué si les identifiants sont valides

getAuth​

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

Entrée :

NomÉlément
parameterstypes:getAuth

Sortie :

NomÉlément
parameterstypes:getAuthResponse

Erreurs :

NomÉlément
parameterstypes_authentication:authenticationFault

Exemples​

getAuth — SOAP​

POST {baseUrl}/services/LoginService

Corps de la requête :

<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>

Réponse (succès) :

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soap:Body>
<getAuthResponse xmlns="http://dpd.com/common/service/types/LoginService/2.1">
<return>
<delisId>{your delisId}</delisId>
<customerUid>{your customerUid}</customerUid>
<authToken>{your authToken}</authToken>
<depot>{your sendingDepot}</depot>
<authTokenExpires>2026-10-01T09:59:28.0000000Z</authTokenExpires>
</return>
</getAuthResponse>
</soap:Body>
</soap:Envelope>

Réponse (erreur) :

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Authentication failed</faultstring>
<detail>
<ns:authenticationFault xmlns:ns="http://dpd.com/common/service/types/Authentication/2.0">
<errorCode>UNAUTHORIZED</errorCode>
<errorMessage>AUTH-INVALID-CREDENTIALS: Unauthorized, invalid credentials...</errorMessage>
</ns:authenticationFault>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>

getAuth — REST​

POST {baseUrl}/services/LoginService/getAuth

Corps de la requête :

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

Réponse (succès) :

{
"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"
}
}

Réponse (erreur) :

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

Types complexes​

Espace de noms : types​

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

Login​

Contient les informations de connexion renvoyées après une authentification réussie.

ChampType / OccurrenceDescription
delisIdxsd:string / 1..1Le DELIS-Id de l'utilisateur
customerUidxsd:string / 1..1L'UID client de l'utilisateur (généralement identique au DELIS-Id pour les comptes non secondaires)
authTokenxsd:string / 1..1JWT (HS256) nécessaire aux autres appels de services web. Longueur variable — prévoyez au moins 2048 caractères
depotxsd:string / 1..1Le dépôt auquel l'utilisateur est rattaché
authTokenExpiresxsd:dateTime / 1..1Date et heure UTC d'expiration du jeton

getAuth​

ChampType / OccurrenceDescription
delisIdxsd:string / 1..1Le DELIS-Id de l'utilisateur
passwordxsd:string / 1..1Le mot de passe de l'utilisateur
messageLanguagexsd:string / 1..1 · length: 5Langue des messages : de_CH, fr_CH, it_CH, en_CH

getAuthResponse​

ChampType / OccurrenceDescription
returntypes:Login / 1..1L'objet de résultat de connexion

Espace de noms : types_authentication​

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

authenticationFault​

ChampType / OccurrenceDescription
errorCodexsd:string / 1..1Le code d'erreur
errorMessagexsd:string / 1..1 · maxLength: 255Le texte du message d'erreur

Éléments​

Espace de noms : types​

ÉlémentTypeDescription
getAuthtypes:getAuth / 1..1Paramètre d'entrée de getAuth
getAuthResponsetypes:getAuthResponse / 1..1Paramètre de sortie de getAuth

Espace de noms : types_authentication​

ÉlémentTypeDescription
authenticationFaultType complexe anonymeÉlément d'erreur d'authentification

Points d'accès​

EnvironnementProtocoleURL
StageSOAPhttps://shivah-st.dpd.ch/external/soap/services/LoginService
LiveSOAPhttps://shivah.dpd.ch/external/soap/services/LoginService
StageRESThttps://shivah-st.dpd.ch/external/rest/services/LoginService/getAuth
LiveRESThttps://shivah.dpd.ch/external/rest/services/LoginService/getAuth