API Reference

表单处理

Smile Flip 是一款强大且灵活的无代码用户旅程构建工具，旨在帮助您快速将旧有的纸质表单转换为用户可在任何地方访问的数字表单，从而安全地与您的组织共享数据。

通过开发者门户内直观的用户界面，您可以通过为旅程的每个步骤添加屏幕或页面，轻松从头设计用户旅程。这使您能够直接从用户处收集数据，并通过 Wink Widget获取其他共享信息。强大的路由功能允许您根据用户输入和表单状态将用户引导至特定屏幕，实现对用户旅程的完全控制。

Smile Flip 当前处于 Alpha 阶段。

Checklist

集成步骤

虽然 Smile 的表单处理服务允许您无需编码即可设计用户旅程并发布，但它也足够灵活，只需几个技术步骤即可轻松嵌入现有系统并检索数据，实现与您自有网络的无缝集成。

无代码解决方案

以下是无需编码即可快速开始使用 Smile Flip 的步骤：

  1. 在 Smile 开发者门户中创建 Flip 站点

    登录您的 Smile 开发者门户账户并创建 Flip 站点。每个新创建的 Flip 站点都有一个初始屏幕，您可以根据需要修改或删除。您可以执行以下操作：

    1. 为用户旅程的每个步骤添加、编辑或删除屏幕：
      • 表单屏幕允许您添加任意数量的表单字段以直接从用户处获取数据。
      • Wink 屏幕允许您在用户旅程中直接嵌入任意数量的 Wink Widget。
    2. 在表单屏幕内添加、编辑或删除表单字段。
    3. 根据用户输入将其引导至不同屏幕。
    4. 指定用户完成 Flip 站点所有屏幕后的操作。

  2. 保存并发布 Flip 站点，向用户提供访问权限

    完成 Flip 站点配置后，您可以点击“复制 URL”按钮将站点 URL 复制到剪贴板。直接使用此 URL 并分享给用户，以便他们开始向您提交申请或信息。
    无需编码即可分享信息的常见后续步骤是使用二维码按需引导用户访问 Flip 站点。

  3. 检索用户数据

    用户完成 Flip 站点表单后，您可在 60 天内通过开发者门户轻松访问他们的数据。您可以在线查看或下载响应以进行离线存储。

系统集成

Smile 的用户旅程和表单处理工具还允许您根据组织的技术能力，更自由地嵌入用户旅程并检索数据：

  • 嵌入 Flip 站点 - 您可以将 Flip 站点嵌入到您的应用或网站中，为用户提供无缝体验。点击按钮或链接后在嵌入式框架中显示 Flip 站点，提交最后一个屏幕后无缝返回您的网站或应用。
  • 通过 API 检索用户数据 - 您可以使用 /forms 端点直接从 Smile 开放 API 检索用户数据。
  • 为用户数据附加唯一 ID - 每个完成的表单都会附加一个唯一的 Smile 用户 ID，您可以将其存储在自己的系统中，以便随时检索表单数据。您也可以通过传递变量传入自有系统的唯一 ID，便于后续与用户数据关联。

Storage

维护用户数据

Smile API 仅在以下情况之一发生前存储用户数据：

  1. 用户通过 Wink Widget撤销对其数据的访问权限
  2. 通过撤销 API 撤销访问权限（即由开发者发起）
  3. 自文档上传之日起已过去 60 天

为确保在最长 60 天期限后仍能持续访问数据，请确保在自有服务器上检索并存储用户数据。一旦从 Smile 服务器检索到数据，您可以使用撤销 API 指示 Smile 删除该数据。当用户手动撤销数据共享时，您还将收到 Smile 发出的事件通知。

Versioning

版本管理

当前处于 Alpha 阶段的 Flip 站点版本包含许多用户体验和功能改进，是推荐使用的版本。

重命名前的 Flip 站点初始版本为 Wink Site，其最后一个维护版本是 Version 2，支持在向用户显示 Wink Widget前后自定义着陆页和结果页。

Wink Site v2 仍会得到维护，并且会继续进行安全监控、更新和打补丁。