Login Service

The Login Service is called to obtain a token necessary for authentication in the other services of DPD Shipper Webservices.

  1. Introduction

    The login service is used to authenticate the user and retrieve a token. The token is used to grant access to the other services of DPD Shipper Webservices. The token is valid for exactly 24 hours after authentication. This means that one call to the login service per 24 hours is sufficient to give access the all other services of DPD Shipper Webservices. You can cache the token and re-use it for any call within the 24 hour limit. The value in “authTokenExpires” will tell you when to request a new one. Times are indicated in UTC. It’s not allowed to refresh your token for each request.

  2. REST URL

    A token generated on the Stage environment won’t work on the Live environment and vice versa.

  3. Request

    {
    "delisId": "*****",
    "password": "*****",
    "messageLanguage": "nl_NL"
}

  4. Response

    Code 200 – Successful

    {
    "getAuthResponse": {
        "return": {
            "delisId": "*****",
            "customerUid": "*****",
            "authToken": "oE40WsT2AG*****u17fusc0M8",
            "depot": "0522",
            "authTokenExpires": "2025-05-28T08:37:02.635086Z"
        }
    },
    "status": {
        "type": "OK",
        "code": "200",
        "message": "valid"
    }
}

    Code 400 – Bad Request

    {
    "errors": {
        "messageLanguage": [
            "The field MessageLanguage must be a string or array type with a minimum length of '5'."
        ]
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-0b341c5fcba7191aaaa9c6658eb168ce-e4caa9335af1ebe7-00"
}

    Code 500 – Error

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

  5. Parameters

    Request

    Field Data Type Mandatory Range Description
    delisId xs:string Yes The delis user id for authentication.
    password xs:string Yes The password for authentication.
    messageLanguage xs:string Yes length:5 The language for messages.
    “nl_NL” for Dutch messages.
    “en_US” for English messages.



    Response

    Field Data Type Description
    delisId xs:string The delis user id for authentication.
    customerUid xs:string The user’s customer uid. Usually this is equal to delisID.
    authToken xs:string The token for authentication. Needed for other DPD Shipper Webservices requests. Valid for 24 hours.
    depot xs:string Depot code to which the configuration is assigned.
    authTokenExpires xs:dateTime UTC format, the time until the token will be valid.
Was this post helpful?(Required)