Changelog

SDK Configurations

This guide explains the configuration methods for Dapi Android SDK and how to set environment, send data to your backend server and customize Dapi UI.

Dapi Configurations

You can use DapiConfigurations to configure the SDK as follows.

val configurations = DapiConfigurations(
    environment = DapiEnvironment.SANDBOX,
    countries = arrayOf("US", "AE", "SA"),
    extraHeaderFields = hashMapOf(Pair("key1", "value1"), Pair("key2", "value2")),
    extraBody = hashMapOf(Pair("key1", "value1"), Pair("key2", "value2")),
    postSuccessfulConnectionLoadingText = "Loading..",
    showCloseButton = true,
    showAddButton = false,
    showTransferSuccessfulResult = true,
    showTransferErrorResult = true,
    language = DapiLanguage.EN,
    theme = DapiThemeConfigurations(
          enforceTheme = DapiTheme.DARK,
          primaryColor = DapiColor(lightMode = "#610903", darkMode = "#cf1002")
      )
)

Configuration Parameters

ParameterDescription
environmentThe running environment for Dapi.
Set to DapiEnvironment.PRODUCTION for production release and DapiEnvironment.SANDBOX for testing.
countriesArray of countries that you support, use the Alpha-2 country codes from COUNTRY CODES LIST
extraHeaderFieldsHashMap of header fields to send to any endpoint.
extraQueryParametersHashMap of query parameters to send to any endpoint.
extraBodyHashMap of entries to include in any request under the key UserExtraBody.
The extraBody will look like UserExtraBody:{Key1:"Value1", "Key2": "Value2"} included in the original request body.
showCloseButtonBoolean that controls X button visibility on Connect. Set true to show X button, false otherwise.
showAddButtonBoolean that controls Add button visibility on Accounts Screen. Set true to enable your users to open Connect from the Accounts Screen, false otherwise.
postSuccessfulConnectionLoadingTextThe text to show in the loader screen after a successful credentials input on Connect.
showTransferSuccessfulResultBoolean that controls the Result Screen visibility after a successful payment attempt using Dapi UI. Set true to show Result Screen, false otherwise.
showTransferErrorResultBoolean that controls the Result Screen visibility after a failed payment attempt using Dapi UI. Set true to show Result Screen, false otherwise.
themeDapiThemeConfiguration to configure the SDK UI theme.

enforceTheme -> enforce a specific theme DapiTheme.LIGHT DapiTheme.DARK or device theme DapiTheme.DYNAMIC

primaryColor -> your primary color for Light and Dark Modes in Hex format.
languageThe language of the SDK

Supported languages: English DapiLanguage.EN, Arabic DapiLanguage.AR

Default language: DapiLanguage.EN

Start the SDK with your configurations

Open your Application class and add this code to your onCreate method

val configurations = DapiConfigurations(
    environment = DapiEnvironment.SANDBOX,
    countries = arrayOf("US", "AE", "SA"),
    extraHeaderFields = hashMapOf(Pair("key1", "value1"), Pair("key2", "value2")),
    extraBody = hashMapOf(Pair("key1", "value1"), Pair("key2", "value2")),
    postSuccessfulConnectionLoadingText = "Loading..",
    showCloseButton = true,
    showAddButton = false,
    showTransferSuccessfulResult = true,
    showTransferErrorResult = true,
    language = DapiLanguage.EN,
    theme = DapiThemeConfigurations(
      enforceTheme = DapiTheme.DARK,
      primaryColor = DapiColor(lightMode = "#610903", darkMode = "#cf1002")
    )
)

Dapi.start(
    application = this,
    appKey = "<#app_key#>",
    clientUserID ="<#client_user_id#>",
    configurations = configurations,
    onSuccess = {
    },
    onFailure = { error ->
        
    }
)

πŸ“˜

Note

ClientUserID is used to distinguish between different users on the same device. The value for ClientUserID needs to be set by you. We recommend setting clientUserID to your actual user ID that you use to distinguish between users. You should update the clientUserID once the user logs out and another user logs in.

Modify the SDK configurations

You can modify the configurations after you've started the SDK successfully by accessing Dapi.configurations to set your modifications

Dapi.configurations.environment = DapiEnvironment.PRODUCTION
Dapi.configurations.countries = arrayOf("EG", "JO")
Dapi.configurations.extraBody = hashMapOf(Pair("newKey1", "newValue1"), Pair("newKey2", "newValue2"))
Dapi.configurations.... = ...

Enable Network Logging

Enable network logging to get full information on the requests happening inside the SDK.

  1. Open AndroidManifest.xml.
  2. Add the following code.
<application
     android:icon="@mipmap/ic_launcher"
     android:label="@string/app_name"
     android:roundIcon="@mipmap/ic_launcher_round"
     .
     .
     .>

      <!--enable logger-->
      <meta-data
            android:name="co.dapi.networkLoggingEnabled"
            android:value="true" />
</application>

What’s Next