Logo

Installation & Initial Setup

Manual Installation

  1. Download the latest release archive from the Birbonus SDK releases page.
  2. Extract the archive and add the framework folder to your Xcode project.
  3. Open the application target settings.
  4. Ensure that the framework is added to the target's Embedded Binaries section.

Initial Setup

Importing the SDK

Import the framework wherever Birbonus SDK types are used:

import BirbonusSDK

Configuring the SDK

Create an EcoConfiguration instance with the required environment, language, and host application hash. Then create the authentication manager, details delegate, and EcoConfigurator.

// Create the SDK configuration
let configuration = try EcoConfiguration.build(
    environment: .production,
    language: .english,
    host: "<HOST_APP_HASH>"
)

// Create an authentication manager that conforms to EcoAuthenticationProtocol
let authManager = MyAuthManager()

// Create a details delegate that conforms to EcoDetailsProtocol
let hostDelegate = HostAppManager()

// Initialize the configurator
let configurator = EcoConfigurator(
    configuration: configuration,
    authManager: authManager,
    hostDelegate: hostDelegate
)
Important: The Host App Hash is not a randomly generated value. It is a unique hash assigned to the host application. Contact the Birbonus technical team to obtain the correct value.

Supported Environments

public enum AppEnvironmentSDK: String, CaseIterable {
    case testing
    case production
    case development
}

Supported Languages

public enum AppLanguageSDK: String, CaseIterable {
    case azerbaijani
    case english
    case russian
}