Интеграционен API

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

GET /api/integration/v1/ping

Проверка на свързаност: потвърдете, че ключът работи и посочете акаунта, към който принадлежи.

Пример

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

GET /api/integration/v1/drivers

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

Вашите шофьори с техните дати на съответствие: статус, карта на тахографа, изтегляния на карти, статус на лиценз и изтичане на Driver CPC.

Полета на отговора

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}

Вашите превозни средства и ремаркета: идентичност, статус, дати на MOT и данъци, следваща безопасна инспекция, последно изтегляне на единица превозно средство и срок за калибриране на тахографа.

Полета на отговора

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

Предупреждения за съответствие. Отворени предупреждения по подразбиране; добавете ?status=all, за да включите потвърдени и разрешени.

Полета на отговора

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}

Доклади за нарушения на тахографа по шофьор и период. Детайлният край включва всяко нарушение с неговата дата, тежест, правило и детайл.

Полета на отговора

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

Разрешение: tacho:write

Качете едно изтегляне от шофьорска карта или от бордовия уред като multipart/form-data в полето "file", до 20 MB. То минава през същите проверки като качване в приложението: съдържанието трябва да е тахографско изтегляне (иначе 422 и нищо не се записва), файл, който вече е в акаунта ви, не се записва два пъти (200 с duplicate true вместо 201), и се поставя на опашка за прочитане, свързване с вашите шофьори и превозни средства и анализ.

Пример

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}

Разрешение: tacho:write / reports:read

Вашите тахографски файлове и състоянието на обработката им, най-новите първи. Филтрирайте с ?kind=driver_card|vehicle_unit, ?status=pending|parsed|failed и ?uploaded_since=YYYY-MM-DD. След качване проверявайте крайната точка за детайли, за да видите кога файлът е прочетен.

Полета на отговора

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

Разрешение: reports:read

Тахографският доклад в PDF: копието, подписано от шофьора, ако има такова, иначе докладът във вида, в който е издаден. Съхранените копия първо се сверяват със записаната контролна сума; доклад без PDF или с копие, което не мине тази проверка, отговаря с 409.

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

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

Разрешение: reports:read

Едностраничната справка за състоянието на съответствие на превозно средство или шофьор, както в приложението, на езика на вашия акаунт. Справката за шофьор от API не съдържа датата на раждане и номера на шофьорската книжка.