Skopiuj gotowy przykład startowy dla cURL, PHP/Laravel, Node.js, Python lub Go. Używaj kluczy API z panelu, UUID odbiorców z przestrzeni roboczej i trzymaj sekrety poza kodem źródłowym.
Oficjalne klienty
Dwa oficjalnie utrzymywane klienty opakowują to samo API REST: pakiet SDK dla Pythona w PyPI oraz CLI w Go jako pojedynczy plik wykonywalny. Zainstaluj, podaj klucz API i wezwij dyżurnego w dwóch liniach.
Wysyłaj alerty, uruchamiaj szablony i wzywaj dyżurnego z dowolnej aplikacji, zadania lub potoku w Pythonie. Zawiera menedżer kontekstu guard(), który alarmuje, gdy kod zgłosi wyjątek.
Pojedynczy statyczny plik wykonywalny do skryptów powłoki, zadań cron i runnerów CI. Przekieruj nieudaną komendę prosto w alert — bez zależności, bez środowiska uruchomieniowego.
Wybierz swój stack
Ten sam kontrakt JSON wszędzie. Wklej snippet do projektu, podstaw klucz API z panelu — i jesteś online.
Żywe żądanie
Idempotentne endpointy, błędy zgodne z RFC i koperta odpowiedzi, którą zapiszesz wprost do osi czasu incydentu.
Dobre praktyki
Twórz klucze API w panelu, przechowuj je w zmiennych środowiskowych lub menedżerach sekretów i rotuj je, gdy zmienia się dostęp w zespole.
Publiczne przykłady używają recipient_uuid, aby integracje nie zależały od wewnętrznych identyfikatorów bazy danych.
Dodawaj usługę, priorytet, środowisko i link do systemu źródłowego zamiast zbędnych danych wrażliwych.
Ścieżka wdrożenia
Wygeneruj klucz w ustawieniach panelu i zapisz go poza kodem źródłowym przed testowaniem przykładów.
Najpierw użyj odbiorcy sandbox, potwierdź kierowanie kanałów, a dopiero potem podłącz produkcyjną grupę reagowania.
Obsługuj odpowiedzi inne niż 2xx, zapisuj błędy w systemie źródłowym i unikaj duplikowania powiadomień o wysokim priorytecie.
Powierzchnia API
Wysyłaj alerty, zarządzaj odbiorcami, sprawdzaj dostarczenia — z jednej powierzchni REST chronionej kluczem API.
| Metoda | Ścieżka | Cel |
|---|---|---|
| POST | /api/v1/notifications/send | Wyślij powiadomienie do odbiorcy z priorytetem i kanałami. |
| GET | /api/v1/notifications/{id} | Sprawdź status, próby doręczenia oraz status potwierdzenia odbioru. |
| POST | /api/v1/notifications/{id}/potwierdzenie | Programowo potwierdź incydent i zatrzymaj eskalację. |
| GET | /api/v1/recipients | Wylistuj odbiorców z możliwościami kanałów. |
| POST | /api/v1/recipients | Utwórz odbiorcę z telegram_id, telefonem, e-mailem i regułami. |
| PATCH | /api/v1/recipients/{uuid} | Zaktualizuj timeouty eskalacji, kolejność kanałów lub ciche godziny. |
Utwórz obszar roboczy, skopiuj dowolny snippet z tej strony i podmień klucz API. Pierwszy alert jest o jedno żądanie dalej.