Skip to content
Developer home

Prerequisites

  Less than to read

Recommendations

For Web Products

While waiting for prerequisite details to be allocated, this initial, temporary, set may be used in the interim. Please note that these only work on our QA and Pre-Prod environments. These will never work in the Production environment – the onus is still on you to request your product-specific details, giving the Banking Service team time to prioritise and fulfil the request (expect max of 2-3 weeks as a coordinated deployment to Pre-Prod is required).

  • Product ID: “sage.integrate.myproduct”
  • Signing key (Web Products Only): “16484ccc541734aa4274c80e14577348e6540ab9a7bda8063968bbd19229612f”

For Desktop Products

While waiting for prerequisite details to be allocated, this initial, temporary, set may be used in the interim. Please note that these only work on our QA and Pre-Prod environments. These will never work in the Production environment – the onus is still on you to request your product-specific details, giving the Banking Service team time to prioritise and fulfil the request (expect max of 2-3 weeks as a coordinated deployment to Pre-Prod is required).

  • Product ID: “sage.integrate.myproduct”
  • Provider ID: “integrate.my.provider”
  • LicenceData (key-value-pair): “serial” - “ACTIVE”

Obtain your ‘Product ID’

Each Sage product consuming the Banking Service API will first need be set-up as a valid consuming application within the Banking Service platform. You will receive a unique ID to either:

  • As an online product, populate the x-application custom header on all API requests.
  • As an on-premises product, set the ProductHeader via the Client Library.

Your Product ID will be a string, in a form similar to “Sage.[Region].[Product]”.

Action: Contact us us to request your Product ID.

Obtain your ‘Signing Key’ (Web Products only)

Each online Sage product consuming the Banking Service API will also require their own unique, private API Signing Key (a 64-byte token). This key should be stored securely within the Sage product and used to sign only the initial POST request to the Banking Service /organisations endpoint during on-boarding of a new organisation/customer, in order to authenticate the Sage product as a valid API consumer.

The response to POST/organisations will include a new unique, per-org/customer, signing key which should then be used for all subsequent requests to the Banking Service API on behalf of that organisation/customer. See the swagger documentation for more information.

You will be provided with two keys; one to be used with our QA and Pre-Prod environments, and another for the Production environment.

Action: Contact us us to request your Signing Key.

:

Note: These Signing Keys, particularly for the Production environment - should be handled securely. Under no circumstance should they be shared outside of the development team, and ideally be known to only a few individuals (the fewer the better).

Obtain your ‘Provider ID’ (Desktop Products only)

As an on-premises consumer, you will authenticate yourself with the “Token Service” via the Client Library. In order to do so you will need to set a Provider ID (a.k.a ProviderHeader), which enables the correct internal-mapping to the appropriate licencing adaptor. It is worth enquiring whether your product will require a new adaptor to be created or if an existing one can be reused; this is work that your team will be responsible for, with support from the Banking Service Team. See Client Library for more details on how the Provider ID is used.

Action: Contact us us to discuss how your product licencing works, and request your, typically region-specific, Provider Id.