REST API

Zdarzenia i transakcje przez REST API

Dostępna bezpłatnie

Zacznij za darmo Dokumentacja

Wymagania Dowolny klient HTTP

Skąd wziąć Dostępne z repozytorium

Cennik Za darmo

Do czego to służy

DockRay REST API pozwala bezpośrednio wysyłać błędy, wyjątki i informacje o transakcjach HTTP do platformy DockRay z dowolnej aplikacji, usługi lub urządzenia.

To rozwiązanie jest przeznaczone przede wszystkim dla technologii, dla których nie ma jeszcze dedykowanej biblioteki, modułu lub wtyczki DockRay.

Raportowanie błędów i wyjątków

Endpoint błędów pozwala przesyłać zdarzenia zawierające informacje potrzebne do diagnostyki problemów w aplikacji.

Zgłoszenie może zawierać między innymi:

typ i treść błędu lub wyjątku,
stos wywołań,
środowisko i wersję aplikacji,
informacje o SDK, runtime i systemie operacyjnym,
kontekst żądania HTTP,
opcjonalne dane użytkownika.

Monitoring transakcji HTTP

Osobny endpoint pozwala raportować obsłużone transakcje HTTP, w tym nazwę transakcji, metodę, adres, czas zdarzenia, kod odpowiedzi oraz informacje o środowisku.

Dane te mogą być wykorzystywane do analizy ruchu, historii żądań oraz rozkładu odpowiedzi HTTP w monitorowanym projekcie.

Dowolna technologia

REST API nie wymaga konkretnego języka programowania ani frameworka. Wystarczy możliwość wykonywania żądań HTTP i wysyłania danych w formacie JSON.

Dzięki temu DockRay można zintegrować z własnymi backendami, mikroserwisami, urządzeniami, skryptami oraz mniej popularnymi technologiami.

Uwierzytelnianie

Każde zgłoszenie jest przypisane do projektu za pomocą jego tokenu, a żądanie jest uwierzytelniane kluczem prywatnym projektu przekazywanym w nagłówku Authorization.

Klucz prywatny powinien być przechowywany wyłącznie po stronie serwera i nie może być umieszczany w publicznym kodzie aplikacji.

Format danych

Endpointy przyjmują dane JSON w formacie zgodnym z modelem zdarzeń DockRay. Payload może być wysłany bezpośrednio lub skompresowany za pomocą gzip.

Instalacja

Do integracji potrzebujesz tokenu projektu oraz klucza prywatnego dostępnych w panelu DockRay.

Token projektu jest częścią adresu endpointu, natomiast klucz prywatny należy przekazać jako Bearer Token w nagłówku Authorization.

Raportowanie błędów

Wyślij żądanie POST na endpoint:

https://dockray.io/api/v1/PROJECT_TOKEN/project

Dodaj wymagane nagłówki:

Authorization: Bearer PROJECT_PRIVATE_KEY
Content-Type: application/json

Raportowanie transakcji HTTP

Transakcje są wysyłane na osobny endpoint:

https://dockray.io/api/v1/PROJECT_TOKEN/transaction

Każda transakcja może zawierać między innymi nazwę trasy, metodę HTTP, kod odpowiedzi, czas zdarzenia, środowisko oraz informacje o runtime i aplikacji.

Klucza prywatnego projektu nie należy umieszczać w kodzie wykonywanym po stronie przeglądarki ani w innych publicznie dostępnych miejscach.

Jak tego użyć

Wyjątki integracja raportuje sama. To jest do zgłoszeń, które chcesz wysłać świadomie.

bash

curl -X POST https://dockray.io/api/v1/PROJECT_TOKEN/project \
  -H 'Authorization: Bearer PROJECT_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "environment": "production",
    "sdk": {
      "name": "custom-http-client",
      "version": "1.0.0"
    },
    "exception": {
      "values": [
        {
          "type": "RuntimeException",
          "value": "Payment gateway returned an unexpected response",
          "stacktrace": {
            "frames": []
          }
        }
      ]
    },
    "request": {
      "url": "https://api.example.com/api/orders",
      "method": "POST"
    }
  }'