Webhooks
Cartrack Fleet API udostępnia webhook notifications, aby system mógł otrzymywać aktualizacje w czasie rzeczywistym dla różnych eventów. Webhooks umożliwiają płynną integrację przez automatyczne wysyłanie danych eventów do wskazanego endpointu w momencie wystąpienia zdarzenia.
Supported Webhook Flows
Na ten moment API obsługuje ograniczony zestaw webhook events. Webhooks nie są dostępne dla wszystkich eventów systemowych.
Aktualnie obsługiwany webhook flow:
- Bulk Upload Delivery Jobs: Triggered po zakończeniu procesu tworzenia jobs
Obecnie nie są obsługiwane inne webhook events ani data schemas. Dodatkowe webhook flows mogą zostać wprowadzone w przyszłych wydaniach.
Security and Verification
Każdy webhook request wysyłany z Cartrack zawiera nagłówek HTTP X-Webhook-Signature. Ta signature pozwala zweryfikować, że request rzeczywiście pochodzi z Cartrack i nie został zmodyfikowany.
Signature jest generowana algorytmem HMAC-SHA256 z użyciem następujących elementów:
- Secret Key: Państwa API key.
- Payload: surowy JSON request body (ciąg znaków przed jakimkolwiek dekodowaniem/parsingiem).
Signature Generation Process
- Zakoduj JSON payload (raw content) jako UTF-8 string.
- Oblicz hash payloadu algorytmem HMAC-SHA256, używając API key jako secret.
Przykład (PHP):
$secret = 'your_api_key';
$payload = file_get_contents('php://input');
$signature = hash_hmac('sha256', json_encode($payload), $secret);
if (hash_equals($signature, $_SERVER['X-Webhook-Signature'])) {
// Verified request
} else {
// Invalid signature
}
Zaleca się zawsze weryfikować webhook signature przed przetwarzaniem jakiegokolwiek webhook requestu, aby zapewnić integralność danych i bezpieczeństwo.