Astrify FlowsAstrify FlowsMeta Business Partner

面向开发者

用于集成 Astrify 的 REST API 与 webhook

从您的系统创建线索、发送消息、操作看板并触发 Workflow,通过 webhook 接收数据,并在流程中途调用任意 API;密钥按权限范围分配,并提供 OpenAPI 文档。

  • OpenAPI 3.1 与 Postman
  • 按权限范围分配的密钥
  • Growth 套餐起

终端

curl -X POST https://api2.astrify.com.br/v1/leads \
  -H "Authorization: Bearer astrify_7f3k…" \
  -H "Content-Type: application/json" \
  -d '{
    "nome": "Paula Mendes",
    "telefone": "+5511955550000",
    "email": "paula@email.com"
  }'

201 Created

{
  "id": "ld_8c21…",
  "nome": "Paula Mendes",
  "etapa": "Novo lead",
  "funil": "Vendas"
}
  • 128

    个 API 接口,涵盖线索、消息、看板和报价

  • 16

    种资源,每个密钥可设置读取或写入权限

  • 120

    次请求/分钟(每个密钥)

  • 20

    个每家企业的有效密钥,每个都有自己的使用记录

REST API

API 能做什么

选择资源,查看部分接口。

线索与 pipeline

创建和更新线索、合并重复项、批量导入,并记录活动和备注。pipeline 和阶段可通过 API 读取。

  • 创建、列出、更新、删除和合并线索
  • 批量导入与重复项查找
  • 交易的活动、备注、参与者和项目
  • pipeline、阶段、来源和流失原因(只读)

api2.astrify.com.br/v1

  • POST/leads
  • GET/leads
  • PATCH/leads/{lead_id}
  • POST/leads/importar-lote
  • GET/funis/{funil_id}/etapas

API 密钥

每个集成使用各自的密钥

密钥在“设置 › 开放 API”中创建,并通过 Authorization 请求头发送。密钥以创建者的身份执行操作,创建者被停用后密钥也会失效。

  • 01

    按资源设置权限范围

    每个密钥只能读取或写入您勾选的内容:线索、联系人、看板、消息等。

  • 02

    有效期与 IP

    有效期 1 至 730 天,并可设置最多 20 个授权 IP 的列表。

  • 03

    仅显示一次

    密钥仅在创建时显示一次;Astrify 只保存其签名。

  • 04

    轮换与撤销

    无需中断集成即可更换密钥,并可立即撤销,每个密钥都有使用记录。

入站 webhook

您的系统发出通知,Workflow 随即行动

“接收 webhook”触发器会为 Workflow 提供专属地址。从您的系统、n8n、Make 或 Zapier 发送 JSON,通过电子邮件或电话找到线索,然后继续流程。在监听模式下,Astrify 会显示收到的第一条数据,方便您在启用前映射字段。

  • GET、POST、PUT 和 PATCH,最大 256 KB
  • 2 分钟监听模式,查看真实发送的数据
  • 每个触发器保存最近 50 个事件
  • 每个地址每分钟最多 120 次调用

POST /api/webhooks/workflow/{token}

{
  "evento": "pagamento_aprovado",
  "cliente": {
    "nome": "João Prado",
    "email": "joao@pradoalimentos.com.br"
  },
  "valor": 1290.00
}

从 Astrify 到您的系统

两条路径,取决于您想了解什么。

在 Workflow 中

HTTP 请求与触发 webhook

任何触发器(线索更换阶段、报价被接受、订单已送达)都可以在流程中途调用您的系统,并在后续块中使用其响应。

  • GET、POST、PUT、PATCH 和 DELETE,支持请求头和 JSON 请求体
  • URL 和请求体中的线索变量
  • 将回复保存到变量,供“如果/否则”使用
  • 等待回复,或发送后继续

出站 webhook

电子邮件营销事件

在“设置 › Webhooks”中最多登记 10 个地址,即可接收每个带签名的事件,并支持重试和投递历史。

  • email.opened
  • email.clicked
  • email.replied
  • email.unsubscribed
  • email.bounced
  • email.complaint
  • email.list_joined
  • 请求头 X-Astrify-Signature 中带有 HMAC-SHA256 签名
  • 在 1 分钟、5 分钟、30 分钟、2 小时和 6 小时后重试
  • 带重发和测试按钮的历史记录

文档

OpenAPI、Postman 以及平台内的指南

OpenAPI 3.1 规范和 Postman 集合公开于 api2.astrify.com.br/v1/openapi.json 和 /v1/postman.json。在平台内,文档页面会说明每个接口的认证、权限范围、错误和示例。

工具

n8n、Make 和 Zapier,无需付费连接器

在这些工具的 HTTP 请求节点中使用您的密钥,并在“触发 webhook”块中使用它们的 webhook。

  • n8n
  • Make
  • Zapier
渠道令牌和 webhook 密钥均加密存储,平台发出的请求会屏蔽内部地址,API 遵循创建密钥者角色的权限。

套餐

各套餐的 API

REST API 和密钥从 Growth 套餐起提供。“接收 webhook”触发器和请求块在所有套餐的 Workflow 中均可使用。

套餐每月REST APIWorkflow 中的接收 webhook 与 HTTP
Starter Free免费—是
LiteR$ 197,90—是
GrowthR$ 397,90是是
ProR$ 797,90是是
ScaleR$ 1.497,90是是

按月计费,以雷亚尔(BRL)计价;年付只需支付 10 个月,使用 12 个月。 查看所有套餐

从这里继续

常见问题

开发者在集成前常问的问题。

有,Growth 套餐起提供:一套约 128 个接口的 REST API,涵盖线索、联系人、pipeline、标签、产品、报价、WhatsApp 消息、对话、Workflow、营销活动、电子邮件、团队、任务、看板和通知。
使用在“设置 › 开放 API”中创建的密钥,通过 Authorization: Bearer 请求头发送。每个密钥按资源设置权限范围(读取或写入)、1 至 730 天的有效期、可选的 IP 列表和使用记录。密钥只显示一次,可轮换或撤销。
每个密钥每分钟 120 次请求,超出时返回 429 及等待时间。每家企业最多可有 20 个有效密钥。
通过 API 的 POST /v1/leads 接口,或通过 Workflow 的“接收 webhook”触发器,它会为您的系统、n8n、Make 或 Zapier 提供专属地址来发送数据。带 x-api-key 密钥的旧线索 webhook 已不再提供。
出站 webhook 会发送电子邮件营销事件(已打开、点击、回复、退订、退回、投诉和加入列表),使用 HMAC-SHA256 签名并支持重试。若要将 pipeline、报价或订单的变化通知您的系统,请在 Workflow 中使用“触发 webhook”或“HTTP 请求”块。
OpenAPI 3.1 规范和 Postman 集合公开于 api2.astrify.com.br/v1/openapi.json 和 /v1/postman.json,平台还提供包含认证、权限范围、错误和示例的文档页面。
Astrify Flows

AAstrify正在对话带有该系统的您的企业。

在免费套餐中测试带 webhook 的 Workflow,并从 Growth 起解锁 API。