Skip to main content
Banking OS unified APIs define a vendor-neutral contract between the Digital Banking Platform and connectors. Each connector implements exactly one unified API specification. You use the same interface for each capability, no matter which core banking system or third-party vendor the connector uses. This page lists the prerequisites and the steps to implement a unified API in a connector.

Choose an API for your connector

Map your connector domain to the unified API it implements.

API playground

Browse the unified API specifications by calendar version (CalVer).

Events playground

Browse the unified event specifications by CalVer.

Error codes

Look up the error codes that the unified APIs return.

Prerequisites

Before you begin, make sure you’re familiar with the following technologies:

Specifications

OpenAPI 3 for APIs and AsyncAPI 3 for events.

Build tools

Java development and Maven.

Required access

To download the unified API artifacts, you need an Artifactory token for https://repo.backbase.com. For more information, see Get started with a custom connector.

Implement a unified API

To implement a unified API in your connector, follow these steps:
  1. Choose an API. Find the unified API that matches your connector domain. For more information, see Choose an API for your connector.
  2. Explore the specification. Browse the endpoints, request and response schemas, and example payloads for each CalVer release. Try it sends requests to a playground mock that returns sample data. For more information, see API playground.
  3. Review the events. If your connector publishes or consumes events, see Events playground.
  4. Set up the connector project. Set api.artifact-id and api.artifact-version in the pom.xml file to the unified API and version you chose. For more information, see Set up the project.
  5. Check the error codes. Look up the error codes that the unified API returns. For more information, see Error codes.
If no unified API fits your use case, create a custom API. For more information, see Create a custom API.