Astrify FlowsAstrify FlowsMeta Business Partner

Для разработчиков

REST API и webhooks для интеграции с Astrify

Создавайте лиды, отправляйте сообщения, работайте с досками и запускайте 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

Выберите ресурс и посмотрите несколько маршрутов.

Лиды и воронка

Создавайте и обновляйте лиды, объединяйте дубликаты, импортируйте пакетами и записывайте действия и заметки. Воронка и этапы читаются через API.

  • Создавать, просматривать, обновлять, удалять и объединять лиды
  • Пакетный импорт и поиск дубликатов
  • Действия, заметки, участники и позиции сделки
  • Воронки, этапы, источники и причины потери (чтение)

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 собственный адрес. Отправьте JSON из вашей системы, n8n, Make или Zapier, найдите лида по e-mail или телефону и продолжите поток. В режиме прослушивания Astrify показывает первую отправку, чтобы вы сопоставили поля перед включением.

  • GET, POST, PUT и PATCH, до 256 КБ
  • Режим прослушивания на 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 и в теле запроса
  • Ответ сохраняется в переменной для «Если/Иначе»
  • Ждать ответа или отправить и идти дальше

Исходящие webhooks

События e-mail-маркетинга

Добавьте до 10 адресов в разделе «Настройки › Webhooks» и получайте каждое событие с подписью, с повторными попытками и историей доставок.

  • email.opened
  • email.clicked
  • email.replied
  • email.unsubscribed
  • email.bounced
  • email.complaint
  • email.list_joined
  • Подпись HMAC-SHA256 в заголовке X-Astrify-Signature
  • Повторные попытки через 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
Токены каналов и секреты webhooks хранятся в зашифрованном виде, внутренние адреса блокируются в запросах, исходящих с платформы, а API учитывает права роли того, кто создал ключ.

Тарифы

API на каждом тарифе

REST API и ключи доступны начиная с Growth. Триггер «Получить webhook» и блоки запросов есть на всех тарифах, внутри Workflow.

ТарифВ месяцREST APIПолучить webhook и HTTP в Workflow
Starter FreeБесплатно—Да
LiteR$ 197,90—Да
GrowthR$ 397,90ДаДа
ProR$ 797,90ДаДа
ScaleR$ 1.497,90ДаДа

В месяц, в бразильских реалах (BRL); при годовой оплате вы платите за 10 месяцев, а пользуетесь 12. Смотреть все тарифы

Продолжите здесь

Частые вопросы

О чём разработчики спрашивают перед интеграцией.

Да, начиная с Growth: REST API примерно со 128 маршрутами для лидов, контактов, воронок, тегов, товаров, предложений, сообщений WhatsApp, диалогов, Workflow, кампаний, e-mail, команд, задач, досок и уведомлений.
С ключом, созданным в разделе «Настройки › Открытая API» и передаваемым в заголовке Authorization: Bearer. У каждого ключа есть область доступа по ресурсам (чтение или запись), срок действия от 1 до 730 дней, необязательный список IP-адресов и журнал использования. Он показывается только один раз и может быть перевыпущен или отозван.
120 запросов в минуту на каждый ключ; при превышении возвращается ответ 429 с временем ожидания. У каждой компании может быть до 20 активных ключей.
Через маршрут POST /v1/leads API или через триггер «Получить webhook» в Workflow, который даёт собственный адрес, куда ваша система, n8n, Make или Zapier могут отправлять данные. Прежнего webhook лидов с ключом x-api-key больше не существует.
Исходящие webhooks отправляют события e-mail-маркетинга (открыл, кликнул, ответил, отписался, возврат, жалоба и вступление в список), подписанные HMAC-SHA256 и с повторными попытками. Чтобы уведомлять вашу систему об изменениях в воронке, предложениях или заказах, используйте блок «Запустить webhook» или «HTTP-запрос» в Workflow.
Спецификация OpenAPI 3.1 и коллекция Postman открыты по адресам api2.astrify.com.br/v1/openapi.json и /v1/postman.json, а на платформе есть страница документации с аутентификацией, областями доступа, ошибками и примерами.
Astrify Flows

AAstrifyобщаетсяскаксистемаизвашакомпания.

Тестируйте Workflow с webhook на бесплатном тарифе, а API открывайте начиная с Growth.