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 forhttps://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:- Choose an API. Find the unified API that matches your connector domain. For more information, see Choose an API for your connector.
- 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.
- Review the events. If your connector publishes or consumes events, see Events playground.
- Set up the connector project. Set
api.artifact-idandapi.artifact-versionin thepom.xmlfile to the unified API and version you chose. For more information, see Set up the project. - Check the error codes. Look up the error codes that the unified API returns. For more information, see Error codes.