Skip to content
Developerhome

Using Bruno

Published   24 January 2023     Less than to read

To see the Sage Banking Service Provider API in action you can use Bruno, a modern API client with an intuitive GUI for:

  • configuring HTTP requests
  • designing JSON payloads
  • viewing HTTP responses
  • testing API workflows

Get Bruno

Visit the Bruno website to Download and install Bruno.

Bruno is available for Windows, macOS, and Linux. You can also install it via package managers:

macOS:

brew install bruno

Windows:

winget install Bruno.Bruno

Linux:

snap install bruno

Import the Bruno collection

Bruno supports Collections which are a pre-packaged bundle of API requests. To assist in the development and testing of your integration, we have provided our Bruno collection which covers the various flows. Further explanation of the collections including use cases and flows is available from Use cases and diagrams.

  1. Download the Banking Service Bruno Collection from GitHub
  2. Unzip the collection file
  3. Open Bruno
  4. Click Open Collection or use Ctrl/Cmd + O
  5. Navigate to the unzipped folder and select it
  6. The collection will appear in your workspace

Import Postman environment files

Bruno can import Postman environment files, making it easy to migrate from Postman. The environment JSON provided by Sage during registration contains the details of the sandbox test environment including your client ID and secret.

  1. Unzip the JSON format file from the downloaded ZIP archive
  2. Open Bruno
  3. Go to Environments in the left sidebar
  4. Click Import and select the environment JSON file
  5. Ensure the new environment is selected once imported

Using the Bruno collection

The Bruno collection is organized into logical workflows:

  • Bank Sync - Provider-side bank management
  • Onboarding - Customer and account setup
  • Multi-Account Linking - Link multiple accounts
  • Posting Statements - Upload bank statements
  • Reauthorization - Handle expired authorizations
  • Offboarding - Account cleanup

Each request includes test scripts that validate response codes, set environment variables, and perform business logic checks.

Version control

Bruno collections are stored as plain text files, making them perfect for version control. You can:

  • Commit collections to Git repositories
  • Collaborate with team members
  • Track changes over time
  • Use branching strategies for different environments

Use cases and diagrams

To help visualise the Bruno collection and aid the testing of your integration, we have created supporting documentation containing use cases and flow diagrams.