Astrify FlowsAstrify FlowsMeta Business Partner

Für Entwickler

REST-API und Webhooks zur Integration von Astrify

Erstellen Sie Leads, senden Sie Nachrichten, bearbeiten Sie Boards und starten Sie Workflows aus Ihrem System, empfangen Sie Daten per Webhook und rufen Sie mitten im Ablauf jede API auf, mit Schlüsseln pro Scope und OpenAPI-Dokumentation.

  • OpenAPI 3.1 und Postman
  • Schlüssel mit Scope
  • Ab Growth

Terminal

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

    Routen in der API, von Leads und Nachrichten bis zu Boards und Angeboten

  • 16

    Ressourcen mit Lese- oder Schreib-Scope pro Schlüssel

  • 120

    Anfragen pro Minute und Schlüssel

  • 20

    aktive Schlüssel pro Unternehmen, jeder mit eigenem Nutzungsprotokoll

REST-API

Was die API kann

Wählen Sie die Ressource und sehen Sie einige Routen.

Leads und Pipeline

Erstellen und aktualisieren Sie Leads, führen Sie Duplikate zusammen, importieren Sie stapelweise und erfassen Sie Aktivitäten und Notizen. Pipeline und Stages lassen sich über die API auslesen.

  • Leads erstellen, auflisten, aktualisieren, löschen und zusammenführen
  • Stapelimport und Duplikatsuche
  • Aktivitäten, Notizen, Teilnehmer und Positionen des Deals
  • Pipelines, Stages, Herkünfte und Verlustgründe (lesend)

api2.astrify.com.br/v1

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

API-Schlüssel

Jede Integration mit Ihrem eigenen Schlüssel

Die Schlüssel werden unter Einstellungen › Offene API erstellt und im Header Authorization gesendet. Sie handeln im Namen der erstellenden Person und funktionieren nicht mehr, wenn diese deaktiviert wird.

  • 01

    Scope pro Ressource

    Jeder Schlüssel liest oder schreibt nur, was Sie freigeben: Leads, Kontakte, Boards, Nachrichten und mehr.

  • 02

    Gültigkeit und IPs

    Gültigkeit von 1 bis 730 Tagen und eine Liste mit bis zu 20 autorisierten IPs.

  • 03

    Wird einmal angezeigt

    Der Schlüssel wird nur bei der Erstellung angezeigt; Astrify speichert nur eine Signatur davon.

  • 04

    Rotieren und widerrufen

    Tauschen Sie den Schlüssel, ohne die Integration zu stoppen, und widerrufen Sie sofort, mit dem Nutzungsprotokoll jedes Schlüssels.

Eingehender Webhook

Ihr System meldet, der Workflow handelt

Der Trigger „Webhook empfangen“ gibt dem Workflow eine eigene Adresse. Senden Sie das JSON Ihres Systems, von n8n, Make oder Zapier, finden Sie den Lead per E-Mail oder Telefon und folgen Sie dem Ablauf. Im Lauschmodus zeigt Astrify die erste Sendung, damit Sie die Felder vor dem Einschalten zuordnen können.

  • GET, POST, PUT und PATCH, bis zu 256 KB
  • 2-Minuten-Lauschmodus, um die tatsächliche Sendung zu sehen
  • Letzte 50 Ereignisse pro Trigger gespeichert
  • Bis zu 120 Aufrufe pro Minute und Adresse

POST /api/webhooks/workflow/{token}

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

Von Astrify an Ihr System

Zwei Wege, je nachdem, was Sie wissen müssen.

Im Workflow

HTTP-Anfrage und Webhook auslösen

Jeder Trigger (Lead hat die Stage gewechselt, Angebot angenommen, Bestellung geliefert) kann mitten im Ablauf Ihr System aufrufen und die Antwort in den nächsten Blöcken verwenden.

  • GET, POST, PUT, PATCH und DELETE mit Headern und JSON-Body
  • Lead-Variablen in der URL und im Body
  • Antwort in Variable gespeichert für das Wenn/Sonst
  • Auf die Antwort warten oder abschicken und weitermachen

Ausgehende Webhooks

Ereignisse des E-Mail-Marketings

