Quick Start Guide
How to get started by downloading and initialising the SDK in your environment
Last updated
How to get started by downloading and initialising the SDK in your environment
Before starting you'll need to be familiar with how the platform works. Review the following documents and you'll be ready to go.
You can request access to the platform and the SDK via support@monterosa.co or your account manager.
Request a login to Monterosa / Studio and you'll receive an invite to login and set up your account
Request access to Monterosa / Interaction SDK and you'll receive a Welcome Pack with your credentials
You should first follow the steps outlined here Download & Initialise the SDK
Once the initial setup is done, you will need to add InteractKit as a dependency on your codebase, as InteractKit is the library of our SDK that provides access to bi-directional data flows. You can add InteractKit as follows:
If you use Swift Package Manager, add the following GIT repository URL as a new package dependency in Xcode:
https://<package-username>:<package-token>@gitlab.com/monterosa-sdk/ios.gitFinally, select MonterosaSDKInteractKit from the list of available Package Products.
If you use CocoaPods, the GIT repository source URL should already be in your Podfile, so you'll just need to add the following pod dependency:
pod 'MonterosaSDKInteractKit'Add the following Interaction SDK packages as dependencies to the app-level build.gradle:
dependencies {
...
implementation "co.monterosa.sdk:interactkit"
...
}NPM should already have been setup to locate the Monterosa / Interaction SDK packages, so we just need to install the InteractKit package:
npm install @monterosa/sdk-interact-kitNPM should already have been setup to locate the Monterosa / Interaction SDK packages, so we just need to install the InteractKit package:
npm install @monterosa-sdk/interact-kitImportant: You still need to include all Stable polyfills for environments that don't support the features required by Monterosa / Interaction SDK.
Your IDE should help with importing InteractKit, here are some examples:
Last updated
import {
getProject,
getEvents,
...
} from '@monterosa/sdk-interact-kit';import {
getProject,
getEvents,
...
} from '@monterosa-sdk/interact-kit';