Registration
Before accessing the Transact API, you must:
- Obtain a client ID by contacting Transact.
- Generate a client secret.
- Register one or more redirect URIs.
During the OAuth authorisation flow your client ID and client secret are used to authenticate your application, and your redirect URIs are used to return data to your application.
Get your client ID
If you are not already registered as a software provider with Transact:
- Please Contact Us, declaring your wish to register as a software provider.
- We will supply you with your unique client ID and Transact Online software provider login credentials.
If you are already registered as a software provider:
- you already have Transact Online software provider login credentials
- your Provider Key (as previously supplied) is your client ID.
Set up your account
Log in to Transact Online1 with your software provider login credentials.
Accept the Terms of Business
Before using the Transact API, you must accept the Terms of Business at Housekeeping > Terms of Business.
This must be performed on an annual basis to maintain access to the API. We will be in touch with you when it is time to reaccept.
Generate your client secret
To obtain your client secret and register redirect URIs, navigate to Housekeeping > OAuth Settings.
Click "Generate Secret" to generate a client secret. You may repeat this process at any time to generate a new client secret.
Please take note of the generated client secret as it is not retrievable in future, even by Transact. If you forget your client secret it must be regenerated.
Register your redirect URIs
Within Housekeeping > OAuth Settings, register one or more redirect URIs under the "Redirect URIs" heading.
The redirect URI that you submit as part of the OAuth flow must exactly match one of your registered redirect URIs.
This includes any URL parameters (e.g. https://example.com/callback?productid=334).
In order to simplify local development, the UAT environment1 permits the use of
corp, domain, example, home, host, invalid, lan, local, localdomain, localhost and test top-level domains.
Whitelisting
Please note that there is no requirement to whitelist your server addresses for Transact API. The menu Housekeeping > Allowed IP List is relevant to legacy TRDS endpoints only.
Footnotes
-
See Environments. UAT Transact Online can be found at https://demo.transact-online.co.uk. ↩ ↩2