Details

Security

All communication with Ultrafast APIs will be over Transport Layer Security (TLS).

The Client ID and Client Secret provided to you will be used to request a token.

Limits

Ultrafast rate-limits requests sent to our APIs. This is to prevent our systems from being flooded, so that we are able to serve all of our API users.

Versioning

Ultrafast manages our APIs in the following way:

Release Type

Change Type

Functional changes

Documentation changes

Notification

Patch Release

Fixing API defects

• No notification

Minor Release

Changing the API’s data and/or structures in a non-breaking way

• Adding new data

• Rearranging data order

• Minor version change

• API Documentation will be updated for the new version

• Notification of change will be given through regular channels

Major Release

Changing the API’s data and/or structures in a breaking way

• Removing fields

• Adding new data representation

• Renaming data fields

• Adding further mandatory fields

• Major version change

• New URL

• New API Documentation for the new version

• Notification of change will be given through regular channels

• Not mandatory to migrate to Minor Version. Consume the change as your systems allow. You can test the new version in our Sandbox environment before progressing into Production

API Deprecation

Retiring an API

• Deprecated Versions will continue to be available to existing users, but new users will be onboarded to the latest version

• Deprecation flag

• Planned decommissioning date

• Notification of change will be given through regular channels

API Decommissioning

Switching off an API

• Decommisioned Versions will not be able to be called after the official decommisioning date

• Notification of change will be given through regular channels after consultation with active users