Configures UserKit with your API key and initializes the SDK for use.

​
Purpose

The configure method initializes the UserKit SDK with your API key, setting up the necessary configuration for video calls and screen sharing functionality. This must be called before any other UserKit methods.

​
Signature

static func configure(apiKey: String)

​
Parameters

NameTypeDescription
apiKeyStringYour UserKit API key obtained from the UserKit dashboard

​
Returns

This method does not return a value.

​
Usage

​
Basic Configuration

import UserKit

// Configure UserKit with your API key
UserKit.configure(apiKey: "YOUR_API_KEY")

​
Notes

  • This method should be called as early as possible in your app’s lifecycle
  • The API key can be found in your UserKit dashboard under Settings
  • Ensure your API key is kept secure and not exposed in public repositories