Flutter身份验证插件authivate的使用

Authivate

Authivate 是一个用户认证和管理平台。

安装 💻

要开始使用 Authivate，你必须在你的机器上安装 Dart SDK。

通过 dart pub add 安装：

dart pub add authivate

示例用法

以下是一个完整的示例，展示了如何使用 Authivate 插件进行用户注册、登录、发送确认密码邮件和忘记密码邮件。

import 'dart:developer';

import 'package:authivate/authivate.dart';

void main() async {
  // 初始化配置
  final config = AuthivateConfig(
    apiKey: 'your-API-key-gotten-from-the-dashboard',
    projectId: 'authivate-test',
  );

  /// 初始化 Authivate 实例
  final autivateInstance = Authivate(config: config);

  /// 注册用户
  await signUpUser();

  /// 登录用户
  await signInUser();

  /// 发送确认密码邮件
  await sendConfirmAccountEmail();

  /// 发送忘记密码邮件
  await sendForgotPasswordEmail();
}

Future<void> signUpUser() async {
  /// 注册用户
  const emailAddress = 'akandepeter@gmail.com';
  const firstName = 'Peter';
  const lastName = 'Akande';
  const password = 'Password'; // 可选，取决于项目设置

  final signUpResponse = await Authivate.instance.signUpUser(
    emailAddress: emailAddress,
    lastName: lastName,
    firstName: firstName,
    password: password,
  );

  if (signUpResponse.isLeft()) {
    // 发生错误
    log(signUpResponse.failureMessage);
    return;
  }

  // 用户成功注册
  log(signUpResponse.successResponse.toString());

  /// 响应
  /// {message: Email Sent!,
  ///  user_record: {
  ///    email_address: akandepeter@gmail.com,
  ///    is_verified: false,
  ///    date_created: 2023-11-11T11:12:48.293571Z,
  ///    first_name: Peter,
  ///    last_name: Akande,
  ///    user_unique_id: dp.ldcaopaggcapepaom
  ///    }
  /// }
}

Future<void> signInUser() async {
  /// 登录用户
  const emailAddress = 'akandepeter@gmail.com';
  const password = 'Password'; // 可选，取决于项目设置

  final signInResponse = await Authivate.instance.signInUser(
    emailAddress: emailAddress,
    password: password,
  );

  if (signInResponse.isLeft()) {
    // 发生错误
    log(signInResponse.failureMessage);
    return;
  }

  // 用户成功登录
  log(signInResponse.successResponse.toString());

  /// 响应
  /// {
  ///  user_record: {
  ///    email_address: akandepeter@gmail.com,
  ///    is_verified: false,
  ///    date_created: 2023-11-11T11:12:48.293571Z,
  ///    first_name: Peter,
  ///    last_name: Akande,
  ///    user_unique_id: dp.ldcaopaggcapepaom
  ///    }
  /// }
}

Future<void> sendConfirmAccountEmail() async {
  /// 发送确认密码邮件
  const emailAddress = 'akandepeter@gmail.com';

  final confirmAccountEmailResponse =
      await Authivate.instance.requestOTPForUser(
    emailAddress: emailAddress,
  );

  if (confirmAccountEmailResponse.isLeft()) {
    // 发生错误
    log(confirmAccountEmailResponse.failureMessage);
    return;
  }

  // 发送确认密码邮件
  log(confirmAccountEmailResponse.successResponse.toString());

  /// 响应
  /// {{message: Email Sent Successfully}}
}

Future<void> sendForgotPasswordEmail() async {
  /// 发送忘记密码邮件
  const emailAddress = 'akandepeter@gmail.com';

  final forgotPasswordResponse =
      await Authivate.instance.requestForgotPasswordForUser(
    emailAddress: emailAddress,
  );

  if (forgotPasswordResponse.isLeft()) {
    // 发生错误
    log(forgotPasswordResponse.failureMessage);
    return;
  }

  // 忘记密码邮件发送成功
  log(forgotPasswordResponse.successResponse.toString());

  /// 响应
  /// {message: Forgot Password Email Sent!}
}