External Developer (FI/Fintech/Partner) Setup

Note

Remote development is an option provided for FI/Fintech/Partner developers. Internal Q2 developers should use the Local Dev setup.

Welcome to the Q2 Caliper SDK program! As part of the on-boarding process, you should have received a welcome email containing a few things:

  1. Online banking URL with credentials– to see the results of your work.

  2. Username and Password to access the shared development environment.

  3. Gitlab repository

Architecture

There are several ways to develop code using the Caliper SDK. While it’s not necessary to understand the full architecture stack at this stage, it’s worth noting a few things:

  1. We have created a database filled with realistic data for your use

  2. Your SDK code will access that database primarily through an API called “HQ” which is running, publicly available, on the Internet

  3. We have created an Online banking stack pointed at the above HQ

  4. Your Caliper SDK code will run as a web server, with responses defined by you. Therefore, HQ will need to call this web server in order to interact with the provided stack

  5. You likely do not want to open your personal or work machine up to traffic from the wider Internet, therefore we have provided two mechanisms to safely expose your web server:

    1. You can login to a Q2 provided shared development server using SSH and develop from there. It is loaded with software and resources to make development simple. This method is fairly plug-and-play, and has been our preferred method for development since the beginning of the Caliper SDK program. However, it is a large system with dozens or hundreds of developers using it simultaneously, which comes with some downsides. Instructions for using shared dev are listed below.

    2. Develop locally

Setup

  1. First let’s ensure you can log on to the shared dev machine:

    • Into a terminal of your choice (powershell/iterm2/terminal/etc), enter ssh sdk-shared-dev.q2devstack.com -l <username>. Your username/password is the same as your login to q2developer.com.

    • Working? Great! Don’t have access? Make a sandbox request from your Q2 Developer Dashboard and the Caliper SDK team will give you a hand.

  2. That’s it for setup, as all packages and configuration are taken care of on the machine already. If you’d like to configure an IDE, check the guide: