REST API
Zdarzenia i transakcje przez REST API
bash
# Zgłoszenie kontrolnego wyjątku
curl -X POST https://dockray.io/api/v1/TWOJ_TOKEN/project \
-H 'Authorization: Bearer TWOJ_KLUCZ_PRYWATNY' \
-H 'Content-Type: application/json' \
-d '{
"environment": "production",
"sdk": {"name": "custom-http-client", "version": "1.0.0"},
"contexts": {
"runtime": {"name": "php", "version": "8.4"},
"os": {"name": "Linux", "version": "6.1"}
},
"exception": {
"values": [{
"type": "RuntimeException",
"value": "DockRay connection test",
"stacktrace": {"frames": []}
}]
},
"request": {
"url": "https://api.example.com/api/orders",
"method": "POST",
"headers": {"content-type": ["application/json"]}
}
}'
REST API jest bezpośrednim interfejsem ingestu DockRay dla aplikacji, usług i urządzeń, dla których nie ma dedykowanej biblioteki lub wtyczki. Endpoint project przyjmuje błędy i wyjątki wraz ze stosem wywołań, środowiskiem, informacjami o SDK i runtime, kontekstem żądania oraz opcjonalnymi danymi użytkownika. Endpoint transaction zapisuje obsłużone żądania HTTP: nazwę transakcji, czas zdarzenia, adres, metodę, kod odpowiedzi, środowisko oraz kontekst techniczny. Dane te pozwalają analizować wielkość ruchu, rozkład odpowiedzi 2xx–5xx i historię żądań dla projektu. Oba endpointy używają formatu zbliżonego do payloadów Sentry, przyjmują JSON w postaci jawnej lub skompresowanej gzipem i korzystają z tego samego mechanizmu uwierzytelniania kluczem prywatnym projektu.
Instalacja - REST API
Wymagania, instalacja i przygotowanie REST API do bezpiecznego raportowania danych produkcyjnych.
Konfiguracja - REST API
Bezpieczna konfiguracja poświadczeń, środowisk i zakresu danych raportowanych przez REST API.
Weryfikacja i typowe problemy - REST API
Kontrolowane potwierdzenie działania REST API oraz diagnostyka najczęstszych problemów z wysyłką.