download / api

Reference data

With a reference data subscription for the releases V2 or V3 you can download following artifacts:

  • The latest post reference data for each subscribed country

  • The latest autocompletion reference data for each subscribed country

  • The latest phone reference data

  • SHA512 checksums for all available reference data (post, autocompletion, phone)

  • file version.txt (relevant for post and autocompletion)

  • Reference data installer for all supported platforms

  • download script for automation purposes

Download in browser

In order to download your subscribed reference data you have to log on Uniserv CONNECT and go to the Download Service area. There you will find the latest version for all reference data you have subscribed as well as necessary version.txt file and the installer for all available platforms. After download, you can start the installation in the usual way.

Instead of manually downloading all reference data, you can use our python download script (phyton3 is required). The script determines the download links for all subscribed reference data and downloads them one by one. The script also always downloads the required file version.txt and the installer for reference data. After that you can start the installation of the reference data in the usual way. Either you start the installer of your platform in the console or you start the installation from Virtual Services.

Download via API

If you need some other kind of automation, you can also use our API. We also provide the download script for reference data and recommend to use it.

URL-based download

Direct download of reference data artifacts is possible via API. The desired data can be retrieved by generating URLs according to the provided format and substituting placeholders with the appropriate values. This approach provides a simple way to access reference data resources, as well as the ability to obtain checksums for potential automation tasks.

Please note that you have to provide your API Key in the Authorization Header as Bearer Token to download reference data. SHA512 checksums are available without authentication.

To download one particular reference data artifact for release V2 or release V3 use the following URL:

https://download.connect.uniserv.com/download/v1/data/<product>/<country>/<release>/<version>/<artifact>

To download a SHA512 checksum for the artifact use the following URL:

https://download.connect.uniserv.com/download/v1/data/<product>/<country>/<release>/<version>/<artifact-checksum>

The following values for URL path variables are possible:

<product>

Possible values are post, autocompletion and phone

<country>

You can use the ISO-2 country code in uppercase like DE, AT, CH,…​

For specific services:

For post_wwp use WORLD.

For post_int the following values are valid:

  • INT_AFRICA-MIDEAST (upper case)

  • INT_ASIA (upper case)

  • INT_EUROPE (upper case)

  • INT_OCEANIA (upper case)

  • INT_SOUTHAMERICA (upper case)

<release>

Possible values are release-v2 or release-v3

<Version>

Please use the following syntax yyyy-mm-01 (please note, always set the 1st day of the required month!)

<artifact>

The naming convention for the post artifact follows the pattern <country>_<level>.zip, resulting in filenames such as:

  • DE_001.zip

  • DE_002.zip

  • INT_AFRICA-MIDEAST_002.zip

The autocompletion product adopts the pattern AC_<country>.zip, resulting filenames such as:

  • AC_DE.zip

  • AC_AT.zip

<artifact-checksum>

Add .sha512 to the artifact name to download the checksum:

  • DE_001.zip.sha512

  • AC_AT.zip.sha512

Examples

Download the reference data for Germany (DE) for release V3

curl -H "Authorization: Bearer <your api key>" https://download.connect.uniserv.com/download/v1/data/post/DE/release-v3/2024-01-01/DE_003.zip
curl -H "Authorization: Bearer <your api key>" https://download.connect.uniserv.com/download/v1/data/autocompletion/DE/release-v3/2024-01-01/AC_DE.zip

Download SHA512 checksum for reference data for release V3

curl https://download.connect.uniserv.com/download/v1/data/post/DE/release-v3/2024-01-01/DE_003.zip.sha512
curl https://download.connect.uniserv.com/download/v1/data/autocompletion/DE/release-v3/2024-01-01/AC_DE.zip.sha512

To download the file version.txt use following URL:

https://download.connect.uniserv.com/download/v1/data/post/version.txt
The file version.txt has to be downloaded each time you download some reference data!

To download the installer for reference data use following URL:

https://download.connect.uniserv.com/download/v1/data/post/<ref-data-installer>

Following installers are available:

  • setupRefdata_aix_risc.sh

  • setupRefdata_hp_itanium.sh

  • setupRefdata_linux_x64.sh

  • setupRefdata_linux_x86.sh

  • setupRefdata_solaris_sparc.sh

  • setupRefdata_solaris_x86.sh

  • setupRefdata_windows_x64.exe

  • setupRefdata_windows_x86.exe

The appropriate installer for your platform has to be downloaded each time you download some reference data!