API integracyjne

curl https://operatorcompliance.co.uk/api/integration/v1/ping \
  -H "Authorization: Bearer oc_live_YOUR_KEY"

GET /api/integration/v1/ping

Sprawdzenie łączności: potwierdza, że klucz działa i podaje nazwę konta, do którego należy.

Przykład

{"ok": true, "operator": "Alpha Haulage Ltd", "time": "2026-08-29T10:15:00Z"}

GET /api/integration/v1/drivers

GET /api/integration/v1/drivers/{id}

Twoi kierowcy z datami zgodności: status, karta tachografu, pobrania karty, status licencji i termin ważności Driver CPC.

Pola odpowiedzi

id, first_name, last_name, status, employed_from, tacho_card_number, tacho_card_expiry_on, last_card_download_on, next_card_download_due_on, licence_status, licence_valid_to, cpc_expiry_on

GET /api/integration/v1/vehicles

GET /api/integration/v1/vehicles/{id}

Twoje pojazdy i przyczepy: identyfikacja, status, daty MOT i podatku, następna inspekcja bezpieczeństwa, ostatnie pobranie jednostki pojazdu i termin kalibracji tachografu.

Pola odpowiedzi

id, identifier, display_identifier, vin, make, model, fleet_number, type, status, third_party, awaiting_review, mot_status, mot_expiry_on, tax_status, tax_due_on, next_si_due_on, last_vu_download_on, next_vu_download_due_on, tacho_calibration_due_on

GET /api/integration/v1/alerts?status=open|all

Alerty zgodności. Otwórz alerty domyślnie; dodaj ?status=all, aby uwzględnić potwierdzone i rozwiązane.

Pola odpowiedzi

id, type, severity, status, title, message, due_on, created_at, alertable {type, id, label}

GET /api/integration/v1/tacho-reports

GET /api/integration/v1/tacho-reports/{id}

Raporty o naruszeniach tachografu dla każdego kierowcy i okresu. Punkt końcowy szczegółów zawiera każde naruszenie z datą, powagą, zasadą i szczegółami.

Pola odpowiedzi

id, reference, driver {id, name}, period_from, period_to, status, infringement_count, highest_severity, sent_at, signed_at, created_at; detail adds infringements [{date, severity, rule, detail}]

POST /api/integration/v1/ddd-files

Uprawnienie: tacho:write

Prześlij jedno pobranie z karty kierowcy lub z jednostki pojazdowej jako multipart/form-data w polu "file", do 20 MB. Plik przechodzi te same kontrole co przesłanie w aplikacji: zawartość musi być pobraniem z tachografu (w przeciwnym razie 422 i nic nie jest zapisywane), plik już obecny na koncie nie jest zapisywany dwa razy (200 z duplicate true zamiast 201) i trafia do kolejki odczytu, dopasowania do kierowców i pojazdów oraz analizy.

Przykład

curl https://operatorcompliance.co.uk/api/integration/v1/ddd-files \
  -H "Authorization: Bearer oc_live_YOUR_KEY" \
  -F "file=@driver-card.ddd"

GET /api/integration/v1/ddd-files

GET /api/integration/v1/ddd-files/{id}

Uprawnienie: tacho:write / reports:read

Twoje pliki tachografu i stan ich przetwarzania, od najnowszych. Filtruj przez ?kind=driver_card|vehicle_unit, ?status=pending|parsed|failed i ?uploaded_since=YYYY-MM-DD. Po przesłaniu odpytuj punkt końcowy szczegółów, aby zobaczyć, kiedy plik został odczytany.

Pola odpowiedzi

id, kind, parse_status, parse_error, signature_valid, original_name, size, sha256, card_number, vrn, vin, driver {id, name}, vehicle {id, display_identifier}, period_from, period_to, download_time, uploaded_at; an upload adds duplicate

GET /api/integration/v1/tacho-reports/{id}/pdf

Uprawnienie: reports:read

Raport tachografu w PDF: kopia podpisana przez kierowcę, jeśli istnieje, w przeciwnym razie raport w wydanej postaci. Zapisane kopie są najpierw sprawdzane z zapisaną sumą kontrolną; raport bez PDF lub z kopią, która nie przejdzie tej kontroli, zwraca 409.

GET /api/integration/v1/vehicles/{id}/status.pdf

GET /api/integration/v1/drivers/{id}/status.pdf

Uprawnienie: reports:read

Jednostronicowe zestawienie statusu zgodności pojazdu lub kierowcy, takie jak w aplikacji, w języku Twojego konta. Zestawienie kierowcy z API nie zawiera daty urodzenia ani numeru prawa jazdy.