Getting connected

API auth

To authenticate with the API include your Syndicator ID and Syndicator Password in the body of every request. See reference pages for exact structure and location.

<SyndicatorInfo SyndicatorId="ExampleSyndicatorId" SyndicatorPassword="xxxxxxxxxx"/>

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

API URL

The API URL is provided by Paxport Customer Services.

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.

HTTP Requirements

Each request must consist of an HTTPS request with the following attributes:

1. It must be an HTTPS POST message.
2. It must have UTF-8 character encoding.
3. It must be content/media type text/xml.
4. The appropriate request header must be set to indicate the previous two points: Content-Type: text/xml; charset=UTF-8

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 out of FAB.

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