Przejdź do treści

API i webhooki

Wbuduj ćwiczenie rozmów we własny produkt.

Wszystko, co w panelu robisz, żeby udostępniać ćwiczenia, jest też dostępne przez udokumentowane REST API. Twoi użytkownicy zostają na Twojej platformie. Ćwiczenia działają w tle, a wyniki wracają do Ciebie.

Co zrobisz przez API

  • Nadawanie dostępu

    Daj użytkownikowi dostęp do scenariusza albo produktu szkoleniowego, gdy kupi kurs, dołączy do grupy albo dojdzie do określonego kroku wdrożenia.

  • Uruchamianie sesji

    Utwórz sesję dla konkretnego użytkownika i scenariusza, a potem odbierz link albo token do osadzonego odtwarzacza.

  • Pobieranie wyników

    Pobieraj status sesji, oceny i podsumowania raportów, żeby pokazać je we własnym interfejsie albo zapisać obok danych kursu.

Webhooki zamiast odpytywania

Subskrybuj zdarzenia, takie jak rozpoczęcie sesji, zakończenie sesji i report.completed, a także zmiany przydziałów i dostępów. Każda wysyłka jest podpisana i opatrzona znacznikiem czasu, więc możesz sprawdzić, że pochodzi od nas. Przed uruchomieniem produkcyjnym możesz wysłać zdarzenie testowe. Treść zdarzenia zawiera identyfikatory i podsumowania. Ukryta część scenariusza nigdy się w niej nie znajduje.

Stworzone dla programistów

  • Klucze testowe i produkcyjne

    Buduj w trybie testowym, nie dotykając prawdziwych uczestników. Klucze mają ograniczony zakres, więc integracja dostaje tylko te uprawnienia, których potrzebuje.

  • Bezpieczne ponowienia

    Żądania zapisu przyjmują klucz idempotencji, więc ponowienie po błędzie sieci nie utworzy drugiej sesji ani podwójnego dostępu.

  • OpenAPI i SDK dla TypeScriptu

    API jest opisane w dokumencie OpenAPI. Typowane SDK dla TypeScriptu obsługuje najczęstsze scenariusze i jest testowane względem tego samego kontraktu.

Produkt

Połącz ćwiczenia ze swoimi systemami

Przeczytaj dokumentację, utwórz klucz testowy i uruchom pierwszą sesję z kodu.