Skip to content

Client-side Setup

Backendless-Flutter integration is implemented in a Flutter plugin. Follow the steps below to enable the integration in your application:

  1. Step 1: Register the plugin
    To use this plugin in your Flutter project, add backendless_sdk as a dependency in your pubspec.yaml file:

      backendless_sdk: ^1.0.0

  2. Step 2: Import the Backendless SDK:
    Add the following import to your Dart code:

    import 'package:backendless_sdk/backendless_sdk.dart';

  3. Step 3: Initialize the Backendless SDK:
    Use the following call in your code. Make sure to read the comment about the EU hosting zone:

    void initState() {
      // uncomment the line below if your application is hosted in the European hosting zone of Backendless:
      // Backendless.setUrl("")

    See the section below for instructions on how to obtain APPLICATION_ID, ANDROID_API_KEY and IOS_API_KEY.

  4. Step 4: Use the Backendless APIs in your code. Below is a sample code which stores an object in Backendless database:
    // create a Map object. This will become a record in a database table
    Map testObject = new Map();
    // add a property to the object. 
    // The property name ("foo") will become a column in the database table
    // The property value ("bar") will be stored as a value for the stored record
    testObject["foo"] = "bar";
    // Save the object in the database. The name of the database table is "TestTable"."TestTable").save(testObject).then(
      (response) => print("Object is saved in Backendless. Please check in the console."));

Proguard Configuration

If your Flutter application uses code shrinker (for example Proguard or R8), it is necessary to add the following configuration parameters to  your Proguard config:

-dontwarn com.backendless.**  
-dontwarn weborb.**  
-keep class weborb.** {*;}  
-keep class com.backendless.** {*;}

Application ID and API Keys

Values for the APPLICATION_ID, ANDROID_API_KEY and IOS_API_KEY arguments in the application initialization call must be obtained through the Backendless Console:

  1. Login to your account and select the application.
  2. Click the Manage icon from the vertical icon-menu on the left.
  3. The App Settings section is selected by default. The interface contains values for Application ID and API keys for each supported client-side environment.
  4. Use the Copy icon to copy the value into the system clipboard.

Make sure to use the "Android API Key" and "iOS API key" for the ANDROID_API_KEY and IOS_API_KEY arguments accordingly.