Flutter集成Snipe IT资产管理插件snipe_sdk_flutter的使用

简介

欢迎来到SnipeSDK文档！SnipeSDK是一个Dart库，提供了与Snipe API交互的便捷方式，用于令牌管理、事件跟踪和其他相关功能。本文档将引导你完成SnipeSDK的设置、可用方法及其使用示例。

开始使用

安装

要在你的Dart项目中使用SnipeSDK，请在pubspec.yaml文件中添加以下依赖项：

dependencies:
  snipe_sdk_flutter: ^0.0.1

然后运行以下命令：

flutter pub get

或者：

flutter pub add snipe_sdk_flutter

初始化

在使用SnipeSDK之前，你需要使用init方法初始化它，并提供你的API密钥：

import 'package:snipe_sdk_flutter/snipe_sdk_flutter.dart';

void main() {
  SnipeSdk snipeSdk = SnipeSdk();
  snipeSdk.init("your_api_key_here");
}

方法

1. signUp(String hash)

此方法允许你使用给定的哈希注册用户：

try {
  String output = await snipeSdk.signUp("user_hash");
  print("Sign up response: $output");
} catch (error) {
  print("Error: $error");
}

2. trackEvent(...)

此方法允许你使用各种参数（如eventId、snipeId、transactionAmount、partialPercentage和debitTokens）跟踪事件：

try {
  dynamic response = await snipeSdk.trackEvent(
    eventId: "event_id",
    snipeId: "user_snipe_id",
    transactionAmount: 100,
    partialPercentage: 50,
    debitTokens: [{"token_id": "token1", "value": 20}],
  );
  print("Track event response: $response");
} catch (error) {
  print("Error: $error");
}

3. getTokenHistory(String snipeId)

此方法检索特定用户的令牌历史记录：

try {
  dynamic response = await snipeSdk.getTokenHistory("user_snipe_id");
  print("Token history response: $response");
} catch (error) {
  print("Error: $error");
}

4. getTokenDetails(String snipeId)

此方法检索特定用户关联的所有令牌的详细信息：

try {
  dynamic response = await snipeSdk.getTokenDetails("user_snipe_id");
  print("Token details response: $response");
} catch (error) {
  print("Error: $error");
}

5. getCoinData(String snipeId)

此方法检索特定用户的币数据：

try {
  dynamic response = await snipeSdk.getCoinData("user_snipe_id");
  print("Coin data response: $response");
} catch (error) {
  print("Error: $error");
}

6. getStreaks(String snipeId)

此方法检索特定用户的连胜数据：

try {
  dynamic response = await snipeSdk.getStreaks("user_snipe_id");
  print("Streaks response: $response");
} catch (error) {
  print("Error: $error");
}

结论

恭喜！你已成功将SnipeSDK集成到你的Dart项目中。本文档应该能帮助你利用可用的方法并理解其参数。如果你遇到任何问题或有进一步的问题，请随时联系Snipe支持团队。祝你编程愉快！

示例代码

以下是完整的示例代码：

import 'dart:developer';

import 'package:flutter/material.dart';
import 'package:snipe_sdk_flutter/snipe_sdk_flutter.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      debugShowCheckedModeBanner: false,
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Snipe SDK'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  SnipeSdk snipeSdk = SnipeSdk();

  [@override](/user/override)
  void initState() {
    super.initState();
    snipeSdk.init("dev_MTYyNjFlOWUtNmUyZS00ZTU2LTg5MGQtZDVlNzVjMjI3YWE1");
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            ElevatedButton(
              onPressed: () async {
                dynamic output = await snipeSdk.signUp("hellooootestt");
                log(output.toString());
              },
              child: const Text("SignUp"),
            ),
            ElevatedButton(
              onPressed: () async {
                try {
                  dynamic output = await snipeSdk.trackEvent(
                    eventId: "65437910a3c7c15ec19e27e8",
                    transactionAmount: 100,
                    snipeId: "65488b5eb10d88684b090833",
                  );
                  log(output.toString());
                } catch (e) {
                  log(e.toString());
                }
              },
              child: const Text("Track Event"),
            ),
            ElevatedButton(
              onPressed: () async {
                dynamic output = await snipeSdk
                    .getTokenHistory("65488b5eb10d88684b090833");
                log(output.toString());
              },
              child: const Text("Token History"),
            ),
            ElevatedButton(
              onPressed: () async {
                dynamic output = await snipeSdk
                    .getTokenDetails("65488b5eb10d88684b090833");
                log(output.toString());
              },
              child: const Text("Token Details"),
            ),
            ElevatedButton(
              onPressed: () async {
                dynamic output = await snipeSdk
                    .getCoinData("65488b5eb10d88684b090833");
                log(output.toString());
              },
              child: const Text("Coin Data"),
            ),
            ElevatedButton(
              onPressed: () async {
                dynamic output = await snipeSdk
                    .getStreaks("65488b5eb10d88684b090833");
                log(output.toString());
              },
              child: const Text("Streaks"),
            ),
          ],
        ),
      ),
    );
  }
}