Ringostat
Zaloguj

API i webhooki

~5 min · Wyniki połączeń w Twoim CRM i klucz API dla programisty.
Co otrzymasz:
wyniki połączeń automatycznie trafiają do Twojego CRM lub innego systemu, a kampaniami można zarządzać bez interfejsu.
Co przygotować:
URL, który przyjmuje zapytania POST z JSON; do klucza API — uprawnienia administratora projektu oraz programista lub usługa automatyzacji.

1. Skonfiguruj dane do przekazania

W karcie „Ekstrakcja danych” edytora kampanii ustaw pola, które agent wyciąga z rozmowy: budżet, zainteresowanie, termin oddzwonienia itp. To właśnie one przyjdą w webhooku i trafią do CRM. Więcej — w przewodniku „Zaawansowane ustawienia kampanii”.

Ekstrakcja danych
Ekstrakcja danych

2. Podłącz webhook

  1. 1
    Edytor kampanii → karta „Webhook i raporty”.
    Ustawienia webhooka
    Ustawienia webhooka
  2. 2
    Wklej adres w pole „URL Webhooka”.
  3. 3
    W polu „Kiedy wysłać webhook” wybierz, dla jakich połączeń go wysyłać.
  4. 4
    Zapisz kampanię.

Po każdym zakończonym połączeniu na ten adres przychodzi JSON z wynikiem i wyciągniętymi danymi; campaign_id i campaign_name pomogą rozróżnić kampanie. Aby sprawdzić adres, kliknij „Zapisz ustawienia webhooka”, a potem „Wyślij żądanie testowe”: przyjdą na niego syntetyczne dane połączenia.

3. Utwórz klucz API

  1. 1
    Menu po lewej → „Ustawienia” → blok „Ustawienia zaawansowane”. Widzą go tylko administratorzy projektu.
  2. 2
    Kliknij „+ Wygeneruj nowy klucz” i opcjonalnie nadaj mu nazwę.
    Klucze API
    Klucze API
  3. 3
    Skopiuj klucz i przekaż go programiście. Klucz jest wyświetlany tylko raz.

Klucz przekazuje się w nagłówku X-API-Key w zapytaniach do JSON-RPC API platformy. Przykład zapytania jest na tej samej stronie, pod nagłówkiem „Użycie”.

Przykład zapytania API
Przykład zapytania API

Identyfikator projektu

„ID projektu” jest potrzebny w zapytaniach do API. Znajdziesz go w „Ustawienia” → „Ustawienia zaawansowane”, obok jest przycisk kopiowania.

ID projektu
ID projektu
Klucz API działa w imieniu administratora, który go utworzył, w obrębie jednego projektu: można nim zrobić w projekcie wszystko, co może ten administrator. Nie publikuj klucza i twórz osobny dla każdej integracji.

Co dalej