Astrify FlowsAstrify FlowsMeta Business Partner

Dla programistów

REST API i webhooki do integracji z Astrify

Twórz leady, wysyłaj wiadomości, zarządzaj tablicami i uruchamiaj Workflow ze swojego systemu, odbieraj dane przez webhook i wywołuj dowolne API w środku przepływu, z kluczami według zakresu i dokumentacją OpenAPI.

  • OpenAPI 3.1 i Postman
  • Klucze z zakresem
  • Od planu 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

    tras w API, od leadów i wiadomości po tablice i oferty

  • 16

    zasobów z zakresem odczytu lub zapisu na klucz

  • 120

    żądań na minutę dla każdego klucza

  • 20

    aktywnych kluczy na firmę, każdy z własnym rejestrem użycia

REST API

Co robi API

Wybierz zasób i zobacz przykładowe trasy.

Leady i pipeline

Twórz i aktualizuj leady, łącz duplikaty, importuj zbiorczo i zapisuj aktywności oraz notatki. Pipeline i etapy są odczytywane przez API.

  • Tworzenie, listowanie, aktualizacja, usuwanie i łączenie leadów
  • Import zbiorczy i wyszukiwanie duplikatów
  • Aktywności, notatki, uczestnicy i pozycje deala
  • Pipeline’y, etapy, źródła i powody utraty (odczyt)

api2.astrify.com.br/v1

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

Klucze API

Każda integracja z własnym kluczem

Klucze tworzy się w Ustawienia › Otwarte API i przesyła w nagłówku Authorization. Działają jako osoba, która je utworzyła, i przestają działać, jeśli to konto zostanie dezaktywowane.

  • 01

    Zakres według zasobu

    Każdy klucz odczytuje lub zapisuje tylko to, co zaznaczysz: leady, kontakty, tablice, wiadomości i resztę.

  • 02

    Ważność i adresy IP

    Ważność od 1 do 730 dni i lista do 20 dozwolonych adresów IP.

  • 03

    Pokazywana jednorazowo

    Klucz jest widoczny tylko przy tworzeniu; Astrify przechowuje wyłącznie jego sygnaturę.

  • 04

    Rotuj i unieważniaj

    Zmieniaj klucz bez zatrzymywania integracji i unieważniaj go natychmiast, z rejestrem użycia każdego z nich.

Webhook przychodzący

Twój system powiadamia, Workflow działa

Trigger „Odbierz webhook” nadaje Workflow własny adres. Wyślij JSON ze swojego systemu, n8n, Make lub Zapiera, znajdź leada po e-mailu lub telefonie i prowadź przepływ dalej. W trybie nasłuchu Astrify pokazuje pierwszą wysyłkę, abyś mógł zmapować pola przed włączeniem.

  • GET, POST, PUT i PATCH, do 256 KB
  • Tryb nasłuchu przez 2 minuty, aby zobaczyć rzeczywistą wysyłkę
  • Ostatnie 50 zdarzeń zapisanych dla każdego triggera
  • Do 120 wywołań na minutę dla każdego adresu

POST /api/webhooks/workflow/{token}

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

Z Astrify do Twojego systemu

Dwie ścieżki, zależnie od tego, co chcesz wiedzieć.

W Workflow

Żądanie HTTP i Wyślij webhook

Każdy trigger (lead zmienił etap, oferta przyjęta, zamówienie dostarczone) może wywołać Twój system w środku przepływu i użyć odpowiedzi w kolejnych blokach.

  • GET, POST, PUT, PATCH i DELETE z nagłówkami i treścią JSON
  • Zmienne leada w URL i w treści
  • Odpowiedź zapisana w zmiennej dla bloku Jeśli/W przeciwnym razie
  • Czekaj na odpowiedź lub wyślij i idź dalej

Webhooki wychodzące

Zdarzenia e-mail marketingu

