Quickstart guide

Succinct steps to get your Sees360 integration up and running.

Setup a project

1. Go to the Projects screen and click “Add New Project”
2. Complete the Name and Package name fields — for iOS, use your app’s bundle identifier (e.g. com.example.app)
3. Generate a new API token, giving it a descriptive name e.g. “Staging API key”

Copy the API key immediately as you will not be shown this key again!

Install the SDK into your app

The SDK is distributed as a closed-source .xcframework via AWS CodeArtifact’s Swift Package Registry. Xcode needs the registry configured on your machine before it can find the package.

1. Visit the Accounts screen and click Generate a new access token (valid for 12 hours)

2. Configure the registry and log in with that token:

   swift package-registry set --global \
     "https://sees360-533267413064.d.codeartifact.eu-west-2.amazonaws.com/swift/ios-sdk/"
   
   swift package-registry login \
     "https://sees360-533267413064.d.codeartifact.eu-west-2.amazonaws.com/swift/ios-sdk/login" \
     --username aws --password "PASTE_TOKEN_FROM_WEB_APP_HERE" --no-confirm
   

3. Relaunch Xcode — it caches registry state per-launch, so it won’t see the login from step 2 until you quit and reopen it. This is the single most common “it can’t find the package” gotcha.
4. In Xcode: File → Add Package Dependencies…, search for the exact identifier sees360.Sees360SDK (not a URL) and pick a version. macOS will prompt for Keychain access the first time — allow it.

5. Initialize the SDK in your app:

   import Sees360SDK
   
   // apiKey     - The API key generated when setting up the project, stored here in a build config/secrets file
   // identifier - A unique identifier for your customer, e.g. a UUID you generate and persist yourself
   let apiKey = Secrets.sees360APIKey
   Sees360.initialize(apiKey: apiKey, identifier: identifier)
   

Two host-app Info.plist entries are required before background delivery will work: UIBackgroundModes → array containing fetch, and BGTaskSchedulerPermittedIdentifiers → array containing the value of Sees360.backgroundTaskIdentifier (com.sees360.sdk.retry). Call Sees360.initialize(...) synchronously from application(_:didFinishLaunchingWithOptions:). If these are missed, the SDK still works, but analytics/device events queued while the app is backgrounded won’t be retried until the app is next foregrounded.

Minimum deployment target: iOS 15.

Next steps

• Event Tracking — record custom user interactions with track(name:)
• Screen-View Tracking (UIKit)
• Screen-View Tracking (SwiftUI)