01 / 三种整合方式
阅读、接收和询问。
使用一个、两个或全部三个。他们都尊重拥有密钥的公司的权限和数据。
休息API
JSON 格式的潜在客户、谈判、付款、对象和指标以及 OpenAPI 文档。
网络钩子
18 公司活动通过订阅立即发送到您的系统。
人工智能助手(MCP)
将 Cyzyra 连接到兼容 MCP 的 AI 助手,并询问销售、广告和利润。
02 / 休息API
端点
认证方式 授权:持票人, 、JSON 响应和光标分页。
- 每个键每分钟 120 个请求
- 密钥仅存储为哈希值
- GET
/api/v1/leads列出并搜索潜在客户 - POST
/api/v1/leads创建潜在客户(带重复检查) - GET
/api/v1/leads/{id}提供详细信息的线索 - PATCH
/api/v1/leads/{id}更新潜在客户 - GET
/api/v1/deals谈判和漏斗阶段 - POST
/api/v1/deals创建交易 - GET
/api/v1/payments帐单和付款 - GET
/api/v1/objects您的对象类型 - GET
/api/v1/objects/{type}/records对象类型的记录 - POST
/api/v1/objects/{type}/records创建记录 - POST
/api/v1/query带有过滤器和周期的指标 - POST
/api/v1/ask关于数据的葡萄牙语问题
03 / 网络钩子
它发生在公司,它到达了你的系统。
选择活动和地址。每次提交都会进行签名,失败的最多可重新发送 5 次。
- 带时间的 HMAC 签名,防止重发
- 仪表板上每次尝试的历史记录
// Cabeçalho: X-Cyzyra-Signature: t=1731000000,v1=<hmac>
const [t, v1] = header.split(",").map((p) => p.split("=")[1]);
const esperado = hmacSha256(segredo, `${t}.${corpoBruto}`);
if (esperado !== v1) throw new Error("assinatura inválida");18 可用的事件
- Lead criado
lead.created - Status do lead mudou
lead.status_changed - Cadastros unificados
lead.merged - Negociação criada
deal.created - Negociação mudou de etapa
deal.stage_changed - Venda ganha
deal.won - Venda perdida
deal.lost - 已发送提案
proposal.sent - 提案被接受
proposal.accepted - Proposta recusada
proposal.rejected - 合同已发送
contract.sent - Contrato assinado
contract.signed - 电荷已创建
payment.created - Pagamento recebido
payment.paid - Pagamento falhou
payment.failed - Pagamento estornado
payment.refunded - Ordem de serviço criada
work_order.created - Mensagem recebida
message.received
04 / 人工智能助手
从您的助手内部询问 Cyzyra。
使用您的 API 密钥将 Cyzyra 的 MCP 地址添加为兼容的 AI 助手中的自定义连接器。他开始咨询利润、营销活动和销售,并用葡萄牙语回答有关他的数据的问题。
URL:https://SEU-PAINEL/api/mcp 标头:授权:Bearer cy_live_... 工具:summary_profit·campaigns·sales Ask·manage_campaigns(写作)在哪里创建 API 密钥?+
在 API 平台仪表板中(菜单系统 → API 平台 → API 密钥)。密钥仅出现一次; Cyzyra 仅保留其加密版本。
密钥可以拥有哪些权限?+
阅读,或者说阅读和写作。通过 MCP 连接创建潜在客户或更改营销活动等操作需要写入权限。
有使用限制吗?+
是:每个键每分钟 120 个请求。除此之外,API 会响应 429 并告诉您重试的秒数。
如果 Webhook 失效时我的系统宕机了怎么办?+
Cyzyra 最多重试 5 次,间隔时间不断增加,并在仪表板上显示每次尝试。
每个键看到谁的数据?+
仅来自创建密钥的公司。其他公司的数据永远不会出现。
说明性示例
