开发者平台

通过清晰的 API、可预测的事件和面向严肃生产工作负载设计的基础设施，把客户通信和身份验证能力集成到您的产品中。

应用工作流可使用 REST API，适合的企业短信连接可使用 SMPP 3.4，并通过签名 Webhook 让系统与消息、入站活动和验证事件保持同步。

开发者支持探索平台

能够融入您现有系统的开发者平台。

应用驱动工作流使用 REST API；在需要持续短信吞吐和电信级连接时使用 SMPP 3.4；通过事件驱动 Webhook 与投递、入站和验证活动保持同步。

REST API

通过 HTTPS 传输的版本化 JSON 接口，用于消息、验证、联系人、模板、Webhook、用量和账户资源。

版本化资源路径
Bearer 身份验证
幂等写请求
结构化错误响应

SMPP 3.4

面向受益于持久绑定、电信级吞吐控制和投递回执处理的企业短信工作负载。

收发一体、发送和接收绑定
submit_sm 与 deliver_sm 工作流
投递回执与消息状态
吞吐与连接控制

Webhook 与事件

接收投递、入站通信、验证、账户和工作流活动的异步生命周期事件。

签名事件载荷
投递与入站事件
安全重试处理
用于去重的事件 ID

身份验证与凭据

使用环境范围凭据和最小权限访问模式，让应用只获得真正需要的能力。

作用域 API 凭据
测试与生产隔离
密钥轮换模式
服务器端密钥处理

设计可安全重试的请求。

网络故障和超时是分布式系统的正常情况。Zayloft 的集成模式使用幂等性、稳定请求标识符和明确事件状态，使应用能够恢复，而不是盲目重复客户操作。

幂等性

为符合条件的写请求附加唯一键，使重试能够被识别，而不是产生非预期重复操作。

关联追踪

使用稳定的应用和请求标识符，在您的系统、Zayloft 以及下游投递事件之间追踪工作。

超时处理

在能够安全确认请求状态前，应将传输超时视为结果未知。

事件对账

使用持久标识符将异步投递和入站事件与您自己的记录核对。

为应用团队提供干净的 API 表面。

以下示例使用环境变量指定 API 基础 URL，因此部署可以指向账户配置的主机名和版本。

请求示例

curl "https://zayloft.com/api/v1/jobs" \
  -H "Authorization: Bearer $ZAYLOFT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 8f36c1f0-8e7d-4d9d-a342-7aef0c2d45c2" \
  -d '{
    "service": "sms",
    "country": "US",
    "traffic_class": "transactional",
    "destination": "+14155550123",
    "content": "Your order update is ready."
  }'

凭据必须保留在服务器端。绝不要把 API 密钥嵌入浏览器 JavaScript、公开代码仓库或移动应用包中。

清晰事件，更容易调试。

应用不应仅凭一次同步响应推断消息状态。投递、入站和验证事件提供了核对客户工作流所需的状态变化。

已接受

平台已接受有效请求进行处理。

已发送

消息已通过配置的投递路径继续处理。

已送达

在渠道提供确认的情况下，已收到下游投递确认。

失败

操作未能完成，并返回适合应用处理的结构化原因。

入站

来自客户的消息或渠道事件已可供您的应用使用。

已验证

验证工作流已按照配置的方法成功完成。

用于评估、集成和运营的开发者资源。

从所需的集成界面开始，随着实现增长，再逐步使用契约、环境、日志、Webhook 检查和用量可见性。

OpenAPI 契约

机器可读 API 定义支持文档、验证和 SDK 生成工作流。

测试环境

将开发与生产凭据、数据和应用行为分离。

请求日志

追踪请求 ID、响应状态和重要元数据，同时不向普通用户暴露敏感供应商内部信息。

Webhook 检查

诊断集成行为时，可检查投递尝试、事件 ID、签名和重试历史。

用量可见性

利用组织和项目边界追踪 API 活动、消息量和账户消耗。

服务状态感知

利用服务健康信息和应用侧韧性模式减少可避免的中断。

安全必须进入集成设计。

Zayloft 开发者集成应把密钥保留在服务器端、验证 Webhook 真实性、隔离租户与环境、限制凭据作用域，并记录重要管理操作。

密钥隔离

在受保护的服务器配置中存储 API 密钥、SMPP 凭据和 Webhook 密钥。

Webhook 验证

在信任事件内容或触发下游操作前验证签名载荷。

最小权限

只向应用颁发其所需作用域、项目和环境的凭据。

租户边界

在请求处理和资源访问全过程中保持组织与项目数据隔离。

可审计性

记录关键管理和凭据事件，确保运营责任可追溯。

传输保护

公共 API 传输使用现代 TLS，并为受支持的持久协议连接使用安全通道。

常见问题

构建让应用能够理解和推理的通信基础设施。

通过可预测请求、作用域凭据、异步事件和运营可见性，把 Zayloft 连接到工程团队已经在运行的系统。

开发者支持创建账户

如有 API、SMPP、Webhook 或技术集成问题，请联系 support@zayloft.com。