Instalacja - REST API

3 Min. Lesezeit Aktualisiert: 03.09.2026

Przed rozpoczęciem utwórz projekt w DockRay, skopiuj jego token i wygeneruj prywatny klucz API. Token identyfikuje projekt, natomiast klucz uwierzytelnia instalację. Jeżeli projekt nie został jeszcze utworzony, rozpocznij od artykułu Zakładanie konta i pierwszego projektu.

Wymagania

Obsługiwane środowisko: Dowolny klient HTTP.

Integracja korzysta bezpośrednio z REST API DockRay i nie wymaga instalowania dodatkowej paczki.

Przykład 1: zgłoszenie błędu

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"]}
    }
  }'

Przykład 2: rejestracja transakcji HTTP

Transakcje wysyłaj niezależnie od błędów. Jedno żądanie do endpointu transaction reprezentuje jedną obsłużoną operację HTTP i zasila statystyki ruchu oraz kodów odpowiedzi projektu.

bash

# Rejestracja transakcji HTTP
curl -X POST https://dockray.io/api/v1/TWOJ_TOKEN/transaction \
  -H 'Authorization: Bearer TWOJ_KLUCZ_PRYWATNY' \
  -H 'Content-Type: application/json' \
  -d '{
    "transaction": "POST /api/orders",
    "sent_at": "2026-09-01T12:30:00+00:00",
    "environment": "production",
    "tags": {"http.status_code": 201},
    "sdk": {"name": "custom-http-client", "version": "1.0.0"},
    "contexts": {
      "runtime": {"name": "php", "version": "8.4"},
      "os": {"name": "Linux", "version": "6.1"},
      "trace": {
        "data": {
          "url": "https://api.example.com/api/orders",
          "method": "POST"
        }
      }
    },
    "user": {"id": "account-1842"}
  }'

Po zakończeniu instalacji

Zweryfikuj, że token i klucz pochodzą z tego samego projektu, a sekret nie został zapisany w repozytorium ani publicznym kodzie aplikacji. Następnie przejdź do konfiguracji integracji, określ środowisko i wyślij kontrolne zdarzenie przed włączeniem raportowania dla pełnego ruchu produkcyjnego.