To begin, you’ll need to add and install Particle Auth’s primary SDK, particle_auth_core, to your Flutter application; this is a requirement before moving onto platform-specific configuration.

This can be done through the following command.

flutter pub add particle_auth_core

Once installed, you’re ready to configure Particle Auth and initialize the SDK.

To do this, you’ll need three key values from the Particle dashboard: your project ID, client key, and app ID. These are used to authenticate your instance of Particle Auth and connect your project to the dashboard; these are required to properly initialize the SDK.

Retrieving these keys can be done through the following steps.

For more information on the Particle dashboard, take a look at the dashboard quickstart.

Android

Prerequisites

When using Particle Auth’s Flutter SDK on Android, you’ll need to ensure your project meets a few different requirements (otherwise, you’ll likely run into compatibility issues); these are listed below.

• minSdkVersion 23 or higher.
• compileSdkVersion, targetSdkVersion 34 or higher.
• JavaVersion 17.
• Jetpack (AndroidX).
• Android Gradle Plugin Version: 8.5.1 or higher.
• Gradle Version: 8.9 or higher.

Configuring build.gradle

To begin configuring your project, you’ll need to go ahead and open your build.gradle file, often found at the following file path: ${project name}/android/app/build.gradle.

Within your build.gradle file, you’ll need to add four new lines to ensure Particle Auth runs appropriately:

1. minSdkVersion, which in most cases will be set to 23.
2. manifestPlaceholders["PN_PROJECT_ID"], the projectId previously retrieved from the Particle dashboard.
3. manifestPlaceholders["PN_PROJECT_CLIENT_KEY"], the clientKey previously retrieved from the Particle dashboard.
4. manifestPlaceholders["PN_APP_ID"], the appId previously retrieved from the Particle dashboard.

Below is an example of how this may look.

// Example
defaultConfig {
  applicationId "com.example.particle_auth_test"

  minSdkVersion 23 // Required by Particle Auth
  targetSdkVersion flutter.targetSdkVersion
  versionCode flutterVersionCode.toInteger()
  versionName flutterVersionName

  manifestPlaceholders["PN_PROJECT_ID"] = "YOUR PROJECT ID"
  manifestPlaceholders["PN_PROJECT_CLIENT_KEY"] = "YOUR CLIENT KEY"
  manifestPlaceholders["PN_APP_ID"] = "YOUR APP ID"
}

Staying within your build.gradle file, you’ll need to ensure that you’re using version 17 of Java in both compileOptions and kotlinOptions, alongside enabling dataBinding, as shown below.

// Example
compileOptions {
  sourceCompatibility JavaVersion.VERSION_17
  targetCompatibility JavaVersion.VERSION_17
}

kotlinOptions {
  jvmTarget = JavaVersion.VERSION_17.toString()
}

dataBinding {
  enabled = true
}

Finally, for dependency management, within build.gradle you’ll need to ensure that the repositories object in both buildscript and allprojects has maven { setUrl("https://jitpack.io") } present, such as is shown in the following snippet.

// Example
buildscript {
  ...
  repositories {
      google()
      mavenCentral()
      maven { setUrl("https://jitpack.io") }  // Add this
  }

  dependencies {
      ...
  }
}


allprojects {
  repositories {
      google()
      mavenCentral()
      maven { setUrl("https://jitpack.io") }  // Add this
  }
}

...

iOS

Alternatively, if you’re building an iOS application with Flutter, this entails a unique and iOS-specific configuration process, as will be covered in this section.

Prerequisites

Before beginning, ensure your project meets the following prerequisites:

• Xcode 15.0 or later.

• iOS 14 or later.

With these requirements set, you’ll need to open an exported iOS project and navigate to apps/{project name}.xcworkspace.

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
    <plist version="1.0">
    <dict>
      <key>PROJECT_UUID</key>
      <string>YOUR_PROJECT_UUID</string> <!-- Replace this with your project ID -->
      <key>PROJECT_CLIENT_KEY</key>
      <string>YOUR_PROJECT_CLIENT_KEY</string> <!-- Replace this with your client key -->
      <key>PROJECT_APP_UUID</key>
      <string>YOUR_PROJECT_APP_UUID</string> <!-- Replace this with your app ID -->
    </dict>
    </plist>

<key>NSFaceIDUsageDescription</key>
  <string>We use Face ID for secure access to the app.</string>

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
    end
  end
end

At this point, you’ve installed and configured Particle Auth; the only step remaining before the SDK can be used is initialization.

Particle Auth can be initialized by simply setting your project ID and client key (previously retrieved from the Particle dashboard) through ParticleInfo.set. An example of this has been included in the snippet below.

Upon setting these values, you’ll need to call the init method on ParticleBase. This takes the following parameters:

• chainInfo, representing the primary chain you intend to use (for example, ChainInfo.Ethereum, chainInfo.Polygon).
• env, affecting the information logged within your environment (Env.dev, Env.production, or Env.staging).

// Set the project info, get it from https://dashboard.particle.network.
ParticleInfo.set(projectId, clientKey);
// Initialize ParticleAuth and ParticleAuthCore.
ParticleBase.init(ChainInfo.Ethereum, env);
ParticleAuthCore.init()

You’re now ready to facilitate social login and interacting with the resulting accounts.

As shown below, you’ll need to call ParticleAuthCore.connect to initiate social login, passing in the specific login type you’d like the user to onboard through (.google, .twitter, .discord, etc.) alongside, if applicable, the type of account prompt used by the OAuth provider (.select_account, .consent, .none).

final userInfo = await ParticleAuthCore.connect(LoginType.google,
          prompt: SocialLoginPrompt.select_account);

// Additionally, you can implement custom authentication through JWT.
// Learn more: https://developers.particle.network/guides/configuration/auth/jwt
final userInfo = await ParticleAuthCore.connect(LoginType.jwt,
          account: "the JWT");