Initialization

Instructions for initializing Deepwall SDKs

Before starting to implement Deepwall into your app, you need to register your app on the Deepwall management console and get the client API key.

If you have not registered your app yet, please refer to the guide for app registration.

App Registration

Import and Initialize

After you have completed the installation of our SDK for your platform, you can import and initialize the Deepwall SDK in your app.

Swift

import DeepWall
let yourApiKey = "{CLIENT_API_KEY}"
let environment: DeepWallEnvironment = .production
DeepWall.initialize(apiKey: yourApiKey, environment: environment)

Kotlin

DeepWall.initDeepWallWith(
   application = application,
   activity = activity,
   apiKey = "{CLIENT_API_KEY}",
   environment = DeepWallEnvironment.production,
   )

React Native

import DeepWall, { DeepWallEnvironments } from 'deepwall-react-native-sdk';
DeepWall.getInstance().initialize('{CLIENT_API_KEY}', DeepWallEnvironments.PRODUCTION);

Flutter

import​ ​'package:deepwall_flutter_plugin/deepwall_flutter_plugin.dart'​;
DeepwallFlutterPlugin.initialize(​'{CLIENT_API_KEY}'​, Environment.PRODUCTION.value);

Cordova

cordova.DeepwallCordovaPlugin.initialize("CLIENT_API_KEY", Environments.PRODUCTION, function(response){
    console.log(response);
}, function(error){
    console.log(error);
});

Unity

using DeepwallModule;

DeepWall.InitDeepWall("CLIENT_API_KEY_ANDROID","CLIENT_API_KEY_IOS", DeepWallEnvironment.Sandbox, eventListener: this);

You should only initialize Deepwall once, usually on app launch.

Client API Key

You need to replace {CLIENT_API_KEY} with your app specific key created by Deepwall during app registration. You can get this key from the Deepwall management console. Just navigate to the App Settings page on the Integration tab.

Environment

Depending on whether you built your app for testing or for production, you must set the environment as sandbox or production.

This value should be set to .sandbox only during the testing phase of your application. Make sure to set the environment to .production just before you publish the app.

We use this environment to distinguish between real traffic and test traffic from test devices. It is very important that you set this value accordingly.