Data Quality user documentation
home/Address validation/Batch API/API reference (REST)/HTTPS in REST

HTTPS in REST

All settings described in this section are found in the application.properties file placed inside the config directory, which can be found in the installation directory after the installation is complete.

  • If you intend to use the server with HTTP only, then leave the file application.properties as it is and do not make any modifications to it.
  • If you intend to use the server with HTTPS, then you should uncomment all the properties in the file application.properties and assign appropriate values to them.

During the installation, the HTTP port number is added to the registry. You must remove it from the registry before being able to use the server via HTTPS.

  1. Open the Registry Editor.

  2. Find the path of the Batch REST API server. The default path is: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Experian Batch REST Server\Parameters

  3. Double click the AppParameters key and remove --server.port=xxxx from the value. The resulting value should look like this:

    jar "swagger-spring-boot.jar" --server.threads=8 --server.batch.enabled=true --server.pro.enabled=false

Configuration settings

We provide you with an example HTTPS configuration for the Batch REST API server which you can use as a reference. The table below as well as further detail in the application.properties file describe all the necessary settings in more detail.

server.ssl.enabled=true
server.port=8181
server.http.port=8282
# Windows
server.ssl.key-store=file:///c:/temp/keystore.p12
# Unix
#server.ssl.key-store=file:///etc/keystore.p12
server.ssl.key-store-password=<your password>
server.ssl.keyStoreType=PKCS12
server.ssl.keyAlias=tomcat
NameDescription
server.ssl.enabledControls the kind of requests that the REST server accepts.
  • true - the server will accept only HTTPS requests
  • false - the server will accept only HTTP requests.
The default value of this setting is true.
server.port
server.http.port

Batch REST API server always receives incoming requests on server.port. This will be over HTTP or HTTPS depending on the setting of server.ssl.enabled.

If HTTPS is enabled, but the user makes an HTTP request, the request is automatically redirected to HTTPS. Since HTTP and HTTPS cannot use the same port, a HTTP port should be specified with the server.http.port setting as well.

The configuration example above means that the server will listen for HTTPS requests on port 8181 and HTTP requests on port 8282. Once such a HTTP request is received, it will be forwarded to HTTPS on 8181.

This setting has no default value and should be set explicitly by you.
server.ssl.key-store

Used for setting the path to the keystore file containing the certificate. The path should be a URI and the way it is specified is platform-specific.

Possible ways of pointing to the same /etc/keystore.p12 file in UNIX
  • file://localhost/etc/keystore.p12
  • file:///etc/keystore.p12
  • file:/etc/keystore.p12 (KDE environment specific)
Possible ways of pointing to the same C:\temp\keystore.p12 local file in Windows
  • file://localhost/c:/temp/keystore.p12
  • file:///c:/temp/keystore.p12 (URI as understood by the Windows Shell API)
This setting has no default value and should be set explicitly by you.
server.ssl.key-store-passwordProvides the password for the keystore which should be provided in plain-text format.

This setting has no default value and should be set explicitly by you.
server.ssl.keyStoreTypeUsed for specifying the keystore type. Currently, only PKCS12 keystores are supported.

The default value of this setting is PKCS12.
server.ssl.keyAliasUsed for specifying the alias that identifies the key in the keystore.

This setting has no default value and should be set explicitly by you.
Batch API

API reference (REST)