Przejdź do treści
AurionAI

API dla deweloperów: użycie i webhooki

3 min czytaniaAutor: Emmanuel Yazbeck

Strony interfejsu API dla deweloperów pokazują, jak programy korzystają z interfejsu API AurionAI, i umożliwiają wysyłanie zdarzeń AurionAI do własnych systemów za pomocą webhooków.

Dostępność: wszystkie profile. Tylko administratorzy.

Wymagania wstępne

  • Posiadasz rolę Właściciel lub Administrator. Inne role nie mogą otwierać tych stron.
  • W przypadku webhooków: adres HTTPS po Twojej stronie, który akceptuje żądania POST z treścią JSON.

Otwieranie stron interfejsu API dla deweloperów

  1. Na górnym pasku wybierz swoje imię lub zdjęcie, aby otworzyć menu użytkownika.
  2. Wybierz Ustawienia najemcy.
  3. Przejdź do karty API dla deweloperów.
  4. Wybierz Panel wykorzystania API lub Zarządzanie webhookami.

Karta Developer API na stronie Ustawień najemcy.

Przeglądanie użycia API

Strona „API Usage Dashboard" pokazuje ruch interfejsu API AurionAI dla Twojej organizacji.

  1. W sekcji „Window" wybierz „Last 1 day", „Last 7 days" lub „Last 30 days". Domyślnie jest to siedem dni.
  2. Odczytaj cztery wartości łączne: „Total Requests", „Error Rate", „Rate-Limit Hits" i „Webhook Success".
  3. Odczytaj „Top API Paths", aby zobaczyć, które adresy są wywoływane najczęściej, wraz z ich błędami.
  4. Odczytaj „Daily Trend", aby zobaczyć ruch w poszczególnych dniach.
  5. Wybierz „Refresh", aby załadować najnowsze dane.

Rejestrowanie webhooka

  1. Na stronie „Webhook Management" przejdź do sekcji „Create Subscription".
  2. W polu „Target URL" wpisz adres HTTPS swojego odbiornika.
  3. W sekcji „Events" wybierz zdarzenia, które chcesz otrzymywać. Zdarzenia są pogrupowane: konwersacje, wiadomości, kontakty, zgłoszenia, połączenia, baza wiedzy i system.
  4. Wybierz „Create webhook".
  5. W oknie dialogowym zostanie wyświetlony sekret podpisywania. Wybierz „Copy secret" i przechowaj sekret w bezpiecznym miejscu. AurionAI wyświetla go tylko jeden raz.
  6. Wybierz „I have saved my secret".

Nowy webhook pojawi się w sekcji „Subscriptions" ze statusem „Active".

Weryfikacja podpisu webhooka

Każde dostarczenie to żądanie POST z treścią JSON i następującymi nagłówkami:

  • X-Webhook-Event: nazwa zdarzenia, na przykład ticket.created.
  • X-Webhook-Timestamp: czas dostarczenia.
  • X-Webhook-Signature: podpis dostarczenia.

Aby sprawdzić, czy dostarczenie pochodzi od AurionAI:

  1. Pobierz wartość X-Webhook-Timestamp, kropkę i nieprzetworzoną treść żądania, w tej kolejności.
  2. Oblicz HMAC-SHA256 tego tekstu przy użyciu swojego sekretu podpisywania.
  3. Zapisz wynik w formacie szesnastkowym i porównaj go z X-Webhook-Signature. Zaakceptuj dostarczenie tylko wtedy, gdy są one równe.

Testowanie, wstrzymywanie lub usuwanie webhooka

  • Wybierz „Send test", aby wysłać testowe dostarczenie. Wstrzymany webhook nie może otrzymać testu.
  • Wybierz „Pause", aby tymczasowo zatrzymać dostarczenia, i „Resume", aby je wznowić.
  • Wybierz „Delete" i potwierdź, aby usunąć webhook.
  • Strona wyświetla listę ostatnich dostarczeń, wraz z ich statusem, liczbą prób i statusem HTTP Twojego odbiornika.

Wynik

AurionAI wysyła każde wybrane zdarzenie na Twój adres. Dostarczenie jest uznawane za pomyślne, gdy odbiornik odpowie statusem 2xx. W przeciwnym razie AurionAI ponawia próbę później, łącznie do pięciu prób.

W przypadku problemów

  • „Webhook URL is required." Wpisz adres swojego odbiornika.
  • „Select at least one event to subscribe to." Wybierz co najmniej jedno zdarzenie.
  • Komunikat informuje, że adres URL webhooka musi zaczynać się od https. AurionAI wysyła webhooki tylko na adresy HTTPS.
  • Komunikat informuje, że adres jest zablokowany lub nie można go rozpoznać. AurionAI odrzuca adresy prywatne, lokalne i nieznane. Użyj publicznego adresu, który jest rozpoznawany w DNS.
  • Podpis nie pasuje. Użyj nieprzetworzonej treści w postaci otrzymanej, przed jakimkolwiek parsowaniem. Użyj sekretu tego webhooka. Jeśli utraciłeś sekret, usuń webhook i utwórz go ponownie.
  • Dostarczenia kończą się niepowodzeniem. Sprawdź status HTTP na liście dostarczeń. Twój odbiornik musi odpowiadać statusem 2xx.
  • „No webhooks configured" w sekcji „Webhook Success". Twoja organizacja nie ma jeszcze żadnego webhooka dla deweloperów.

Powiązane artykuły

Nadal potrzebujesz pomocy? Wyślij zgłoszenie lub .