CCFrameworkOpen-iOS gives client apps access to the Scope Connected Car backend. The public API is the Objective-C class CCOpenInterface, usable from Swift and Objective-C. Gamification is described on its own page: iOS CCFrameworkOpen — Gamification.

A backend environment (base URL, URL suffix, protocol) and user credentials are provided by Scope Technologies.

Xcode: File → Add Package Dependencies…, enter the repository URL and add the product CCFrameworkOpen_iOS to your app target:

https://github.com/scopetech/CCFrameworkOpenSPM-iOS.git

Package.swift:

dependencies: [
    .package(url: "https://github.com/scopetech/CCFrameworkOpenSPM-iOS.git", from: "<version>")
],
targets: [
    .target(
        name: "YourApp",
        dependencies: [
            .product(name: "CCFrameworkOpen_iOS", package: "CCFrameworkOpenSPM_iOS")
        ]
    )
]

Import the module:

import CCFrameworkOpen_iOS

@import CCFrameworkOpen_iOS;

The package name, the product name and the module name differ: you add the package CCFrameworkOpenSPM_iOS, link the product CCFrameworkOpen_iOS, and import the module CCFrameworkOpen_iOS.

The order is: initialize → log in → select vehicle → call APIs.

import CCFrameworkOpen_iOS

// 1. Initialize once, before login (e.g. in application(_:didFinishLaunchingWithOptions:))
let config = CCConfig()
config.baseUrl = "<base-url>"
config.urlSuffix = "<url-suffix>"
config.urlProtocol = "https://"
config.resetTokenAutomatically = true

CCOpenInterface.initialize(with: config)

// 2. Log in
CCOpenInterface.login(withUsername: username,
                      password: password,
                      policyNr: nil) { response in
    guard let response, response.success else {
        print("Login failed: \(String(describing: response?.error))")
        return
    }

    // 3. Load account and select a vehicle
    CCOpenInterface.getAccountByIgnoringCache(false) { _ in
        if let vehicle = CCOpenInterface.getVehicles().first as? CCVehicle {
            CCOpenInterface.selectVehicle(vehicle)
        }
    }
}

// Session state
CCOpenInterface.isAuthorized()
CCOpenInterface.getSelectedVehicle()
CCOpenInterface.logout()

Swift names. The Objective-C selectors are imported into Swift using the standard Clang renaming rules, e.g. getBadgesForVehicle:ignoreCache:completeBlock: becomes getBadges(for:ignoreCache:completeBlock:). Xcode's generated interface for CCOpenInterface.h (Jump to Definition) shows the exact Swift signatures.

Every network call is asynchronous and returns a CCAPIResponse through OSCompleteBlock:

typedef void (^OSCompleteBlock)(CCAPIResponse * _Nullable response);

The response itself is nullable. Always unwrap it before reading its properties:

CCOpenInterface.getCurrencyAmount(for: vehicle, ignoreCache: true) { response in
    guard let response, response.success else { return }
    let payload = response.parsedObject ?? response.rawResponse
    // update UI on the main thread
}

Methods with an ignoreCache: parameter can return cached data. Pass true when the UI must reflect the latest server state, for example after a trip.

The SDK posts these notifications through NotificationCenter.default:

NotificationCenter.default.addObserver(forName: Notification.Name(kNotificationLogout),
                                       object: nil, queue: .main) { _ in
    // show login
}

All methods are class methods on CCOpenInterface. Completion blocks are OSCompleteBlock unless stated otherwise.

getUserPlaces:ignoreCache:, getUserPlacesWithPvu:completeBlock:ignoreCache:, createUserPlace:completeBlock:, updateUserPlace:completeBlock:, deleteUserPlaceWithId:completeBlock:, createUserRule:completeBlock:, updateUserRule:completeBlock:, getUserRulesOfType:policyVehicleUnitId:completeBlock:ignoreCache:, deleteUserRuleWithId:completeBlock:, getActivationsForUserRule:completeBlock:, getIsEffectiveForUserRule:completeBlock:

getFuelEntryWith:complete:, addFuelEntryWith:…, updateFuelEntryWith:…, deleteFuelEntryWith:complete:, fuelEntriesSummaryWith:timeInterval:complete:, fuelEntriesSummaryDetailsWith:timeInterval:complete:, fuelEntriesConfigurationWith:complete:, updateFuelEntriesConfigurationWith:quantity:odomert:complete:

• Games and rewards are evaluated on the backend. The app only derives display state (status split, current level) from the API data.
• No game notifications. Game updates are obtained by requesting the data again; see When to refresh.
• This is the open distribution. Endpoints written for one named customer are not part of the public API; the generic equivalents are.
• Network logging. Requests and responses are logged to the console at info level. The internal logging hooks used by Scope apps are not part of this build.
• Dispatch UI updates from completion blocks to the main queue explicitly.

• iOS CCFrameworkOpen — Gamification
• Release notes