叶动文档中心叶动文档中心
叶动官网
使用指南
接口文档
  • 简体中文
  • English
GitHub
叶动官网
使用指南
接口文档
  • 简体中文
  • English
GitHub
  • 🌏 使用指南

    • 叶动历史小记
    • AutoBox 快速入门指南
    • API_KEY 客户端配置指南
    • 版本发布
    • 设计开发指南

AutoBox 快速入门指南

欢迎使用 AutoBox

AutoBox 是一个强大的 AI 任务执行平台,提供了完整的前端管理界面和 API 接口。本指南将帮助您快速了解系统的注册、登录流程以及主要功能。

系统概述

AutoBox 叶动API开放平台为用户提供:

  • 🤖 多种 AI 任务类型支持(AutoBox、n8n、Dify、Coze)
  • 🔑 灵活的 API Key 管理系统
  • 📊 实时的任务监控和日志查看
  • 💰 透明的计费和余额管理
  • 🛡️ 安全的用户认证和权限控制

前端注册流程

1. 访问注册页面

打开浏览器,访问 AutoBox 平台:https://your-domain.com

您将看到登录/注册界面,点击"注册新账户"切换到注册模式。

2. 填写注册信息

注册需要提供以下信息:

必填信息

  • 手机号码: 用于接收验证码和重要通知

    • 格式:中国大陆手机号(11位数字)
    • 示例:13812345678
  • 邮箱地址: 用于账户验证和重要通知

    • 格式:有效的邮箱地址
    • 示例:user@example.com

验证流程

  1. 输入手机号和邮箱后,点击"获取验证码"
  2. 系统将向您的邮箱发送6位数字验证码
  3. 在60秒内输入收到的验证码
  4. 点击"注册"完成账户创建

3. 注册成功

注册成功后,系统会:

  • 自动生成用户账户
  • 分配初始用户权限
  • 设置账户有效期
  • 生成用户登录 Token

注意事项:

  • 每个手机号和邮箱只能注册一个账户
  • 验证码有效期为10分钟
  • 注册后账户默认有效期为1年

前端登录流程

1. 选择登录方式

AutoBox 支持短信验证码登录,无需记忆密码:

短信验证码登录

  1. 在登录页面输入已注册的手机号
  2. 点击"获取验证码"按钮
  3. 系统将发送6位验证码到您的手机
  4. 输入验证码并点击"登录"

2. 验证码获取

  • 发送频率: 每60秒可重新获取一次
  • 有效时间: 验证码10分钟内有效
  • 重试机制: 验证码错误可重新输入

3. 登录成功

登录成功后,系统会:

  • 验证用户状态和有效期
  • 生成会话 Token(7天有效期)
  • 自动跳转到工作台页面
  • 保存登录状态(支持自动登录)

系统主要功能介绍

1. 工作台 Dashboard

登录后的首页,提供系统概览:

数据统计

  • API 调用统计: 今日、本周、本月的调用次数
  • 任务执行统计: 成功、失败、进行中的任务数量
  • 余额信息: 当前账户余额和消费情况
  • API Key 统计: 已创建的 API Key 数量和状态

快速操作

  • 创建新的 API Key
  • 查看最近的任务日志
  • 快速充值余额
  • 查看系统公告

图表展示

  • 调用量趋势图
  • 成功率统计
  • 消费趋势分析
  • 任务类型分布

2. API Key 管理

核心功能模块,用于管理您的 API 密钥:

创建 API Key

  1. 点击"创建新密钥"按钮
  2. 填写密钥信息:
    • 名称: 便于识别的描述性名称
    • 渠道: 选择服务渠道(OpenAI、Claude等)
    • 分组: 设置分组标识
    • 配额: 设置使用额度限制(可选)
    • 过期时间: 设置过期日期(可选)
    • 备注: 添加使用说明(可选)
  3. 点击"创建"生成 API Key

管理功能

  • 查看列表: 显示所有 API Key 及其状态
  • 编辑信息: 修改名称、配额、状态等
  • 复制密钥: 一键复制 API Key 到剪贴板
  • 删除密钥: 删除不再使用的 API Key
  • 筛选搜索: 按渠道、状态、名称筛选

状态说明

  • 启用: API Key 正常可用
  • 禁用: 暂时停用,可重新启用
  • 过期: 超过有效期,需要更新

3. 任务日志

监控和查看 API 调用的执行情况:

任务列表

  • 任务编号: 唯一的任务标识符
  • 任务类型: AutoBox、n8n、Dify、Coze
  • 执行状态: 等待中、执行中、已完成、已报错
  • 创建时间: 任务提交时间
  • 执行时长: 任务处理耗时
  • 消费金额: 本次调用的费用

详细信息

  • 请求参数: 查看完整的请求内容
  • 响应结果: 查看任务执行结果
  • 错误信息: 失败任务的错误详情
  • 执行进度: 异步任务的实时进度

筛选和搜索

  • 按时间范围筛选
  • 按任务状态筛选
  • 按任务类型筛选
  • 按任务编号搜索

4. 计费日志

查看详细的费用消费记录:

