掌上意见箱快速入门指南

概述

掌上意见箱是一个智能意见收集与管理平台，旨在为开发者提供一套完整的API和SDK，以便快速将意见收集功能集成到各类应用（如App、小程序、Web网站）中。平台支持多渠道收集、智能分类、数据分析与可视化报表。

核心概念

在开始集成前，请了解以下核心概念：

意见箱：一个独立的收集单元，对应一个项目或场景。
渠道：意见的收集入口，如应用内嵌页面、二维码、API接口。
意见：用户提交的单条反馈，包含文本、图片、标签等信息。
智能分类：平台基于NLP算法对意见进行自动打标与归类。

准备工作

注册账号：访问掌上意见箱官网，完成企业/开发者注册。
创建意见箱：在控制台创建一个意见箱，获取唯一的 box_id。
获取API密钥：在控制台生成您的 api_key 和 api_secret，用于身份验证。

快速集成

1. 使用JavaScript SDK（Web端）

将以下脚本添加到您的HTML页面中，即可快速嵌入一个意见收集浮窗。

<script>
  (function(b,o,x){window.PalmFeedback=function(c){window.PalmFeedback._.push(c)};window.PalmFeedback._=[];
  var s=o.createElement('script');s.async=1;s.src='https://cdn.palmfeedback.com/sdk/v1.js';
  var h=o.getElementsByTagName('script')[0];h.parentNode.insertBefore(s,h);
  })(window,document);
  PalmFeedback({
    boxId: 'YOUR_BOX_ID', // 替换为您的意见箱ID
    position: 'bottom-right',
    theme: 'light'
  });
</script>

2. 调用核心API（提交意见）

您也可以通过后端直接调用我们的REST API来提交意见。

API端点

POST https://api.palmfeedback.com/v1/opinions

请求头

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

请求体示例

{
  "box_id": "your_box_id_here",
  "content": "产品搜索功能响应较慢，建议优化。",
  "contact": "user@example.com",
  "metadata": {
    "page_url": "https://example.com/search",
    "app_version": "2.1.0"
  }
}

成功响应

{
  "code": 0,
  "msg": "success",
  "data": {
    "opinion_id": "opn_abc123def456"
  }
}

获取与管理意见

查询意见列表API

GET https://api.palmfeedback.com/v1/boxes/{box_id}/opinions?status=pending&limit=10

在控制台管理

登录掌上意见箱控制台，您可以：

查看所有渠道的实时意见流。
使用智能分类仪表盘分析反馈趋势。
对意见进行回复、标记状态或分配给团队成员处理。

示例项目

我们提供了一个完整的示例项目，演示了从前端收集到后端处理的全流程。

GitHub仓库：https://github.com/palmfeedback/quickstart-demo
包含：前端（Vue.js）组件、后端（Node.js）服务及配置说明。

下一步

阅读[高级配置文档]了解自定义主题、多渠道配置与Webhook设置。
查看[API完整参考]获取所有接口的详细说明。
如需帮助，请通过官网联系我们的技术支持。

本文档对应掌上意见箱 API 版本 v1. 最后更新日期：2023-10-27