Skip to content
Developerhome

2. Get set up

  Less than to read

What is the Consumer API

The Consumer API is responsible for supporting Sage products in obtaining banking data, such as transactions and account balances. It allows you to capture rules, and apply them to transactions to help identify them.

You can find an overview of Banking Service and the Consumer API in the What is Banking Service? section.

Other solutions exploit the banking data in our service to provide bank reconciliation functionality. This is a key feature of Accounting products. Without our software it can be a very time-consuming task.

Learn more about how the reconciliation process that is implemented in Sage products.

Find out more about bank feeds in the Sage Accounting product. Bank feeds were built using the Consumer API.


Register your interest and apply

If you have made the decision to connect to Banking Service, go to the Banking Service forum to express your interest.

Our Enablement team will be in touch to discuss integration and next steps. They will help you assess against the consumer requirements and answer any of your questions.

After registering, we will enable you as a consumer in Banking Service. You can then set up for integration.


Kick-off call

The kick-off call is an introduction to members of our Enablement team. It’s an opportunity to ask any pre-development questions. This includes:

  • Introductions to the team members
  • Introduction to setup requirements
  • Overview of roadmap and the go-live process
  • Ongoing support

Obtain your Product ID

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

  • 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]”.

Get in touch using the Banking Service forum to request your Product ID.

Obtain your Signing Key (web products only)

Each online Sage product consuming the Banking Service API needs a unique, private API Signing Key (a 64-byte token). This key should be stored securely within the Sage product. It’s used to sign the initial POST request to the Banking Service /organisations endpoint during onboarding a new organisation/customer. It’s used to authenticate the Sage product as a valid API consumer.

The response to POST/organisations will include a new unique signing key which should then be used for all subsequent requests to the Banking Service API for that organisation or customer. See the Swagger documentation for more information.

You will be provided with 2 keys; 1 for our QA and pre-production environments, and another for the production environment.

Get in touch using the Banking Service forum to request your Signing Key.

:

Note: These signing keys, particularly for the production environment, should be handled securely. Under no circumstances should they be shared outside of the development team. Ideally they would be known only by a few individuals. The fewer the better.

Obtain your Provider ID (desktop products only)

As an on-premise consumer, you will authenticate yourself with the Token Service using the Client Library.

You will need to set a Provider ID (ProviderHeader), which enables the correct internal mapping to the appropriate licencing adaptor. It is worth checking 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 Banking Service.

Go to Client Library for more details on how the Provider ID is used.

For web products

While waiting for prerequisite details to be allocated, this temporary set may be used. These only work in our QA and pre-production environments. These will never work in the production environment. It’s your responsibility to request your product-specific details, giving the Banking Service team time to prioritise and fulfil the request. You should expect a maximum of 2-3 weeks as a coordinated deployment to pre-production 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 temporary set may be used. These only work on our QA and pre-production environments. These will never work in the production environment. It’s your responsibility to request your product-specific details, giving the Banking Service team time to prioritise and fulfil the request. You should expect a maximum of 2 to 3 weeks as a coordinated deployment to pre-production is required.

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

Get in touch using the Banking Service forum to discuss how your product licencing works, and to request your Provider ID.


Next steps

Find out about Postman collections and how to integrate with Banking Service in Stage 3: Integrate.