SDK Configurations

This guide explains the configuration methods for Dapi Flutter 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.

DapiConfigurations configurations = new DapiConfigurations(
    environment: DapiEnvironment.SANDBOX,
    countries: List.from({"US", "AE"}),
    showTransferErrorResult: true,
    showTransferSuccessfulResult: true,
    extraBody: {"key1": "value1", "key2": "value2"},
    extraHeaderFields: {"key1": "value1", "key2": "value2"},
    postSuccessfulConnectionLoadingText: "Loading..",
    language: DapiLanguage.AR,
    theme: new DapiThemeConfigurations(
      enforceTheme: DapiTheme.DARK,
      primaryColor: new DapiColor(lightMode: "#610903", darkMode: "#cf1002"))
);

Configuration Parameters

Parameter	Description
environment	The running environment for Dapi. Set to `DapiEnvironment.PRODUCTION` for production release and `DapiEnvironment.SANDBOX` for testing.
countries	Array of countries that you support, use the `Alpha-2` country codes from COUNTRY CODES LIST
extraHeaderFields	HashMap of header fields to send to any endpoint.
extraBody	HashMap 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.
postSuccessfulConnectionLoadingText	The text to show in the loader screen after a successful credentials input on Connect.
showTransferSuccessfulResult	Boolean that controls the Result Screen visibility after a successful payment attempt using Dapi UI. Set true to show Result Screen, false otherwise.
showTransferErrorResult	Boolean that controls the Result Screen visibility after a failed payment attempt using Dapi UI. Set true to show Result Screen, false otherwise.
theme	`DapiThemeConfiguration` 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.
language	The language of the SDK Supported languages: English `DapiLanguage.EN`, Arabic `DapiLanguage.AR` Default language: `DapiLanguage.EN`

Start the SDK with your configurations

DapiConfigurations configurations = new DapiConfigurations(
    environment: DapiEnvironment.SANDBOX,
    countries: List.from({"US", "AE"}),
    showTransferErrorResult: true,
    showTransferSuccessfulResult: true,
    extraBody: {"key1": "value1", "key2": "value2"},
    extraHeaderFields: {"key1": "value1", "key2": "value2"},
    postSuccessfulConnectionLoadingText: "Loading..",
    theme: new DapiThemeConfigurations(
      enforceTheme: DapiTheme.DARK,
      primaryColor: new DapiColor(lightMode: "#610903", darkMode: "#cf1002"))
);

await Dapi.start("#app_key#","#client_user_id#", configurations: configurations);

📘
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 using Dapi.setConfigurations() to set your modifications

DapiConfigurations configurations = new DapiConfigurations(
    environment: DapiEnvironment.SANDBOX,
    countries: List.from({"US", "AE"}),
    showTransferErrorResult: true,
    showTransferSuccessfulResult: true,
    extraBody: {"key1": "value1", "key2": "value2"},
    extraHeaderFields: {"key1": "value1", "key2": "value2"},
    postSuccessfulConnectionLoadingText: "Loading.."
);

Dapi.setConfigurations(configurations);

Enable Network Logging

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

For Android:
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>

For iOS:
1. Open Product -> Scheme -> Edit Scheme -> Arguments
2. Add DAPI_NETWORK_LOGGIN_ENABLED environment variable with value YES

Dapi Configurations

Configuration Parameters

Start the SDK with your configurations

📘Note

Modify the SDK configurations

Enable Network Logging

📘
Note