开发者集成

7stamp REST API

可用

7stamp Integration API 让CRM、电子商务平台、POS、自定义后端或自动化工具管理钱包带有您自己的系统已使用的联系人标识符的会员卡。当不存在专门的集成时,它是通用选项。

API 基数 URL 是 https://api.7loc.com/cards-api. 使用 API 密钥作为 Bearer 令牌对每个请求进行身份验证。在构建生产逻辑之前,请使用链接的 OpenAPI 参考来获取实时请求和响应模式。

您可以用 API

做什么API 是集成堆栈的写入端。当您自己的软件需要保持操作事实来源时,请使用它,而 7stamp 处理钱包忠诚度层。

从您自己的软件发卡

为系统中的任何客户生成个人钱包卡链接。通过您自己的电子邮件、SMS、推送或应用内流程交付。客户打开链接并将卡保存到Apple Wallet或Google Wallet。

来自任何来源的信用印章

当在您的自定义 POS 中完成购买时,当在您的网站上支付在线订单时,或者当您的预订系统中完成服务时,请致电 API 获取信用印章。该卡会在几秒钟内更新。

管理优惠券和活动

向特定客户发放一次性优惠券,创建活动就绪的奖励流,并将优惠券状态拉回到处理财务和服务质量的系统中。

记录集成API操作

这些是公共API背后的路线Make 和 Zapier 操作。阅读 API 参考文献中的确切架构;不要从不同的端点推断字段名称。

卡片 POST /cards/invite

创建卡片邀请

为外部联系人创建全新的个人安装 URL。

卡片 POST /cards/invite/bulk

批量创建卡片邀请

在受控批次中创建最多 100 个邀请链接。

卡片 GET /cards

查找卡片

通过外部联系人标识符查找卡片记录。

卡片 GET /cards/{user_card_id}

获取卡片详细信息

通过其内部7stampID返回一张卡片的完整状态。

卡片 POST /cards/scan

扫描卡片

按卡片 ID 或 External ID 添加印章,并在提供时记录源订单。

模板 GET /templates

列表模板

列出钥匙工作场所可用的卡片模板/profile.

模板 GET /templates/{template_id}/design

获取模板设计

读取已知卡片的视觉设置模板。

优惠券 POST /vouchers/issue

发放优惠券

向持卡人发放优惠券。

消息 POST /messages/send

发送消息

向卡所有者发送钱包卡推送和 /or 电子邮件内容。

在哪里创建和复制 API 键

这些是真实的 7stamp Admin 屏幕。打开 API 和集成,添加密钥,然后将其复制到安全的服务器端机密或自动化连接中。

7stamp Admin API & 集成屏幕,显示 Add API Key 按钮和生成 API 密钥对话框
步骤 1 — 在左侧导航中选择 API & 集成,打开API Keys,选择Add API Key,选择合适的员工登录,并生成密钥。
7stamp Admin 对话框显示新生成的 API 密钥及其复制控件
步骤 2 — 将新密钥复制到密码管理器、服务器端机密或安全 Make/Zapier 连接中。请勿将其粘贴到源代码、浏览器应用程序或支持票证中。

编码前需要做出的三个决定

API 密钥范围

在API Integrations → API KeysAdd API Key下的7stamp Admin中创建密钥。一把密钥属于一个工作场所/profile,因此,当您的帐户设置允许时,请为开发和生产创建单独的密钥。如果秘密泄露,请轮换或撤销仪表板的访问权限。

客户身份

External ID 是系统中的稳定联系人标识符:CRM ID、客户 UUID、电话号码或电子邮件。更喜欢不可变的系统ID。可以选择添加 External Source 以避免跨系统冲突并使 Webhook 关联显式化。

模板选择

当配置文件有一个活动模板时,template_id 可以省略,7stamp 自动选择它。当它有多个活动模板时,传递预期的template_id。首先阅读GET/templates,而不是硬编码猜测的ID。

最小身份验证请求:创建邀请

将其复制到您的自动化步骤中 bash
curl -X POST "https://api.7loc.com/cards-api/cards/invite" \
  -H "Authorization: Bearer YOUR_7STAMP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "crm_contact_8821",
    "external_source": "hubspot",
    "template_id": 42
  }'

从 API 密钥到第一个成功请求

01

登录到 7stamp Admin 并创建密钥:API Integrations → API KeysAdd API Key。将其存储在您的秘密管理器中,而不是源代码或客户端应用程序中。

02

将基数 URL 设置为 https://api.7loc.com/cards-api 并添加 Authorization: Bearer,后跟每个服务器端请求的密钥。

03

先拨打GET/templates。成功的响应会确认令牌并显示可用于该工作场所的模板/profile.

04

从您自己的系统中选择稳定的External ID和可选的External Source。在创建、扫描、查找和 Webhook 逻辑中使用完全相同的身份对。

05

Call POST /cards/invite with a disposable test contact. Verify the returned install URL before automating delivery to real customers.

06

添加POST/cards/scan、凭证或消息操作。

使用API参考作为合约

公共 Swagger/OpenAPI 引用包含当前端点、参数、请求正文、响应和 Webhook 架构。交互式的URL是https://api.7loc.com/cards-api/docs,机器可读的合约是https://api.7loc.com/cards-api/openapi.json.,在实现错误处理或添加可选字段之前阅读它。

身份验证和密钥安全

密钥是服务器端秘密。请勿在浏览器 JavaScript、移动应用程序包、公共表单、屏幕截图、Make/Zapier 文本字段或支持票证中公开它。使用服务器、安全自动化连接或秘密管理器。如果密钥被意外共享,请在7stamp Admin中撤销或轮换它并更新受影响的连接。

常见问题

我在哪里可以获得 7stamp API 代币?

在7stamp Admin,转到API Integrations → API Keys → Add API Key。然后,令牌在 Authorization 标头中作为 Bearer 发送,后跟密钥。

URL的基数和认证方式是什么?对于每个授权请求,

使用https://api.7loc.com/cards-api并发送Authorization:BearerYOUR_7STAMP_API_KEY。

什么时候可以省略template_id?

仅当连接的配置文件只有一个活动卡片模板时。如果多个模板处于活动状态,请从 GET /templates.

Should I use the API, Make, or Zapier?

使用 API 进行自定义 POS、后端、站点或完全控制。使用 Make 用于视觉分支场景。使用 Zapier 实现大部分线性触发操作工作流程。这三个都依赖于相同的API密钥和API合约。

下一步

先测试最小安全API流量

创建密钥,调用 GET /templates,为一次性联系人创建一个邀请,然后围绕经过验证的请求添加生产机密、日志记录、重试和 Webhook 处理。