Getting connected

API auth

To authenticate with the API include your username and password as basic auth for every request.

• Credentials are issued by Paxport Customer Services team.
• Not yet a customer? Contact sales@paxport.com

API URL

API URLs can be found in Swagger/OpenAPI, see this page.

We do not guarantee a static IP address for the URL. Therefore the IP must always be used via DNS and appropriate DNS caching limits must be used.

The URL is HTTPS only.

Test environment

You can use the test environment to test API functionality against supplier test systems.

Environment selection is based on URL (sub)domain.

See this page for URLs.

Supported TLS ciphers and versions

The following are supported:

TLS 1.3

TLS_AES_128_GCM_SHA256 (0x1301)   ECDH x25519 (eq. 3072 bits RSA)   FS	128
TLS_AES_256_GCM_SHA384 (0x1302)   ECDH x25519 (eq. 3072 bits RSA)   FS	256
TLS_CHACHA20_POLY1305_SHA256 (0x1303)   ECDH x25519 (eq. 3072 bits RSA)   FS	256

TLS 1.2

TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (0xc02f)   ECDH x25519 (eq. 3072 bits RSA)   FS	128
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (0xcca8)   ECDH x25519 (eq. 3072 bits RSA)   FS	256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (0xc030)   ECDH x25519 (eq. 3072 bits RSA)   FS	256

Performance tips

Here are some tips to get the best performance.

• Use HTTP 1.1 connection pooling/reuse or HTTP/2 to reduce connection (and TLS) overhead.
• Request that responses be compressed.
  • E.g request header of Accept-Encoding: gzip.