Hinterlegen Sie bis zu 10 Adressen unter Einstellungen › Webhooks und erhalten Sie jedes Ereignis signiert, mit erneuten Zustellversuchen und dem Zustellverlauf.

  • email.opened
  • email.clicked
  • email.replied
  • email.unsubscribed
  • email.bounced
  • email.complaint
  • email.list_joined
  • HMAC-SHA256-Signatur im Header X-Astrify-Signature
  • Erneute Versuche nach 1 Min., 5 Min., 30 Min., 2 Std. und 6 Std.
  • Verlauf mit erneutem Senden und Test-Button

Dokumentation

OpenAPI, Postman und der Leitfaden in der Plattform

Die OpenAPI-3.1-Spezifikation und die Postman-Collection sind offen unter api2.astrify.com.br/v1/openapi.json und /v1/postman.json abrufbar. In der Plattform erklärt die Dokumentationsseite Authentifizierung, Scopes, Fehler und Beispiele zu jeder Route.

Werkzeuge

n8n, Make und Zapier ohne kostenpflichtigen Connector

Nutzen Sie den HTTP-Anfrage-Knoten dieser Werkzeuge mit Ihrem Schlüssel und deren Webhook im Block „Webhook auslösen“.

  • n8n
  • Make
  • Zapier
Tokens der Kanäle und Geheimnisse der Webhooks werden verschlüsselt gespeichert, interne Adressen werden bei Anfragen, die die Plattform verlassen, gesperrt, und die API respektiert die Berechtigungen der Rolle der Person, die den Schlüssel erstellt hat.

Pläne

API in jedem Plan

Die REST-API und die Schlüssel gibt es ab dem Growth. Der Trigger „Webhook empfangen“ und die Anfrage-Blöcke sind in allen Plänen innerhalb der Workflows enthalten.

PlanPro MonatREST-APIWebhook empfangen und HTTP im Workflow
Starter FreeKostenlos—Ja
LiteR$ 197,90—Ja
GrowthR$ 397,90JaJa
ProR$ 797,90JaJa
ScaleR$ 1.497,90JaJa

Pro Monat, in Brazilian reais (BRL); im Jahresplan zahlen Sie 10 Monate und nutzen 12. Alle Pläne ansehen

Hier geht es weiter

Häufige Fragen

Was Entwickler vor der Integration fragen.

Ja, ab Growth: eine REST-API mit rund 128 Routen für Leads, Kontakte, Pipelines, Tags, Produkte, Angebote, WhatsApp-Nachrichten, Gespräche, Workflows, Kampagnen, E-Mail, Teams, Aufgaben, Boards und Benachrichtigungen.
Mit einem Schlüssel, der unter Einstellungen › Offene API erstellt und im Header Authorization: Bearer gesendet wird. Jeder Schlüssel hat einen Scope pro Ressource (Lesen oder Schreiben), eine Gültigkeit von 1 bis 730 Tagen, eine optionale IP-Liste und ein Nutzungsprotokoll. Er wird nur einmal angezeigt und kann rotiert oder widerrufen werden.
120 Anfragen pro Minute und Schlüssel; bei Überschreitung folgt die Antwort 429 mit der Wartezeit. Jedes Unternehmen kann bis zu 20 aktive Schlüssel haben.
Über die Route POST /v1/leads der API oder über den Trigger „Webhook empfangen“ eines Workflows, der Ihrem System, n8n, Make oder Zapier eine eigene Adresse zum Senden der Daten gibt. Den früheren Lead-Webhook mit x-api-key-Schlüssel gibt es nicht mehr.
Die ausgehenden Webhooks senden die Ereignisse des E-Mail-Marketings (geöffnet, geklickt, geantwortet, abgemeldet, zurückgewiesen, Beschwerde und Liste beigetreten), signiert mit HMAC-SHA256 und mit erneuten Zustellversuchen. Um Ihr System über Änderungen in der Pipeline, bei Angeboten oder Bestellungen zu informieren, nutzen Sie in einem Workflow den Block „Webhook auslösen“ oder „HTTP-Anfrage“.
Die OpenAPI-3.1-Spezifikation und die Postman-Collection sind offen unter api2.astrify.com.br/v1/openapi.json und /v1/postman.json abrufbar, und die Plattform hat eine Dokumentationsseite mit Authentifizierung, Scopes, Fehlern und Beispielen.
Astrify Flows

AAstrifyim GesprächmitderSystemderIhreUnternehmen.

Testen Sie die Workflows mit Webhook im kostenlosen Plan und schalten Sie die API ab Growth frei.