Skip to content

Getting started

Prerequisites

The Bittiq SDK requires a minimum deployment target of iOS 10.0 and Swift 5.3 and up.

Downloading and installing the Bittiq SDK

At the moment, the Bittiq SDK is not available on Cocoapods, Carthage or Swift Package Manager. Downloading and integrating the SDK into your project has to be done manually, but it is an easy process and takes very little time.

Step 1: Download the SDK
The SDK comes in the form of an xcarchive, for XCode 12 and up. Please download the SDK from the link below.

  • The latest version of the Bittiq SDK for XCode 12 and up can be found here.

Step 2: Integrate into your project
In the downloaded archive from step 1, you'll find two frameworks: BittiqSDK.xcframework and MockBittiqSDK.xcframework. The former communicates with the Bittiq API server and requires a valid API key that can be obtained by contacting Bittiq, while the latter works completely offline and uses mocked server responses that are included in the SDK to simulate server calls. This version requires no API key and can be used immediately.

To use the frameworks in XCode, first copy them to your project folder and then navigate to your project's settings, select your app's target and add the frameworks to Frameworks, Libraries, and Embedded Content. Also, make sure that Embed & Sign is selected for both, like in the image below.

Embed frameworks

Important
Please make sure that you don't ship your app to the App Store with the MockBittiqSDK framework included! You should remove this framework from your project before you create an archive.

What's next?

Please see the Usage page for an introduction on how to use the Bittiq SDK. Once you're ready to get your hands dirty, take a look at the API Reference for a detailed description of how to integrate all the features that this SDK has to offer.

For Bittiq to be able to access a user's financial information, the user first needs to give their consent. The SDK provides an API to manage this. Since this process is a little bit more involved, we've created a separate Consent flow page to help you out.