Dodaj do 10 adresów w Ustawienia › Webhooki i odbieraj każde podpisane zdarzenie, z ponownymi próbami i historią dostarczeń.

  • email.opened
  • email.clicked
  • email.replied
  • email.unsubscribed
  • email.bounced
  • email.complaint
  • email.list_joined
  • Podpis HMAC-SHA256 w nagłówku X-Astrify-Signature
  • Ponowne próby po 1 min, 5 min, 30 min, 2 godz. i 6 godz.
  • Historia z ponownym wysłaniem i przyciskiem testowym

Dokumentacja

OpenAPI, Postman i przewodnik w platformie

Specyfikacja OpenAPI 3.1 i kolekcja Postman są publicznie dostępne pod adresami api2.astrify.com.br/v1/openapi.json i /v1/postman.json. W platformie strona dokumentacji opisuje uwierzytelnianie, zakresy, błędy i przykłady dla każdej trasy.

Narzędzia

n8n, Make i Zapier bez płatnego konektora

Użyj bloku żądania HTTP tych narzędzi ze swoim kluczem, a ich webhooka w bloku „Wyślij webhook”.

  • n8n
  • Make
  • Zapier
Tokeny kanałów i sekrety webhooków są zaszyfrowane, adresy wewnętrzne są blokowane w żądaniach wychodzących z platformy, a API przestrzega uprawnień roli osoby, która utworzyła klucz.

Plany

API w każdym planie

REST API i klucze są dostępne od planu Growth. Trigger „Odbierz webhook” i bloki żądań są we wszystkich planach, w Workflow.

PlanMiesięcznieREST APIOdbieranie webhooków i HTTP w Workflow
Starter FreeZa darmo—Tak
LiteR$ 197,90—Tak
GrowthR$ 397,90TakTak
ProR$ 797,90TakTak
ScaleR$ 1.497,90TakTak

Miesięcznie, w reais brazylijskich (BRL); w planie rocznym płacisz za 10 miesięcy, a korzystasz przez 12. Zobacz wszystkie plany

Czytaj dalej

Często zadawane pytania

O co pytają programiści przed integracją.

Tak, od planu Growth: REST API z około 128 trasami dla leadów, kontaktów, pipeline’ów, tagów, produktów, ofert, wiadomości WhatsApp, rozmów, Workflow, kampanii, e-maili, zespołów, zadań, tablic i powiadomień.
Za pomocą klucza utworzonego w Ustawienia › Otwarte API, przesyłanego w nagłówku Authorization: Bearer. Każdy klucz ma zakres według zasobu (odczyt lub zapis), ważność od 1 do 730 dni, opcjonalną listę adresów IP i rejestr użycia. Jest widoczny tylko raz i można go rotować lub unieważnić.
120 żądań na minutę dla każdego klucza; po przekroczeniu limitu zwracana jest odpowiedź 429 wraz z czasem oczekiwania. Każda firma może mieć do 20 aktywnych kluczy.
Przez trasę POST /v1/leads API lub trigger „Odbierz webhook” w Workflow, który nadaje własny adres, na który Twój system, n8n, Make lub Zapier mogą wysyłać dane. Dawny webhook leadów z kluczem x-api-key już nie istnieje.
Webhooki wychodzące wysyłają zdarzenia e-mail marketingu (otwarcie, kliknięcie, odpowiedź, rezygnacja z subskrypcji, odbicie, skarga i dołączenie do listy), podpisane HMAC-SHA256 i z ponownymi próbami. Aby powiadomić swój system o zmianach w pipeline, ofertach lub zamówieniach, użyj w Workflow bloku „Wyślij webhook” lub „Żądanie HTTP”.
Specyfikacja OpenAPI 3.1 i kolekcja Postman są publicznie dostępne pod adresami api2.astrify.com.br/v1/openapi.json i /v1/postman.json, a platforma ma stronę dokumentacji z uwierzytelnianiem, zakresami, błędami i przykładami.
Astrify Flows

AAstrifyw rozmowieztensystemzTwojafirma.

Testuj Workflow z webhookiem w planie darmowym, a API odblokujesz od planu Growth.