UTD Server

UTD Server is a service that can be installed on Windows computer.

It allows to access all methods of all UTD drivers via HTTP rest API.

A single UTD Server instance can provide services to multiple clients

Installing UTD Server

To install UTD Server on a computer:

Create a Directory and copy the UTD Server exe file and all the UTD DLLs needed.
Open a command prompt session with Administration Rights, make the Directory created your current directory and type the following command

TkUTDServer /install

Go to Windows Services and start UTD Server Service

Accessing UTD Server

The UTD Server Endpoint is accessible via http or https on the default port 5466.

The port can be changed from the UTD Server Control Panel Web Interface

The default password is utdserver and can be changed from the UTD Server Control Panel Web Interface

Setup UTD Server

UTD Server just works out-of-the-box.

The setup parameters are only these:

Parameter	Values	Default
Listening Port	1-65534	5466
Protocol	http https	http
Password	<any>	utdserver

You must restart UTD Server Service if you change Listening Port or Protocol

HTTPS Protocol

If you enable HTTPS protocol, UTD Server uses its internal self-signed certificates

If you want to use your own certificates (whether self-signed or not):

Create a folder in the UTD Server directory named Certificates
Copy in the folder the Certificate and the Private Key in PEM format with the following names:
- Certificate: UTDCert.pem
- Private Key: UTDKey.pem

UTD Server APIs

You can access the API at the following end point

<protocol>://<server>:<port>/service/receiptmanager

Example:

https://myserver:5466/service/receiptmanager

Each request must specify the following http headers:

Name	Value
X-UTDServer-Device	<deviceID>
Content-Type	application/xml

The format of the request is an XML document identical to the document directly posted to the UTD DLLs but encapsulated in the UTDServerRequest XML root node.
You are not limited to a single request per post but you can send multiple UTD XML document in a single request.

Request example:

XML

<?xml version="1.0" encoding="utf-8"?>
<UTDServerRequest>
    <ReceiptPrinterManager Version="1.0">
        <Driver>TKPA_ADYEN_10</Driver>
        <LogId>00725_01-2-002</LogId>
        <Method>PAY</Method>
        <Connection>
            <Type>HTTP</Type>
            <URL>https://172.28.2.22:8443</URL>
            <AuthType>None</AuthType>
        </Connection>
        <Parameters>
        </Parameters>
        <Payment>
            <PrintLocation>ECR</PrintLocation>
            <Copies>2</Copies>
            <Reference>TQ64SLZJBa</Reference>
            <StoreCode>01</StoreCode>
            <TillCode>002</TillCode>
            <Amount>0.01</Amount>
            <Currency>EUR</Currency>
            <TokenizeCard>True</TokenizeCard>
            <TokenReference>abcdefghijklmnopqrstuvwxyz</TokenReference>
        </Payment>
    </ReceiptPrinterManager>
</UTDServerRequest>

Similarly, the response document will have a UTDServerResponse root node in the XML returned.
In case of multiple UTD Documents sent in a single request it will return multiple response documents.

Response example:

XML

<?xml version="1.0" encoding="utf-8"?>
<UTDServerResponse>
    <PAY>
        <DeviceId>xxxxxxxx</DeviceId>
        <PaymentDateTime>2022-09-07T02:02:59</PaymentDateTime>
        <PaymentNumber>ZRLDG2NJD8NKGK82</PaymentNumber>
        <PaymentAmount>0.01</PaymentAmount>
        <PaymentCurrency>EUR</PaymentCurrency>
        <ExchangeRate>0</ExchangeRate>
        <PaymentAmountCurrency>0</PaymentAmountCurrency>
        <PaymentCurrencyCurrency></PaymentCurrencyCurrency>
        <TippedAmount>0</TippedAmount>
        <RemainingBalance>0</RemainingBalance>
        <MaskedPAN>541333 **** 9999</MaskedPAN>
        <SerialNumber></SerialNumber>
        <PaymentNetwork>mastercard</PaymentNetwork>
        <TransactionType>CLESS</TransactionType>
        <AuthCode>123456</AuthCode>
        <TraceAuditId>abcdefghijklmnopqrstuvwxyz</TraceAuditId>
        <NumberOfItems>0</NumberOfItems>
        <SingleItemAmount>0</SingleItemAmount>
        <SignatureRequested>False</SignatureRequested>
        <CustomerCountryCode>GB</CustomerCountryCode>
        <CardToken>abcdefghijklmnopqrstuvwxyz</CardToken>
        <RefundReference>abcdefghijklmnopqrstuvwxyz</RefundReference>
        <ReceiptText/>
        <CashierReceiptText/>
        <Error>False</Error>
        <ErrorText></ErrorText>
        <LogFileName>C:\UTDServer_Service\LogFiles\Payment\TKPA_ADYEN_10_00725_01-2-002_20220907.log</LogFileName>
    </PAY>
</UTDServerResponse>

Version History

Version	Release Date	Notes	Download
1.15	17/05/2023	Aggiunto parametro CumulativeLogicOnBenefit alla chiamata OPEN	TkUTDServer.zip
1.14	11/11/2022	Aggiunta possibilità di caricare DLL custom	TkUTDServer_0114.zip
1.13	14/04/2022	Aggiunto Access-Control-Request-Headers per supporto CORS Aggiunto Access-Control-Request-Method per supporto CORS
1.12	25/10/2022	Aggiunto supporto CORS in OPTIONS method
1.11	25/10/2022	Aggiunto supporto https Aggiunto supporto CORS
1.10	01/10/2022	Aggiunto servizio LOADEDDATA
1.09	09/05/2022	Aggiunto servizio LOADEDDATA
1.08	26/04/2022	Aggiunti parametri LoadOldCampaigns, NrPastDaysLoaded, NrRetry alla chiamata OPEN
1.07	20/08/2021	Aggiunta scrittura Log pacchetti se riscontrato errore Corretta anomalia mancata visualizzazione file e direttorio log in caso di data/ora di creazione identiche
1.06	20/08/2021	Aggiunte Processing Instructions nel messaggio di response
1.05	08/06/2021	Integrazione Motore Promozionale
1.04	27/05/2021	Aggiunto Supporto Connection Type COM e SPOOL Impostato Direttorio Corrente al direttorio in cui si trova il servizio Migliorato scaricamento DLL
1.03	16/02/2021	Aggiunto Identificatore di Versione su pagina login
1.02	10/02/2021	Gestione Autenticazione HTTP e Connection Type DLL
1.01	09/02/2021	Corretto errore nel forwarding dei parametri ai driver
1.00	05/01/2021	Aggiunto Versionamento su Resource File