消费记录

  • 消费时间: 具体的扣费时间
  • 消费类型: API调用、充值、退款等
  • 消费金额: 本次消费的具体金额
  • 余额变化: 消费前后的余额对比
  • 关联任务: 对应的任务编号

统计分析

  • 日消费统计
  • 月消费趋势
  • 按服务类型分类统计
  • 消费排行榜

5. 余额充值

管理账户余额和充值:

充值方式

  • 在线支付: 支持微信、支付宝
  • 银行转账: 企业用户可选择银行转账
  • 充值卡: 使用预付费充值卡

充值套餐

  • 不同金额的充值套餐
  • 大额充值享受折扣优惠
  • 企业用户专属套餐

充值记录

  • 查看历史充值记录
  • 充值状态跟踪
  • 发票申请和下载

6. 订单中心

管理所有的订单信息:

订单类型

  • 充值订单: 余额充值相关订单
  • 服务订单: API 服务购买订单
  • 套餐订单: 包月/包年服务订单

订单状态

  • 待支付: 订单已创建,等待支付
  • 已支付: 支付成功,服务已激活
  • 已取消: 订单被取消
  • 已退款: 订单已退款

订单操作

  • 查看订单详情
  • 重新支付未完成订单
  • 申请退款
  • 下载发票

7. 个人设置

管理个人账户信息和系统设置:

基本信息

  • 手机号码: 查看和修改绑定手机
  • 邮箱地址: 查看和修改绑定邮箱
  • 用户名称: 设置显示名称
  • 头像设置: 上传个人头像

安全设置

  • 修改密码: 通过验证码修改登录密码
  • 刷新Token: 重新生成登录令牌
  • 登录日志: 查看账户登录记录
  • 安全提醒: 设置安全通知

权限信息

  • 用户等级: 查看当前用户等级
  • 权限范围: 查看可用功能权限
  • 使用限制: 查看并发和频率限制
  • 有效期: 查看账户有效期

界面导航

1. 顶部导航栏

  • Logo: 点击返回工作台
  • 用户头像: 显示用户信息和快速操作菜单
  • 通知中心: 查看系统通知和消息
  • 帮助中心: 访问文档和支持

2. 侧边栏菜单

  • 工作台: 系统概览和统计
  • API Key: 密钥管理
  • 任务日志: 调用记录查看
  • 计费日志: 消费记录查看
  • 余额充值: 账户充值管理
  • 订单中心: 订单管理
  • 个人设置: 账户设置

3. 响应式设计

  • 桌面端: 完整的侧边栏和多列布局
  • 平板端: 可折叠的侧边栏
  • 手机端: 汉堡菜单和单列布局

快速开始使用

第一步:注册并登录

  1. 使用手机号和邮箱注册账户
  2. 通过短信验证码登录系统

第二步:创建 API Key

  1. 进入"API Key 管理"页面
  2. 点击"创建新密钥"
  3. 填写必要信息并保存
  4. 复制生成的 API Key

第三步:充值余额

  1. 进入"余额充值"页面
  2. 选择合适的充值金额
  3. 完成支付流程

第四步:开始调用 API

  1. 使用创建的 API Key 调用接口
  2. 在"任务日志"中查看执行情况
  3. 在"计费日志"中查看消费记录

常见问题

1. 注册相关

Q: 收不到验证码怎么办? A: 请检查邮箱垃圾邮件文件夹,或稍后重试。如仍有问题请联系客服。

Q: 手机号已被注册怎么办? A: 每个手机号只能注册一个账户,如忘记账户信息请联系客服找回。

2. 登录相关

Q: 登录后自动退出怎么办? A: 可能是 Token 过期,请重新登录。Token 有效期为7天。

Q: 忘记绑定的手机号怎么办? A: 请联系客服,提供注册时的邮箱地址进行账户找回。

3. 功能使用

Q: API Key 创建后无法使用? A: 请检查 API Key 状态是否为"启用",账户余额是否充足。

Q: 任务执行失败怎么办? A: 查看任务日志中的错误信息,根据错误码进行相应处理。

技术支持

如果您在使用过程中遇到问题,可以通过以下方式获取帮助:

1. 在线帮助

  • 文档中心: 查看详细的 API 文档和使用指南
  • FAQ: 查看常见问题解答
  • 视频教程: 观看操作演示视频

2. 联系客服

  • 邮箱支持: support@AutoBox.com
  • 在线客服: 工作时间 9:00-18:00
  • 技术交流群: 加入用户交流群

3. 反馈建议

  • 功能建议: 通过系统内反馈功能提交
  • Bug 报告: 详细描述问题并提供复现步骤
  • 用户调研: 参与产品改进调研

下一步

完成快速入门后,建议您:

  1. 深入了解 API: 阅读 API 使用概述
  2. 学习认证机制: 查看 API_KEY 认证指南
  3. 掌握错误处理: 了解 错误码参考
  4. 参考实际案例: 学习 API 调用示例
  5. 配置客户端: 查看 配置指南

欢迎使用 叶动智能AutoBox 平台,祝您使用愉快!

在 GitHub 上编辑此页
Prev
叶动历史小记
Next
API_KEY 客户端配置指南