開発者向け
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
rotas na API, de leads e mensagens a quadros e propostas
- 16
キーごとに読み取りまたは書き込みのスコープを持つリソース
- 120
各キーにつき1分あたりのリクエスト数
- 20
chaves ativas por empresa, cada uma com o seu registro de uso
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日で、承認IPは最大20件のリストです。
- 03
一度だけ表示
キーは作成時にのみ表示されます。Astrifyには署名のみを保管します。
- 04
ローテーションと無効化
連携を止めずにキーを交換し、すぐに無効化できます。各キーの利用ログも確認できます。
受信Webhook
自社システムが通知し、Workflowが動きます
トリガー「Webhookを受信」は、Workflowに専用のアドレスを割り当てます。自社システム、n8n、Make、ZapierからJSONを送り、メールや電話番号でリードを探して、フローを進めます。リスニングモードでは、Astrifyが最初の送信を表示するので、オンにする前にフィールドをマッピングできます。
- GET、POST、PUT、PATCH、最大256 KB
- 実際の送信を確認する2分間のリスニングモード
- 各トリガーに最新50件のイベントを保存
- 各アドレスにつき1分あたり最大120コール
POST /api/webhooks/workflow/{token}
{
"evento": "pagamento_aprovado",
"cliente": {
"nome": "João Prado",
"email": "joao@pradoalimentos.com.br"
},
"valor": 1290.00
}Astrifyから自社システムへ
知りたい内容に応じた2つの道筋。
Workflow内
HTTPリクエストとWebhookを送信
あらゆるトリガー(リードのステージ移動、提案書承諾、注文配送済みなど)がフローの途中で自社システムを呼び出し、その返答を次のブロックで使えます。
- ヘッダーとJSON本文付きのGET、POST、PUT、PATCH、DELETE
- URLと本文のリードの変数
- If/Elseのために変数に保存される返信
- 返信を待つか、送信して先に進む
送信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で公開しています。プラットフォーム内のドキュメントページで、各ルートの認証、スコープ、エラー、例を確認できます。
プラン
各プランのAPI
REST APIとキーはGrowth以上で利用できます。「Webhookを受信」トリガーとリクエストブロックは、すべてのプランでWorkflow内に含まれます。
| プラン | 月別 | REST API | WorkflowでのWebhookとHTTPの受信 |
|---|---|---|---|
| Starter Free | 無料 | — | はい |
| Lite | R$ 197,90 | — | はい |
| Growth | R$ 397,90 | はい | はい |
| Pro | R$ 797,90 | はい | はい |
| Scale | R$ 1.497,90 | はい | はい |
月額、レアル建て。年払いなら10か月分で12か月使えます。 すべてのプランを見る
こちらからお進みください
よくある質問
連携の前に開発者が聞くこと。

























